Как распечатать документацию модуля в Python

Я знаю, что этот вопрос очень прост, я знаю, что его, должно быть, много раз спрашивали, и я делал свой поиск как на SO, так и на Google, но я не мог найти ответ, возможно, из-за отсутствия у меня способности помещать то, что Я ищу подходящее предложение.

Я хочу, чтобы иметь возможность читать документы того, что я импортирую.

Например, если я импортирую x с помощью "import x", я хочу запустить эту команду и распечатать ее документы на Python или ipython.

PS. Я не имею в виду dir(), я имею в виду функцию, которая будет фактически печатать документы для меня, чтобы видеть и читать, какие функции и т.д. Этот модуль x имеет.

Ответы

Ответ 1

Вы можете использовать атрибут .__doc__ модуля функции:

In [14]: import itertools

In [15]: print itertools.__doc__
Functional tools for creating and using iterators..........

In [18]: print itertools.permutations.__doc__
permutations(iterable[, r]) --> permutations object

Return successive r-length permutations of elements in the iterable.

permutations(range(3), 2) --> (0,1), (0,2), (1,0), (1,2), (2,0), (2,1)

Оба help() ans __doc__ отлично работают как на встроенных, так и на наших собственных модулях:

file: foo.py

def myfunc():
    """
    this is some info on myfunc

    """
    foo=2
    bar=3


In [4]: help(so27.myfunc)


In [5]: import foo

In [6]: print foo.myfunc.__doc__

     this is some info on func

In [7]: help(foo.myfunc)


Help on function myfunc in module foo:

myfunc()
    this is some info on func

Ответ 2

pydoc foo.bar из командной строки или help(foo.bar) или help('foo.bar') из Python.

Ответ 3

Вы можете использовать функцию help() для отображения документации. или вы можете выбрать method.__doc__ дескриптор.

Например: help(input) предоставит документацию по методу input().