Come stampare la documentazione del modulo in Python

Question

So che questa domanda è molto semplice, so che deve essere stata posta molte volte e ho effettuato la ricerca sia su SO che su Google ma non ho trovato la risposta, probabilmente a causa di la mia mancanza di capacità di mettere in una frase corretta quello che cerco.

Voglio essere in grado di leggere i documenti di ciò che importa.

Ad esempio, se impongo x con "import x", voglio eseguire questo comando e avere i suoi documenti stampati in Python o ipython.

Che cos'è questa funzione di comando?

Grazie.

PS. Non intendo dir(), intendo la funzione che stamperà i documenti per me per vedere e leggere quali funzionalità ecc. Questo modulo x ha.

Answer 1

È possibile utilizzare l'attributo .__doc__ del modulo della funzione:

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) 

entrambi help() ans __doc__ lavorare bene su entrambi integrato così come i nostri propri moduli:

di 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 

Answer 2

pydoc foo.bar dalla riga di comando o help(foo.bar) o help('foo.bar') da Python.