28.06.2017 Views

Python para todos

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

<strong>Python</strong> <strong>para</strong> <strong>todos</strong><br />

Este es un nuevo docstring.<br />

Pydoc<br />

La función help, que comentamos brevemente con anterioridad,<br />

utiliza el módulo pydoc <strong>para</strong> generar la documentación de un objeto a<br />

partir de su docstring y los docstrings de sus miembros. Este módulo,<br />

incluido por defecto con <strong>Python</strong> desde la versión 2.1, se puede importar<br />

en nuestro código <strong>Python</strong> y utilizarse programaticamente, o bien se<br />

puede utilizar como una herramienta de línea de comandos que sería el<br />

equivalente a la aplicación Javadoc del mundo Java.<br />

pydoc puede mostrar la información como texto en la consola, tal como<br />

lo utiliza help, pero también puede generar archivos HTML como<br />

javadoc o facilitar la información a través de un pequeño servidor web<br />

incluido con el módulo.<br />

Pydoc es muy sencillo de utilizar. Con<br />

pydoc.py nombre1 [nombre2 ...]<br />

se muestra la documentación del tema, módulo, clase, paquete, función<br />

o palabra clave indicada de forma similar a la función help. Si el<br />

nombre es keywords, topics o modules se listarán las distintas palabras<br />

claves, temas y módulos respectivamente.<br />

Si se pasa el flag -w, el script guardará la documentación en uno o<br />

varios archivos html en lugar de mostrarla por pantalla.<br />

pydoc.py -w nombre1 [nombre2 ...]<br />

El flag -k sirve <strong>para</strong> buscar una determinada palabra en las sinopsis<br />

de <strong>todos</strong> los módulos disponibles. La sinopsis es la primera línea de la<br />

cadena de documentación.<br />

pydoc.py -k xml<br />

Con -p podemos iniciar el servidor HTTP en el puerto indicado.<br />

pydoc.py -p puerto<br />

126

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!