pydoc - Documentazione in linea per i moduli Python

Scopo Genera aiuto per i moduli Python e le classi dal codice
Versione Python 2.1 e superiore

Il modulo pydoc importa un modulo Python e ne usa il contenuto per generare un testo di aiuto in fase di esecuzione. L'output include le stringhe di documentazione per qualsiasi oggetto che ne sia dotato, e la descrizione di tutto il contenuto documentabile del modulo.

Aiuto In Testo Semplice

Lanciando:

$ pydoc atexit

Si ottiene un aiuto in testo semplice sulla console, usando il proprio pager (less, more o simili - n.d.t.), se configurato.

Aiuto HTML

Si può anche far sì che pydoc generi un output HTML, sia scrivendo un file statico in una directory locale, che lanciando un web server per scorrere la documentazione in linea.

$ pydoc -w atexit

Crea atexit.html nella directory corrente.

$ pydoc -p 5000

Lancia un web server che ascolta http://localhost:5000/. Il server genera la documentazione mentre si scorrono i moduli disponibili.

Aiuto Interattivo

pydoc aggiunge anche una funzione help() a __builtins__ cosi' che si possa avere accesso alle stesse informazioni dal prompt dell'interprete Python.

$ python
Python 2.6.2 (r262:71600, Apr 16 2009, 09:17:39)
[GCC 4.0.1 (Apple Computer, Inc. build 5250)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> help('atexit')
Help on module atexit:

NAME
    atexit

FILE
    /Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/atexit.py
...

Vedere anche:

pydoc
La documentazione della libreria standard per questo modulo.
L'interfaccia alla riga comandi di motw
Accedere agli articoli di Module Of The Week dalla riga comandi.
Usare PyMOTW con l'interprete interattivo
Accedere agli articoli di Module Of The Week dall'interprete interattivo