python comando para imprimir docstrings no arquivo

Question

Qual é a linha de comando para imprimir as docstrings em um determinado arquivo Python?

Eu pensei que havia algo como:

$ python --showhelp foo.py

Name                 Help
--------------------------------------------------
bar                  This is the docstring for bar().
baz                  This is the docstring for baz().

Obrigado.

    

Answer 1

Encontrado: pydoc

Para este arquivo de exemplo:

# foo.py

def bar():
  """this is the docstring for bar()"""
  print 'hello'


def baz():
  """this is the docstring for baz()"""
  print 'world'

você pode imprimir os docstrings para stdout com este comando:

$ pydoc ./foo.py
Help on module foo:

NAME
    foo

FILE
    /path/to/foo.py

FUNCTIONS
    bar()
        this is the docstring for bar()

    baz()
        this is the docstring for baz()

Você também pode gerar um arquivo de ajuda em HTML:

$ pydoc -w ./foo.py
wrote foo.html

que se parece com isso: