Python para todos

Pydoc
Este es un nuevo docstring.
Python para todos
La función help, que comentamos brevemente con anterioridad,
utiliza el módulo pydoc para generar la documentación de un objeto a
partir de su docstring y los docstrings de sus miembros. Este módulo,
incluido por defecto con Python desde la versión 2.1, se puede importar
en nuestro código Python y utilizarse programaticamente, o bien se
puede utilizar como una herramienta de línea de comandos que sería el
equivalente a la aplicación Javadoc del mundo Java.
pydoc puede mostrar la información como texto en la consola, tal como
lo utiliza help, pero también puede generar archivos HTML como
javadoc o facilitar la información a través de un pequeño servidor web
incluido con el módulo.
Pydoc es muy sencillo de utilizar. Con
pydoc.py nombre1 [nombre2 ...]
se muestra la documentación del tema, módulo, clase, paquete, función
o palabra clave indicada de forma similar a la función help. Si el
nombre es keywords, topics o modules se listarán las distintas palabras
claves, temas y módulos respectivamente.
Si se pasa el flag -w, el script guardará la documentación en uno o
varios archivos html en lugar de mostrarla por pantalla.
pydoc.py -w nombre1 [nombre2 ...]
El flag -k sirve para buscar una determinada palabra en las sinopsis
de todos los módulos disponibles. La sinopsis es la primera línea de la
cadena de documentación.
pydoc.py -k xml
Con -p podemos iniciar el servidor HTTP en el puerto indicado.
pydoc.py -p puerto
126