So drucken Sie Moduldokumentation in Python

Question

Ich weiß, dass diese Frage sehr einfach ist, ich weiß, dass es viele Male gefragt worden ist und ich meine Suche sowohl auf SO als auch Google gemacht habe, aber ich konnte die Antwort wahrscheinlich nicht finden mein Mangel an Fähigkeit, das, was ich suche, in einen richtigen Satz zu bringen.

Ich möchte in der Lage sein, die Dokumente zu lesen, was ich importiere.

Wenn ich zum Beispiel x durch "import x" importiere, möchte ich diesen Befehl ausführen und seine Dokumente in Python oder ipython drucken lassen.

Was ist diese Befehlsfunktion?

Vielen Dank.

PS. Ich meine nicht dir(), ich meine die Funktion, die die Dokumente tatsächlich ausdrucken wird, damit ich sehen und lesen kann, welche Funktionalitäten usw. dieses Modul x hat.

Answer 1

Sie können das .__doc__ Attribut des Moduls der Funktion:

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) 

Beide help() ans __doc__ funktionieren sowohl eingebaute als auch unsere eigenen Module:

Datei: 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 von der Befehlszeile oder help(foo.bar) oder help('foo.bar') von Python.