Il modulo pydoc importa un modulo Python e usa il suo contenuto per generare testo di aiuto in fase di esecuzione. Il risultato comprende docstring per qualunque oggetto che ne sia provvisto, e sono descritte tutte le classi, metodi e funzioni del modulo.

Aiuto in Formato Testo Semplice

Eseguendo pydoc come programma da riga di comando passando il nome del modulo, produce testo di aiuto per il modulo e il suo contenuto stampato sulla console, utilizzando un programma di paginazione, se configurato. Ad esempio, per vedere testo di aiuto per il modulo atexit, si esegua pydoc atexit.

$ pydoc atexit

Help on built-in module atexit:

NAME
    atexit - allow programmer to define multiple exit functions to be executedupon normal program termination.

DESCRIPTION
    Two public functions, register and unregister, are defined.

FUNCTIONS
    register(...)
        register(func, *args, **kwargs) -> func

        Register a function to be executed upon normal program termination

            func - function to be called at exit
            args - optional arguments to pass to func
            kwargs - optional keyword arguments to pass to func

            func is returned to facilitate usage as a decorator.

    unregister(...)
        unregister(func) -> None

        Unregister an exit function which was previously registered using
        atexit.register

            func - function to be unregistered

FILE
    (built-in)

Aiuto in formato HTML

pydoc può anche generare output in HTML, sia scrivendo verso un file statico in una directory locale oppure facendo partire un server web per scorrere la documentazione in linea.

$ pydoc3 -w atexit

wrote atexit.html

Nella directory corrente viene creato il file atexit.html.

$ pydoc3 -p 5000
Server ready at http://localhost:5000/
Server commands: [b]rowser, [q]uit
server> q
Server stopped

Fa partire un server web in ascolto su http://localhost:5000/. Il server genera la documentazione al volo mentre si naviga. Si usi il comando b per aprire una finestra di browser automaticamente, e q per interrompere il server.

Aiuto Interattivo

pydoc aggiunge anche una funzione help() in __builtins__ in modo che la stessa informazione possa essere fruita dal prompt dell'interprete di Python.

$ python3

Python 3.5.2+ (default, Sep 22 2016, 12:18:14)
[GCC 6.2.0 20160927] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> help('atexit')
Help on built-in module atexit:

NAME
    atexit - allow programmer to define multiple exit functions to be executedupon normal program termination.
...