Beachten Sie, dass beim Ausführen von Python mit -OO Docstrings entfernt werden. Wenn Sie beabsichtigen, Ihren Code an andere zu verteilen, denken Sie daran, dass diese ihn möglicherweise auf diese Weise ausführen. Es wird diese Leute wirklich sehr, sehr unglücklich machen, wenn Ihr Code auf Docstrings basiert, aber den Fall nicht erfasst, in dem sie nicht existieren.
Übrigens: Diese Technik funktioniert sowohl mit integrierten Funktionen als auch mit Modulen und Klassen (Testhilfe () auch für Objekte - funktioniert möglicherweise auch). Dies macht Ihre Python-Shell zu einer interaktiven Hilfeshell!
Daren Thomas
3
An der ipython-Eingabeaufforderung können Sie my_func ausführen? und es würde auch den Docstring zeigen.
Ronak
1
help (func) gibt eine lesbare Ausgabe aus, während func .__ doc__ eine Inline-Ausgabe liefert. Danke für die Antwort.
Imsrgadich
77
Sie können auch verwenden inspect.getdoc. Es bereinigt das, __doc__indem Tabulatoren auf Leerzeichen normalisiert und der Dokumentkörper nach links verschoben werden, um gemeinsame führende Leerzeichen zu entfernen.
Antworten:
Interaktiv können Sie es mit anzeigen
Oder aus dem Code, mit dem Sie ihn abrufen können
quelle
Sie können auch verwenden
inspect.getdoc. Es bereinigt das,__doc__indem Tabulatoren auf Leerzeichen normalisiert und der Dokumentkörper nach links verschoben werden, um gemeinsame führende Leerzeichen zu entfernen.quelle
Auf ipython oder jupyter notebook können Sie alle oben genannten Möglichkeiten verwenden, aber ich gehe mit
oder
für eine schnelle Zusammenfassung der Methodensignatur und der Dokumentzeichenfolge.
Ich vermeide es zu benutzen
(wie von @rohan kommentiert) für docstring und verwenden Sie es nur, um den Quellcode zu überprüfen
quelle