 |
 |
 |
La libreria di riferimento di Python |  |
 |
 |
|
|
|
La libreria di riferimento di Python | |
|
|
Il modulo pydoc genera automaticamente la documentazione dai moduli Python. La documentazione può presentarsi come testo su una console, può essere servita ad un browser Web o salvata in un file HTML.
La funzione built-in help() invoca il sistema di aiuto in linea nell'interprete, che usa pydoc per generare la sua documentazione come testo sulla console. La stessa documentazione può anche essere vista fuori dall'interprete di Python eseguendo pydoc come un script al prompt dei comandi del sistema operativo. Per esempio, eseguendo
pydoc sys
sulla shell si vedrà la documentazione riguardante il modulo sys in uno stile simile a quello delle pagine dei manuali visibili su Unix con il comando man. L'argomento di pydoc può essere il nome di una funzione, modulo o pacchetto, od un riferimento ad una classe, metodo, o una funzione entro un modulo, o un modulo in un package. Se l'argomento passato a pydoc somiglia ad un percorso (ovverosia contiene un separatore di percorso per il vostro sistema operativo come ad esempio lo slash in Unix), e si riferisce ad un file esistente in codice Python, la documentazione viene prodotta per quel file.
Specificando l'opzione -w prima dell'argomento si otterrà una documentazione HTML che verra scritta al di fuori dal file, nella directory corrente, invece che mostrare il testo sulla console.
Specificando -k prima dell'argomento la ricerca avverrà solo nelle righe introduttive di tutti i moduli disponibili che contengono le chiavi date, in modo simile a quanto presente nel comando man di Unix. La riga introduttiva di un modulo è la prima riga della sua stringa di documentazione.
Si può anche usare pydoc per far partire un server HTTP su
un macchina locale che renderà disponibile documentazione ai browser
che visiteranno le pagine web. pydoc -p 1234
farà partire un server HTTP sulla porta 1234 permettendo di
visitare la documentazione all'indirizzo
http://localhost:1234/, inserendo la stringa nel vostro browser
Web preferito. pydoc -g inizializzerà il
server ed in aggiunta aprirà una minima interfaccia grafica basata su
Tkinter per aiutarvi a cercare le pagina nella
documentazione.
Quando pydoc genera documentazione utilizza l'ambiente ed il percorso correnti per individuare i moduli. In questo modo, invocando pydoc spam verrà documentata esattamente la stessa versione del modulo che avreste ottenuto lanciando l'interprete Python e digitando "import spam".
Per quanto riguarda la documentazione dei moduli, si assume che risiedano in http://www.python.org/doc/current/lib/. Per questo può essere di primaria importanza impostare le variabili d'ambiente PYTHONDOCS ad un URL o ad una directory locale differenti che contengono le pagine del Library Reference Manual.
|
|
|
La libreria di riferimento di Python | |
|
|