¡Hey, amigos! En este artículo, nos centraremos en una importante función explicativa en Python – la función Python help().
Necesidad del método help()
Mientras codificamos en un lenguaje de programación particular, es muy esencial para nosotros conocer la documentación básica del lenguaje enmarcado. Es entonces cuando la función help() entra en escena.
Esta función nos proporciona la documentación básica del lenguaje Python. Nos da la información sobre los métodos y las instancias asociadas a un método o clase en particular.
El método help() trabaja con palabras clave, Clases, funciones y módulos para ayudarnos a obtener las terminologías básicas, las instancias y el trabajo asociado a ellas respectivamente.
Por lo general, el help() method se utiliza junto con el intérprete de Python para acceder a los detalles subyacentes sobre los objetos de Python que se le pasan como parámetro.
Funcionamiento del método help() de Python
Como se mencionó anteriormente, el método help() proporciona información sobre los objetos de Python que se le pasan.
Si se menciona el help() function sin ningún parámetro, inicia la consola del intérprete en la que podemos mencionar cualquier módulo, objeto, clase, etc para disponer de la documentación sobre el mismo.
Ejemplo :
help()
Salida:
Función help() de Python con una clase
La función help puede ser alimentada con parámetros personalizados o predefinidos para trabajar. Podemos crear una clase personalizada y pasarla a la función help() para examinar la documentación proporcionada por la función.
Ejemplo:
class Info: lang = "Python" name = "JournalDev"obj = Info()help(Info)
Hemos creado una clase definida por el usuario y la hemos pasado a la función help(). La función help() ha devuelto la documentación necesaria de la clase ‘Info’.
Salida:
Help on class Info in module __main__:class Info(builtins.object) | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | lang = 'Python' | | name = 'JournalDev'
Función help() de Python con una función
La función help() nos ayuda a acceder a la sintaxis, la lista de parámetros y la descripción sobre cualquier función que se le pase utilizando el siguiente comando.
Sintaxis:
help('function-name')
Ejemplo 1:
help('getattr')
Salida:
Ejemplo 2:
help('map')
Salida:
Función help() de Python con un módulo
Podemos obtener información sobre el módulo utilizando la función help(). Cuando se pasa un módulo a la función help(), ésta proporciona la documentación en cuanto a la versión, la ubicación del archivo, el contenido del módulo y los datos asociados al mismo.
Sintaxis:
help('module-name')
Ejemplo:
help('seaborn')
Salida:
La función help() con una palabra clave
Al pasar una palabra clave de Python como parámetro a la función help(), la función devuelve la documentación en cuanto a la clase de la palabra clave, los métodos asociados a ella, etc.
Sintaxis:
help('keyword-name')
Ejemplo 1:
help(True)
Salida:
Ejemplo 2:
help(int)
Salida:
Conclusión
Con esto hemos llegado al final de este tema. Hemos entendido la necesidad y el funcionamiento de la función help(). Espero que este concepto sea claro para todos los lectores.