Observe que a execução do Python com -OO retira as instruções. Se você pretende distribuir seu código para outras pessoas, lembre-se de que elas podem ser executadas dessa maneira. Isso deixará essas pessoas realmente muito infelizes se o seu código se basear em documentos, mas não entender o caso em que eles não existem.
BTW: Essa técnica trabalha com funções internas, bem como módulos e classes (test help () também com objetos - também pode funcionar). Isso faz do seu shell python um shell de ajuda interativo!
Daren Thomas
3
No prompt do ipython, você pode executar my_func ?? e mostraria a doutrina também.
Ronak 29/03/16
1
help (func) fornece uma saída legível, enquanto func .__ doc__ fornece uma saída embutida. Obrigado pela resposta.
imsrgadich
77
Você também pode usar inspect.getdoc. Ele limpa a __doc__normalização de guias em espaços e desloca o corpo do documento para a esquerda para remover os espaços iniciais comuns.
Respostas:
Interativamente, você pode exibi-lo com
Ou a partir do código, você pode recuperá-lo com
fonte
Você também pode usar
inspect.getdoc. Ele limpa a__doc__normalização de guias em espaços e desloca o corpo do documento para a esquerda para remover os espaços iniciais comuns.fonte
No notebook ipython ou jupyter, você pode usar todas as maneiras mencionadas acima, mas eu vou com
ou
para um resumo rápido da assinatura e da documentação do método.
Eu evito usar
(como comentado por @rohan) para docstring e use-o apenas para verificar o código-fonte
fonte