CKTIS / Python
help()
Apresenta a documentação de um objeto através da ajuda fornecida pelo módulo site.
Versão: Python 3.14; repository image, production runtime not attested
Sintaxe
help()
help(request)Apresenta a documentação de um objeto através da ajuda fornecida pelo módulo site.
Para meters inclui a cadeia de documentação da função. Capturar a saída e verificar uma frase dá True sem depender da paginação. A chamada devolve None.
Sem argumento inicia a ajuda interativa.
from contextlib import redirect_stdout
from io import StringIO
def meters():
"""Convert distance into metres."""
out = StringIO()
with redirect_stdout(out):
assert help(request=meters) is None
assert meters.__doc__ in out.getvalue()
Exemplos
from contextlib import redirect_stdout
from io import StringIO
def meters():
"""Convert distance into metres."""
with redirect_stdout(StringIO()) as buffer:
help(meters)
print("Convert distance into metres." in buffer.getvalue())
Resultado
True
Sem argumento inicia a ajuda interativa.