Hey, pessoal! Neste artigo, vamos focar numa importante função explicativa em Python – Python help() function.
Necessidade do método help()
Embora codificar numa determinada linguagem de programação, é muito essencial para nós conhecer a documentação básica da linguagem emoldurada. Isto é quando a função help() entra em cena.
Esta função nos fornece a documentação básica da linguagem Python. Ela nos dá as informações sobre os métodos e instâncias associadas a um método ou classe particular.
O método help() funciona com palavras-chave, Classes, funções e módulos para nos ajudar a obter as terminologias básicas, instâncias e trabalhar anexado com ele respectivamente.
Usualmente o método help() method é usado junto com o interpretador Python para obter acesso aos detalhes subjacentes sobre objetos Python passados a ele como parâmetro.
Trabalho do método help() Python
Como mencionado acima, o método help() fornece informações sobre os objetos Python passados a ele.
Se o help() function for mencionado sem qualquer parâmetro, inicia a consola de interpretação onde podemos mencionar qualquer módulo, objectos, classe, etc para dispor da documentação sobre o mesmo.
Exemplo :
help()
Output:
função de ajuda() Python com uma Classe
A função de ajuda pode ser alimentada com parâmetros personalizados ou pré-definidos para trabalhar. Podemos criar uma classe personalizada e passá-la para a função help() para examinar a documentação fornecida pela função.
Exemplo:
class Info: lang = "Python" name = "JournalDev"obj = Info()help(Info)
Criámos uma classe definida pelo utilizador e passámo-la para a função help(). A função help() retornou a documentação necessária da classe ‘Info’.
Output:
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'
Função help() Python com uma função
A função help() nos ajuda a acessar a sintaxe, a lista de parâmetros e a descrição sobre qualquer função passada a ela usando o comando abaixo.
Sintaxe:
help('function-name')
Exemplo 1:
help('getattr')
Eliminar:
Exemplo 2:
help('map')
Eliminar:
Função help() Python com um módulo
Podemos obter informações sobre o módulo usando a função help(). Quando um módulo é passado para a função help(), ele fornece a documentação em termos da versão, localização do arquivo, conteúdo do módulo, e dados associados a ele.
Sintax:
help('module-name')
Exemplo:
help('seaborn')
Output:
A função help() com uma palavra-chave
Ao passar uma palavra-chave Python como parâmetro para a função help(), a função retorna a documentação em termos da classe da palavra-chave, os métodos associados a ela, etc.
Sintax:
help('keyword-name')
Exemplo 1:
help(True)
Output:
Exemplo 2:
help(int)
Output:
Conclusão
Por isso chegamos ao fim deste tópico. Compreendemos a necessidade e o funcionamento da função help(). Eu espero que este conceito seja claro para todos os leitores.