Consultar la documentación con pydoc3

En primer lugar, la herramienta más habitual que permite buscar en la documentación de los módulos se llama pydoc3. El uso de pydoc3 interviene cuando queremos mostrar la documentación de un módulo, clase o palabra clave. Por ejemplo, la documentación de todas las palabras clave revisadas en los capítulos anteriores (with, def, lambda, etc.) se puede consultar con pydoc3. Un aspecto importante a observar antes de ir más lejos: la mayoría de la documentación instalada con el sistema por defecto de Python está escrita en inglés.

Esta herramienta se utiliza exclusivamente en línea de comandos. Abra una consola pulsando Menú - Accesorios - LXTerminal, como se explicó en el capítulo Entorno de programación. A continuación, escriba el siguiente comando:


pi@raspberrypi:~ $ pydoc3
 

Debería mostrar el siguiente resultado:

images/7.png

Esto solo es la ayuda de pydoc3. Sin embargo, preste atención porque cada versión de Python instalada en el sistema se entrega con su propia versión de pydoc. Como se explica en el capítulo Entorno de programación, diferentes versiones del compilador Python deben convivir en la Raspberry Pi. Ocurre igual para pydoc, que se entrega en sus versiones 2.7 y 3.4. Por defecto, el binario pydoc apunta a /usr/bin/pydoc2.7. Por lo tanto, piense siempre en utilizar pydoc3 para leer la documentación de la versión 3 de Python.

De este modo, pydoc3 permite...

Si desea saber más, le proponemos el siguiente libro:
couv_RITRASPYT.png
60-signet.svg
Versión impresa
20-ecran_lettre.svg
Versión online
41-logo_abonnement.svg
En ilimitado con la suscripción ENI
130-boutique.svg
En la tienda oficial de ENI
Anterior
Introducción
Siguiente
Documentar y probar su código al mismo tiempo, con el módulo doctest