Socorro
Python tiene un sistema de ayuda muy práctico y flexible con una gran cantidad de documentación tanto genérica como específica a la que se puede acceder fácilmente.
Hay documentación tipo manual pero también documentación autogenerada, es decir, que va generando los propios objetos de Python.
La Ayuda en Python viene de la mano de la función HELP ( ) que se utiliza como cualquier otra función, es decir, pasándole el argumento sobre el que necesitamos ayuda. En el siguiente ejemplo vemos la salida por pantalla que proporciona el IDLE a los comandos help (print) y help (input)
Si no se añade ningún argumento, la función devuelve un mensaje de bienvenida explicando el uso de la función e invitándonos a introducir el texto a buscar. Mostrará un prompt con el texto help>, y podremos introducir el texto a buscar.
Si el argumento es una cadena de texto, dicha cadena es buscada como nombre de un módulo, una función, clase, método, palabra clave o tema en la documentación, y se muestra la ayuda disponible.
Si hacemos esto en el IDLE, quedaría tal que así:
Pydoc
Hay otra forma de obtener ayuda en Python, y es por medio del módulo pydoc. Este módulo ya viene preinstalado en todas las intalaciones de Python y está pensado para ser utilizado desde la línea de comandos del sistema y obtener la documentación de cualquier objeto o concepto del lenguaje.
El módulo pydoc se ejecuta desde la línea de comandos usando el flag -m seguido del nombre del módulo. Si abrimos un terminal (CTRL+ALT+T) y tecleamos por ejemplo:
python3 -m python str
nos mostrará la documentación de esta función, que cómo no cabrá en el terminal, podremos desplazarnos usando las flechas o las teclas RePág y AvPág del keypad numérico. Tecla Q para salir de la documentación y regresar al terminal.
En mi sistema KDE Neon, al ser derivado de Debian y Ubuntu, puedo usar pydoc como un programa independiente, sin tener que poner el python3 delante, simplemente tecleo pydoc3 str y obtengo:
Pydoc puede ejecutarse con algunos flasgs muy binteresantes, como por ejemplo:
- pydoc3 -k termino_a_buscar
- pydoc3 -p 5000
En el caso 1, pydoc buscará termino_a_buscar en todos los resúmenes de los módulos disponibles.
El caso 2 es el modo DIOS de la ayuda
