Para obtener ayuda en Python, debes conocer herramientas básicas que te permitan resolver dudas de forma eficiente. La documentación oficial y el sistema interactivo de ayuda de Python son excelentes opciones.
En esta guía rápida, tienes un resumen de las opciones más utilizadas para obtener ayuda directamente desde una sesión interactiva de Python o desde la terminal de tu sistema operativo.
1. La documentación oficial de Python
La documentación oficial de Python es la fuente primaria de información actualizada sobre el lenguaje y sus últimas actualizaciones. La estructura de la documentación incluye secciones como las siguientes:
- ¿Qué hay de nuevo en Python?: Novedades en cada versión
- Tutorial: Guía escrita por Guido Van Rossum
- Library reference: Referencia de módulos y paquetes
- Language reference: Sintaxis del lenguaje
- Cómos (HOWTOs) de Python: Preguntas frecuentes
Notarás que la documentación aún tiene fragmentos que no han sido traducidos completamente al Español. Te gustaría contribuir en la traducción? Consulta la guía de contribución.
2. El sistema interactivo de ayuda: help()
La función integrada help() proporciona información detallada sobre objetos, funciones y módulos:
>>> help(list)
En este ejemplo, usas la clase list como argumento para help() y obtienes la página de ayuda relacionada.
Para consultar la ayuda de un objeto que no está en tu espacio de nombres actual, puedes emplear una cadena con el nombre del objeto. Por ejemplo, para consultar la ayuda sobre el módulo sys de la librería estándar no tienes que importar el módulo primero, solo usa una cadena con su nombre:
>>> help("sys")
Cuando el objeto que le pasas como argumento a help() tiene una página de ayuda disponible, esa página te aparecerá en pantalla.
Si llamas a la función help() sin argumentos, entonces entrarás al sistema interactivo de ayuda:
>>> help()
Dentro del sistema interactivo de ayuda, puedes explorar temas fundamentales escribiendo algunas palabras clave como por ejemplo:
keywords: Lista de palabras clave de Pythonmodules: Lista de módulos disponiblestopics: Temas de documentaciónsymbols: Símbolos disponibles
Para salir de cada página de ayuda, presiona la tecla Q. Para salir del sistema de ayuda y regresar a tu sesión interactiva de Python, escribe q o quit y presiona Enter.
3. La herramienta pydoc
La herramienta de línea de comandos pydoc permite obtener información sobre módulos y funciones desde la terminal sin necesidad de estar en una sesión interactiva de Python. Esta herramienta funciona de manera muy parecida a la función help().
Por ejemplo, el siguiente comando muestra información sobre la clase str:
$ pydoc str
Puedes generar documentación en HTML con el comando siguiente:
$ pydoc -w sys
Guarda la documentación del módulo sys en un archivo HTML llamado sys.html en tu directorio de trabajo.
Para explorar la documentación en un navegador web:
$ pydoc -b
Con este comando, puedes iniciar un servidor web con la documentación de Python.
Resumiendo
Contar con buenas fuentes de información es clave para aprender Python eficazmente. La documentación oficial, la función integrada help() y la herramienta pydoc te permitirán encontrar respuestas rápidamente mientras trabajas en tu código.
Explora estas opciones y podrás resolver rápidamente tus dudas sobre Python.