documentazione Python

Tra i linguaggi che uso più frequentemente c’è il python.
La documentazione sulla libreria standard è ottima e si trova sul sito ufficiale.
Per le librerie opzionali o di terze parti invece spesso occorre leggere la documentazione usando l’interprete python stesso su linea di comando, lanciandolo e, al classico prompt python , digitando help().
Ci si ritroverà in un’ ambiente interattivo dove a fronte della digitazione del nome della classe ne verrà mostrata la documentazione che si trova nel corrispondente codice sorgente.
Es se digitate

>>> help()
Welcome to Python 2.6!  This is the online help utility.
....
help> libxml2.xmlCore

verrà mostrata la documentazione di xmlCore e così via.
(per questo è importante, quando si scrivono classi/moduli python, attenersi a queste linee guida per la documentazione e a queste altre per il codice… )
Tuttavia talvolta è più comodo avere la documentazione come pagina web consultabile da un browser.
Per questo ci viene in aiuto Epydoc, un tool per generare la documentazione dei moduli python, basati sulle docstring.
Su distribuzioni Debian si installa con il comando

sudo apt-get install python-epydoc

Esistono pacchetti per altre distribuzioni, al limite si può installare partendo dal codice sorgente.
Ammettiamo di voler generare la documentazione di libxml2.

epydoc --html  -n libxml2 -o libxml2 libxml2

Verranno generati dei files con la documentazione della libreria python libxml2 nella directory libxml2.
Il risultato, che ho copiato su questo server, è questo, (qui per l’indice)…

Altro esempio… il modulo mysql

epydoc --html  -n MySQLdb -o MySQLdb MySQLdb

che ho copiato qui (qui per l’indice ).

Rimando alla documentazione ufficiale per l’help sulle varie opzioni/comandi.

C’è anche un altro modo per accedere alla documentazione python molto semplice, usando pydoc.
pydoc è un eseguibile che consente di accedere direttamente alla documentazione da linea di comando, oppure, se lanciato con l’opzione -p, da browser, in quanto comprende un server http che viene lanciato sulla macchina locale.

Risorse e riferimenti

• Epydoc
• Pydoc

• No Related Post