114
Ich habe die folgende Funktion:gibt es den docstring aus einer Funktion
def my_func():
"""My docstring is both funny and informative"""
pass
Wie kann ich Zugriff auf die docstring bekommen?
A
Antwort
157
interaktiv, können Sie es aus dem Code angezeigt werden mit
help(my_func)
Oder Sie können es abrufen mit
my_func.__doc__
+1
BTW: Diese Technik funktioniert mit eingebauten Funktionen sowie Module und Klassen (Test Hilfe() mit Objekten auch - könnte auch funktionieren). Dies macht Ihre Python-Shell zu einer interaktiven Hilfe-Shell! –
+2
Auf der ipython-Eingabeaufforderung können Sie my_func ?? und es würde auch den Docstring zeigen. – ronak
+3
Python ist so verdammt cool – ThorSummoner
56
Sie auch inspect.getdoc verwenden können. Es bereinigt das __doc__, indem es Tabulatoren in Leerzeichen normalisiert und den Dokumententext verschiebt, um häufig vorkommende Leerzeichen zu entfernen.
+1
Nun, genau das habe ich selbst versucht. Dank dafür. – ereOn
1
Auf ipython oder jupyter Notebook können Sie alle oben genannten Möglichkeiten nutzen, aber ich gehe mit
my_func?
oder
?my_func
für kurze Zusammenfassung der beiden Methodensignatur und docstring.
Ich vermeide
my_func??
mit (wie durch @rohan kommentiert) für docstring und verwenden Sie nur den Quellcode
Verwandte Themen
- 1. Haskell: Gibt es eine Möglichkeit, den Rückgabetyp einer Funktion aus der Funktion abzuleiten?
- 2. Gibt es einen Grund, Code vor den Docstring in Python zu setzen?
- 3. Gibt es ein Sphinx reST Python Docstring-Feld für Erträge?
- 4. Gibt es einen Standard (wie den Docstring von phpdoc oder python) zum Kommentieren von C# -Code?
- 5. Wie programmiere ich den Docstring programmatisch?
- 6. Parsing Funktion docstring in sphinx.autodoc Format
- 7. Metaprogrammierung in DocString mit @eval
- 8. Gibt es eine C++ Funktion, um den Computer auszuschalten?
- 9. Gibt es einen Konsens, was in den Klassen und __init__ Docstrings dokumentiert werden sollte?
- 10. Automatisierte docstring und Kommentare Rechtschreibprüfung
- 11. In Python gibt es eine Funktion für den "in" -Operator
- 12. Gibt es eine Möglichkeit, den Rückgabewert einer Funktion zu ändern, ohne den Körper der Funktion zu ändern?
- 13. Wie gibt man nullptr aus einer Lambda-Funktion zurück?
- 14. Gibt es eine MAKELONGLONG-Funktion?
- 15. show * only * docstring in der Sphinx-Dokumentation
- 16. TSQL Wie gibt man PRINT in einer benutzerdefinierten Funktion aus?
- 17. Erstellen einer Funktion aus Zeichenfolge, die den übergeordneten Bereich erbt
- 18. Gibt es eine Möglichkeit, die Argumente einer Funktion von einer anderen JavaScript-Funktion zu ändern?
- 19. Python Hol Docstring, ohne in den Interaktiven Modus zu wechseln
- 20. Haben replace Sphinx Text Docstring
- 21. Gibt es eine Radix-Funktion in Ruby?
- 22. VB.NET - Gibt eine 2D-Anordnung von Zahlen aus einer Funktion
- 23. Funktionsname + Tab nicht docstring zurückkehrt in IPython
- 24. Gibt es ein Programm (oder ein sed-Skript), das eine Funktion aus einer C-Datei entfernt?
- 25. gibt es den spliterator aus einem sortierten Strom eine Ausnahme
- 26. Gibt es eine Möglichkeit, aus einer Funktion auszubrechen, die void zurückgibt?
- 27. Gibt es eine integrierte JavaScript-Funktion zum Verarbeiten einer Zeitzeichenfolge?
- 28. Gibt es in Python ein Analog einer MATLAB-Funktion `mscohere`?
- 29. JavaScript gibt den Wert von einer inneren Funktion zurück
- 30. Übergeben von Parametern an den Klassenkonstruktor aus einer Wrapper-Funktion
Hinweis zu überprüfen, ob mit -OO Python läuft Docstrings abstreift. Wenn Sie beabsichtigen, Ihren Code an andere zu verteilen, denken Sie daran, dass sie den Code auf diese Weise ausführen können. Es wird diese Leute wirklich wirklich unglücklich machen, wenn Ihr Code auf Docstrings angewiesen ist, aber nicht den Fall erfasst, in dem sie nicht existieren. – DNS
Prost für das, das ist ziemlich nützliche Informationen. – Teifion
@DNS Danke, ich habe mich gefragt, warum alle meine Docstrings keine waren. – Timo