Kategorier
Python

Pydoc

PyDoc genererer hjælp til informationer af modulerne i Python.

Kort og godt indhenter PyDoc informationer til dig om alle de moduler, som du har kørerende på din computer.

Nu kan vi selvfølgelig altid importere et modul ind i editoren ved at skrive help(modulnavn). Men det kommer på den anden side til at fylde temmelig godt op. Og det kan i nogle henseender være lidt uoverskueligt i en editor.

Pydoc bruger jeg derimod i min terminal til at dokumentere modulerne. Derfor undgår jeg at importere modulerne ind i min editor og skrive, dels kan jeg kører pydoc lokalt på computeren imens jeg arbejder i et Python miljø. Super smart.

Lad mig eksemplificere det i nedenstående.

Allerførst går jeg ind i min terminal og henter pydoc ved at skrive: python -m pydoc

Som det ses i ovenstående screenshot indeholder pydoc modulet en række forskellige muligheder. En hurtig og nem mulighed er, hvis du allerede kender det modul, som du ønsker at gå på opdagelse i. Du skriver kort og godt bare python -m pydoc <modul>. Fx python -m pydoc turtle

Efter vi har hentet turtle-modulet ved at skrive python -m pydoc turtle får vi nu al den docstring, som beskriver turtle-modulet.

En anden smart ting med Pydoc er, at du kan benytte din lokale server til at sætte Pydoc op, og få en enorm overskuelig menu over dine moduler. Det gør du nemmest ved at skrive:

python -m pydoc -b

Den lokale server starter og vi får nu nedenstående menu.

Søg og gå på opdagelse. Her finder du alle dine moduler i de respektive mapper, som de ligger i.

I ovenstående finder jeg informationer om sys-modulet.

I PyDoc kan du også skrive dit eget HTML-dokument til modulerne.

Inde i terminalen skriver du: python -m pydoc -w <modul>. Prøv fx at skrive python -m pydoc -w cmath. Her er hvad du får.

Husk at lav en folder, du vil have din fil liggende i og åben PyDoc derfra. I ovenstående screenshot har jeg kaldt min folder ex1. Når jeg har skrevet filen, får jeg denne HTML.