Tag: docstring
Ein docstring ist ein string, der Auftritt, als die erste Anweisung in einem Modul, einer Funktion, Klasse oder Methode definiert, und wird verwendet, um document-Objekt, in dem es Auftritt.
Wie express mehrere Arten für einen einzelnen parameter oder Rückgabewert in docstrings, die verarbeitet werden, Sphinx?
1 Antworten
Manchmal eine Funktion in Python kann akzeptieren ein argument ein flexibler Typ. Oder es kann einen Wert zurückgeben, der eine flexible Art. Jetzt kann ich mich nicht erinnern, ein gutes Beispiel für eine solche Funktion jetzt, also
Wie Sie verschiedene Rückgabetypen in python docstring
1 Antworten
Ich bin derzeit beim schreiben von Dokumentation für meine python-Paket mit der Sphinx und dem autodoc-plugin. Für den Rückgabewert einer Funktion kann ich z.B. schreiben :returns: int: count die sphinx erzählt, dass es einen Rückgabewert vom Typ
Multi-line-Beschreibung der parameter Beschreibung in python docstring
5 Antworten
So, reStructuredText ist der empfohlene Weg für Python-code Dokumentation, wenn Sie hart genug versuchen, Sie können finden Sie in der sphinx-Dokumentation wie zu normalisieren Ihre Funktion Unterschrift-Dokumentation. Alle angegebenen Beispiele sind single-line, aber was ist, wenn ein
Formatierung python docstrings für dicts
1 Antworten
Was ist die empfohlene Methode für das hinzufügen eines docstring für einen dictionary-parameter? Ich kann sehen, mehrere line-docstring Beispiele hier. Brauche ich zur Dokumentation der Eingabe-Argumente einer Funktion den docstring. Wenn es eine einfache variable, die ich
Gibt es echte alternativen zu reStructuredText für Python-Dokumentation?
7 Antworten
Ich ab, ein open-source-Python-Projekt in Kürze, und ich bin versucht, im Voraus zu entscheiden, wie das schreiben meiner docstrings. Die offensichtliche Antwort wäre, mit reStructuredText und Sphinx mit autodoc, weil ich wirklich mag die Idee einfach richtig
Dokumentation `Tupel` return-Typ in eine Funktion docstring für PyCharm Typbestimmung
1 Antworten
Wie kann ich dokumentieren, dass eine Funktion einen tuple in der Weise, dass PyCharm wird in der Lage sein, es zu benutzen für die Typbestimmung? Erfundenes Beispiel: def fetch_abbrev_customer_info(customer_id): """Pulls abbreviated customer data from the database for
Hinzufügen von docstrings zu namedtuples?
10 Antworten
Ist es möglich, eine Dokumentation, ein string zu einem namedtuple in einer einfachen Art und Weise? Versuchte ich from collections import namedtuple Point = namedtuple("Point", ["x", "y"]) """ A point in 2D space """ # Yet another
Python Docstring: raise vs. wirft
1 Antworten
Ich die PyCharm IDE hilft mit crafting PEP0257-konform docstrings. Es enthält zwei Attribute, die ich nicht ganz verstehen, die Unterscheidung zu/zwischen: :raise Exception: exception explanation here :raises Exception: exception explanation here Wenn würde ich raise als gegen
Wie sollten unit-tests dokumentiert werden?
5 Antworten
Ich versuche zu verbessern die Anzahl und Qualität der tests in meine Python Projekte. Eine der Schwierigkeiten ich gestoßen bin, als die Anzahl der tests erhöhen ist, zu wissen, was jeder test bedeutet und wie es '
Docstrings - one-line-vs multiple-line
2 Antworten
Ich bin hinzufügen einige (epydoc) Dokumentation zu einem Paket, das ich geschrieben habe, und ich komme auf eine Vielzahl von Fällen, in denen ich wiederhole mich eine Vielzahl von Zeiten. def script_running(self, script): """Return if script is
Python-decorator Umgang mit docstrings
3 Antworten
Ich habe ein problem mit docstrings mit Dekorateure. Gegeben das folgende Beispiel: def decorator(f): def _decorator(): print 'decorator active' f() return _decorator @decorator def foo(): '''the magic foo function''' print 'this is function foo' help(foo) Nun die
Funktion name + tab nicht wieder docstring in IPython
2 Antworten
In IPython, ich bin gewohnt, zu schreiben Funktion( und dann schlagen Sie eine Registerkarte, und erhalten Sie den Inhalt der docstring und eine Liste der benannten Argumente. Dies jedoch aufgehört zu arbeiten seit der Installation von IPython
Was ist die standard-Python docstring-format?
8 Antworten
Ich habe gesehen, ein paar verschiedene Arten von schreiben von docstrings in Python, gibt es eine offizielle oder "vereinbarten" Stil? python.org/dev/peps/pep-0008 es gibt ein ganzen Abschnitt widmet sich der Dokumentation strings Ich denke, dass diese Frage nicht
python - "Hilfe" - Funktion: drucken docstrings
4 Antworten
Gibt es eine option zum drucken der Ausgabe der Hilfe('myfun'). Das Verhalten bin ich zu sehen, dass Ausgabe auf std.aus und das Skript wartet auf Eingaben des Benutzers (also Typ 'q', um fortzufahren). Muss es eine Einstellung
Benutzerdefinierte PyCharm docstring stubs (d.h. für google-docstring oder numpydoc Formate)
3 Antworten
Stellt PyCharm 2.7 (oder PyCharm 3) haben die Unterstützung für benutzerdefinierte docstring und doctest-stubs? Wenn ja, wie geht man über das schreiben von diesem speziellen Typ des benutzerdefinierten Erweiterung? Mein Aktuelles Projekt standardisiert auf das Google-Python Style
"Erwartet einen eingerückten block" - Fehler?
2 Antworten
Ich kann nicht verstehen, warum python gibt einen "Erwarteten Einzug block" - Fehler? """ This module prints all the items within a list""" def print_lol(the_list): """ The following for loop iterates over every item in the list
Wie schreibe ich sinnvolle Docstrings?
7 Antworten
Was ist Eurer Meinung nach eine sinnvolle docstring? Was erwarten Sie dort beschrieben? Betrachten Sie beispielsweise dieses Python-Klasse __init__: def __init__(self, name, value, displayName=None, matchingRule="strict"): """ name - field name value - field value displayName - nice
Wie dokumentiert man Python-Code mit doxygen?
5 Antworten
Ich wie doxygen zur Erstellung der Dokumentation von C oder PHP-code. Ich habe eine bevorstehende Python-Projekt und ich denke, ich erinnere mich, dass Python nicht /* .. */ Kommentare, und hat auch seine eigene selbst-Dokumentation Anlage, die
Verwenden von javadoc für Python-Dokumentation
4 Antworten
Ich bin derzeit Anfang mit Python und ich habe den starken PHP-hintergrund und in PHP habe ich nahm die Gewohnheit, mit javadoc als Dokumentation Vorlage. Ich Frage mich, ob javadoc hat seinen Platz als docstring Dokumentation in
Wie dokumentiert man Klassenattribute in Python?
3 Antworten
Schreibe ich eine leichte Klasse, deren Attribute sollen öffentlich zugänglich sein, und nur manchmal überschrieben, in bestimmten Instanzen. Es gibt keine Bestimmung in der Python-Sprache für die Erstellung von docstrings für die Attribute der Klasse, oder irgendeine
Wie setze ich eine Variable in den Python-Docstring?
4 Antworten
So, ich bin versuchen, um eine "dynamische" docstring, die so etwas wie dieses: ANIMAL_TYPES = ["mammals", "reptiles", "other"] def func(animalType): """ This is a sample function. @param animalType: "It takes one of these animal types %s" %
Wie finde ich Anmerkungen in einem PHP5-Objekt?
2 Antworten
Ich würde gerne in der Lage sein zu implementieren, individuelle Anmerkungen in mein PHP5-Objekte, und ich würde gerne erfahren, wie der ganze Prozess funktioniert durch den Aufbau meines eigenen parser. Beginnen, obwohl, ich muss wissen, wie man
Mehrzeilige Clojure-Docstrings
3 Antworten
Habe ich bemerkt, dass Clojure multiline docstrings zu sein scheinen, manuell formatiert in den meisten Fällen, auch diejenigen, die in clojure.core. Beispiel aus https://github.com/clojure/clojure/blob/master/src/clj/clojure/core.clj : (defn flatten "Takes any nested combination of sequential things (lists, vectors, etc.)
Wie programmiere ich den Docstring programmatisch?
6 Antworten
Habe ich eine wrapper-Funktion, die zurückgibt, eine Funktion. Gibt es eine Möglichkeit, programmgesteuert den docstring der Funktion zurückgegeben? Wenn ich schreiben könnte, um __doc__ ich würde Folgendes tun: def wrapper(a): def add_something(b): return a + b add_something.__doc__
Wie Docstring von Python-Funktion aus der Funktion selbst drucken?
8 Antworten
Will ich drucken der docstring einer python-Funktion innerhalb der Funktion selbst. für zB. def my_function(self): """Doc string for my function.""" # print the Docstring here. Im moment mache ich das direkt nach my_function definiert wurde. print my_function.__doc__
print (__ doc__) in Python 3-Skript
2 Antworten
Ich kann nicht herausfinden, was macht die print(__doc__) zu Beginn ein Skript, wie in diesem Beispiel Scikit. Ich gesucht habe Python docstrings in google, und es scheint __doc__ ist nützlich, einige Dokumentation, die in, sagen wir, Funktionen.
Was ist das Standard-Python-Docstring-Format?
8 Antworten
Ich habe gesehen, ein paar verschiedene Arten von schreiben von docstrings in Python, gibt es eine offizielle oder "vereinbarten" Stil? InformationsquelleAutor der Frage Noah McIlraith | 2010-10-10
Wie referenziere ich einen dokumentierten Python-Funktionsparameter mit Sphinx Markup?
3 Antworten
Möchte ich verweisen auf ein zuvor dokumentiert-Funktion parameter an anderer Stelle in Python docstring. Betrachten Sie das folgende (zugegebenermaßen völlig künstlichen) Beispiel: def foo(bar): """Perform foo action :param bar: The bar parameter """ def nested(): """Some nested
Wie kann ich den Docstring einer Python-Datei bei der Ausführung drucken?
4 Antworten
Habe ich ein Python-script mit einem docstring. Wenn das Parsen der Kommandozeilen-Argumente nicht gelingt, will ich drucken, den docstring für die Informationen des Benutzers. Gibt es eine Möglichkeit, dies zu tun? Minimal-Beispiel #!/usr/bin/env python """ Usage: script.py
Docstrings vs Kommentare
4 Antworten
Ich bin ein wenig verwirrt über den Unterschied zwischen den docstrings und Kommentare in python. Meiner Klasse und meinem Lehrer etwas eingeführt, bekannt als "design-Rezept', eine Reihe von Schritten, die angeblich uns helfen, Studenten Grundstück und organisieren