команда python для печати строк документов в файле

Question

Что такое командная строка для печати строк документации в данном файле Python?

Я думал, что было что-то вроде:

$ python --showhelp foo.py

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

Благодарю.

Answer 1

Нашел это: pydoc

Для этого файла примера:

# foo.py

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


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

вы можете напечатать строки документации в стандартный вывод с помощью этой команды:

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

Вы также можете создать файл справки HTML:

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

который выглядит так: