Función help() de Python

La función help() de Python se utiliza para obtener la documentación de un módulo, clase, función, variables, etc. especificados. Este método se utiliza generalmente con la consola del intérprete de Python para obtener detalles sobre los objetos de Python.

Función help() de Python

La sintaxis de la función help() de Python es:

help([object])

Si no se proporciona ningún argumento, el sistema interactivo de ayuda comienza en la consola del intérprete. En la consola de ayuda de Python, podemos especificar los nombres de módulo, clase, función para obtener su documentación de ayuda. Algunos de ellos son:

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

Si desea salir de la consola de ayuda, escriba quit. También podemos obtener la documentación de ayuda directamente desde la consola de Python pasando un parámetro a la función help().

>>> help('collections')

>>> help(print)

>>> help(globals)

Veamos cuál es la salida de la función help() para la función globals().

>>> help('builtins.globals')

Help on built-in function globals in builtins:

builtins.globals = globals()
    Return the dictionary containing the current scope's global variables.
    
    NOTE: Updates to this dictionary *will* affect name lookups in the current global scope and vice-versa.

Definir help() para clases y funciones personalizadas

Podemos definir la salida de la función help() para nuestras clases y funciones personalizadas mediante la definición de una docstring (cadena de documentación). Por defecto, la primera cadena de comentario en el cuerpo de un método se utiliza como su docstring. Está rodeada por tres comillas dobles. Supongamos que tenemos un archivo python python_help_examples.py con el siguiente código.

def add(x, y):
    """
    This function adds the given integer arguments
    :param x: integer
    :param y: integer
    :return: integer
    """
    return x + y


class Employee:
    """
    Employee class, mapped to "employee" table in Database
    """
    id = 0
    name = ''

    def __init__(self, i, n):
        """
        Employee object constructor
        :param i: integer, must be positive
        :param n: string
        """
        self.id = i
        self.name = n

Observa que hemos definido docstrings para la función, la clase y sus métodos. Deberías seguir algún formato para la documentación, he generado parte de ellas automáticamente utilizando el IDE PyCharm. La guía de docstrings de NumPy es un buen lugar para obtener alguna idea sobre la forma adecuada de documentación de ayuda. Veamos cómo obtener esta docstring como documentación de ayuda en la consola de python. En primer lugar, tendremos que ejecutar este script en la consola para cargar nuestra función y definición de clase. Podemos hacer esto usando el comando exec().

>>> exec(open("python_help_examples.py").read())

Podemos verificar que las funciones y definiciones de clase están presentes usando el comando globals().

>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, '__warningregistry__': {'version': 0}, 'add': <function add at 0x100dda1e0>, 'Employee': <class '__main__.Employee'>}

Observa que ‘Employee’ y ‘add’ están presentes en el diccionario de ámbito global. Ahora podemos obtener la documentación de ayuda usando la función help(). Veamos algunos ejemplos.

>>> help('python_help_examples')

>>> help('python_help_examples.add')

Help on function add in python_help_examples:

python_help_examples.add = add(x, y)
    This function adds the given integer arguments
    :param x: integer
    :param y: integer
    :return: integer
(END)

>>> help('python_help_examples.Employee')

>>> help('python_help_examples.Employee.__init__')


Help on function __init__ in python_help_examples.Employee:

python_help_examples.Employee.__init__ = __init__(self, i, n)
    Employee object constructor
    :param i: integer, must be positive
    :param n: string
(END)

Resumen

La función help() de Python es muy útil para obtener detalles sobre módulos, clases y funciones. Siempre es una buena práctica definir un docstring para las clases y funciones personalizadas para explicar su uso.

Puedes consultar el script completo de Python y más ejemplos en nuestro Repositorio de GitHub.

Referencia: Documentación Oficial