Función de ayuda en Python

La función de ayuda de Python se utiliza para mostrar la documentación de módulos, funciones, clases, palabras clave, etc. 

La función de ayuda tiene la siguiente sintaxis:

help([object])

Argumentos de la función Python help()

object: Call help of the given object.

Si la función de ayuda se pasa sin un argumento, la utilidad de ayuda interactiva se inicia en la consola.

Ayuda de Python() Ejemplo

Revisemos la documentación de la función de impresión en la consola de python. 

help(print)

Producción:

Help on built-in function print in module builtins:

print(...)
    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)

    Prints the values to a stream, or to sys.stdout by default.
    Optional keyword arguments:
    file:  a file-like object (stream); defaults to the current sys.stdout.
    sep:   string inserted between values, default a space.
    end:   string appended after the last value, default a newline.
    flush: whether to forcibly flush the stream.

La salida de la función de ayuda también se puede definir para funciones y clases definidas por el usuario. El docstring (string de documentación) se utiliza para la documentación. Está anidado dentro de comillas triples y es la primera declaración dentro de una clase, función o módulo.

Definamos una clase con funciones: 

class Helper:
    def __init__(self):
        '''The helper class is initialized'''
 
    def print_help(self):
        '''Returns the help description'''
        print('helper description')
 
 
help(Helper)
help(Helper.print_help)

Al ejecutar el programa anterior, obtenemos el resultado de la primera función de ayuda como se muestra a continuación: 
 

Help on class Helper in module __main__:

class Helper(builtins.object)
 |  Methods defined here:
 |  
 |  __init__(self)
 |      The helper class is initialized
 |  
 |  print_help(self)
 |      Returns the help description
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

Help on function print_help in module __main__:

print_help(self)
    Returns the help description

String de documentación de la función Python help()

Las strings de documentación se declaran usando ”’comillas simples triples”’ o “””comillas dobles triples””” justo debajo de la declaración de clase, método o función. Todas las funciones deben tener una string de documentación.

Acceder a Docstrings: Se puede acceder a las docstrings usando el método __doc__ del objeto o usando la función de ayuda.

def my_function():
    '''Demonstrates triple double quotes
    docstrings and does nothing really.'''
 
    return None
 
print("Using __doc__:")
print(my_function.__doc__)
 
print("Using help:")
help(my_function)

Producción:

Using __doc__:
Demonstrates triple double quotes
    docstrings and does nothing really.
Using help:
Help on function my_function in module __main__:

my_function()
    Demonstrates triple double quotes
    docstrings and does nothing really.