Função help() do Python

A função help() do Python é usada para obter a documentação do módulo especificado, classe, função, variáveis, etc. Esse método é geralmente usado com o console do interpretador do python para obter detalhes sobre objetos do python.

A função help() do Python

A sintaxe da função help() do Python é:

help([object])

Se nenhum argumento é fornecido, o sistema de ajuda interativa é iniciado no console do interpretador. No console de ajuda do python, podemos especificar módulo, classe, função nomes para obter sua documentação de ajuda. Alguns deles são:

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

Se você quiser sair do console de ajuda, digite quit. Também podemos obter a documentação de ajuda diretamente do console do python passando um parâmetro para a função help().

>>> help('collections')

>>> help(print)

>>> help(globals)

Vamos ver qual é o resultado da função help() para a função 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.

Definindo help() para classes e funções personalizadas

Podemos definir a saída da função help() para nossas classes e funções personalizadas definindo uma docstring (cadeia de documentação). Por padrão, a primeira cadeia de comentário no corpo de um método é usada como sua docstring. Ela é cercada por três aspas duplas. Digamos que temos um arquivo python python_help_examples.py com o seguinte 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

Observe que definimos uma docstring para a função, classe e seus métodos. Você deve seguir algum formato para documentação, eu gerei parte delas automaticamente usando o PyCharm IDE. Guia de docstring do NumPy é um bom lugar para ter alguma ideia sobre a maneira adequada de documentação de ajuda. Vamos ver como obter essa docstring como documentação de ajuda no console python. Primeiro, precisamos executar este script no console para carregar nossa definição de função e classe. Podemos fazer isso usando o comando exec().

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

Podemos verificar que as funções e definições de classe estão presentes usando o 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'>}

Observe que ‘Employee’ e ‘add’ estão presentes no dicionário de escopo global. Agora podemos obter a documentação de ajuda usando a função help(). Vamos ver alguns exemplos.

>>> 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)

Resumo

A função help() do Python é muito útil para obter detalhes sobre módulos, classes e funções. É sempre uma prática recomendada definir docstrings para as classes e funções personalizadas para explicar seu uso.

Você pode verificar o script completo em Python e mais exemplos em Python em nosso Repositório GitHub.

Referência: Documentação Oficial