How to print module documentation in Python

You can use the .__doc__ attribute of the module of function:

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)

Both of help() and __doc__ work fine on both inbuilt and on our own modules:

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

You can use help() function to display the documentation. or you can choose method.__doc__ descriptor.

Eg: help(input) will give the documentation on input() method.


pydoc foo.bar from the command line or help(foo.bar) or help('foo.bar') from Python.