pydoc — Ayuda en línea para módulos¶
Propósito: | Genera ayuda para módulos y clases de Python a partir del código. |
---|
El módulo pydoc
importa un módulo de Python y usa los contenidos para
generar texto de ayuda en tiempo de ejecución. La salida incluye cadenas de
documentos para cualquier objeto que las tenga, y se describen todas las
clases, métodos y funciones del módulo.
Ayuda de texto plano¶
Ejecutar pydoc
como un programa de línea de comandos y pasar el nombre de
un módulo produce texto de ayuda para el módulo y su contenido en la consola,
utilizando un programa de visualización si está configurado. Por ejemplo, para
ver el texto de ayuda del módulo atexit
, ejecuta pydoc atexit
.
$ pydoc atexit
Help on built-in module atexit:
NAME
atexit - allow programmer to define multiple exit functions
to be executed upon 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)
Ayuda HTML¶
pydoc
también generará salida HTML, ya sea escribiendo un archivo estático
en un directorio local o iniciando un servidor web para navegar por la
documentación en línea.
$ pydoc -w atexit
Crea atexit.html
en el directorio actual.
$ pydoc -p 5000
Server ready at http://localhost:5000/
Server commands: [b]rowser, [q]uit
server> q
Server stopped
Inicia un servidor web escuchando en http://localhost:5000/
. El servidor
genera documentación sobre la marcha mientras navega. Usa el comando b
para abrir una ventana del navegador automáticamente y q
para detener el
servidor.
Ayuda interactiva¶
pydoc
también agrega una función help()
a __builtins__
para que se
pueda acceder a la misma información desde el intérprete de Python.
$ python
Python 3.5.2 (v3.5.2:4def2a2901a5, Jun 26 2016, 10:47:25)
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
Type "help", "copyright", "credits" or "license" for more
information.
>>> help('atexit')
Help on module atexit:
NAME
atexit - allow programmer to define multiple exit functions
to be executed upon normal program termination.
...
Ver también
- Documentación de la biblioteca estándar para pydoc
inspect
– El móduloinspect
se puede usar para recuperar las cadenas de documentos de un objeto mediante programación.