Pythonhelp() | audacia

Python tiene una serie de funciones integradas que son increíblemente útiles y poderosas. Casi todos los que han escrito incluso una línea de Python están familiarizados con el print() función, pero en esta publicación, discutiremos uno que es un poco menos familiar, pero aún poderoso: el integrado de Python help() función. Según la documentación oficial, help() es una función que invoca el sistema de ayuda incorporado y, lo que es más importante, está destinada a interactivo gastado. Esto significa que es probable que nunca lo vea invocado en los scripts, ¡pero puede ser muy útil cuando usamos nuestro ciclo de lectura-evaluación-impresión (REPL) para experimentar! Para aquellos nuevos en Python, o aquellos que han olvidado qué es un REPL, es el «shell» que obtenemos cuando escribimos el python Comando en nuestra terminal.

¿Por qué usaría help()?

En un mundo con poderosos motores de búsqueda, foros técnicos como StackOverflow y Reddit, y acceso aparentemente ubicuo a información y opiniones, nuestro viejo amigo help() puede parecer un poco anticuado. ¿Por qué usaríamos una aplicación de línea de comandos para obtener información cuando Internet está al alcance de la mano?

1. podemos confiar help() – toda la información devuelta por el help() La función proviene de las cadenas de documentación proporcionadas por los desarrolladores. Si bien los resultados de búsqueda a menudo se completan con los foros antes mencionados, esa información no siempre es correcta e, incluso si lo es, es posible que no sea aplicable a nuestra versión. Por el contrario, help() nos muestra las cadenas de documentación de nuestra versión, por lo que podemos confiar en lo que dice.
2. help() siempre está ahí para ti – entre teléfonos inteligentes, 5G e Internet de banda ancha, ¡es fácil olvidar que a veces Internet no está ahí para ti! Cuando hay problemas importantes de DNS, problemas de conectividad u otros problemas que dificultan el uso de Internet como recurso, aún podemos recurrir a help() para sacar la documentación. Además, cuando se trabaja en instalaciones seguras o con sistemas industriales, la conectividad a Internet suele ser difícil de conseguir. En estos casos, help() puede ser su único recurso.

Cómo utilizar help()

Una de las formas más fáciles de usar help() es simplemente ejecutar el comando sin argumentos. Esto generará el sistema de ayuda interactivo, donde puede ingresar una variedad de términos para obtener información sobre módulos, palabras clave, símbolos y otros temas.

Usando help() with módulos devolverá una lista de todos los módulos disponibles y puede permitirnos obtener ayuda con objetos, funciones y otros temas en el módulo. Si bien muchos módulos tienen excelentes cadenas de documentación, algunos carecen un poco; en estos casos, help() puede ser un nombre un poco inapropiado y es posible que tengamos que confiar en las búsquedas en Internet o, en el peor de los casos, en el ensayo y error.

Para aquellos de nosotros que estamos interesados ​​en contribuir a proyectos de código abierto o crear nuestros propios módulos, help() es un incentivo importante para escribir docstrings como se describe en PEP 257, una propuesta de mejora de Python (PEP) anterior que documenta la semántica y las convenciones de las docstrings de Python.

Sin embargo, especialmente para construcciones y estructuras de datos comunes de Python como list(), dict()y tuple(), help() proporciona no solo información sobre métodos y subclases para ese objeto, sino que también proporciona valiosos ejemplos de cómo crear nuevas instancias de esa clase de manera eficiente como en el integrado dict() clase que se muestra arriba.

Qué help() no lo haré

Mientras que Python está integrado help() puede ser una herramienta poderosa para el uso interactivo en el REPL, está limitada de varias maneras.

• En primer lugar, solo se puede usar de forma interactiva, por lo que si está trabajando en un entorno de desarrollo integrado (IDE) o en un editor de texto, puede ser de uso limitado para usted.
• En segundo lugar, no le dirá nada que no esté contenido en docstrings, por lo que para módulos mal documentados o programas independientes, es posible que no contenga lo que está buscando.

Además, si bien puede parecer intuitivo agregar ayuda para su propio programa de línea de comandos usando el help() función, querrá recurrir a un módulo como argparse para brindar ayuda a sus usuarios.

Conclusión

Mientras que Python está integrado help() La función no tiene un uso extensivo por parte de los programadores que tienen acceso confiable a Internet y puede parecer un poco anacrónico, sigue siendo una herramienta que vale la pena tener en su bolsillo trasero proverbial. Saber cómo y dónde usar esta función puede ser inmensamente beneficioso tanto para los recién llegados como para los veteranos.

Si ha dominado sus funciones integradas y está buscando algo más centrado en los datos, considere Programación para ciencia de datos con Python Nanodegree de Udacity.