docstring

3Hitze

1Antwort

Wie kann ich den Docstring für eine Eigenschaft einer Python-Klasseninstanz abrufen?

nehme ich eine Klasse wie diese: class TestCase(object): """Class docstring""" def meth(self): """Method docstring""" return 1 @property def prop(self): """Prop

1Hitze

1Antwort

Was bedeutet „docstring der Instanz-Objekt für weitere Informationen siehe“ bedeuten

ich so das Gefühl, eine dumme Frage, aber wenn ich in einem IPython Notebook bin und ich auf einige numpy/scipy Funktion helfen, wie stat sagen. norm.rvs, sagt es oft, über * args und ** kargs, "siehe

2Hitze

1Antwort

Latex Befehl \ bar nicht richtig in Python arbeiten Docstring

Ich habe eine Funktion mit einem docstring wie folgt def func(x): '''Boring function Notes ----- Let :math:`\bar{x}_k = \sum_{i=1}^{n_k}x_{ik}`, ''' return x Aber de

3Hitze

1Antwort

Ist es möglich, DocCheck-Strings an alle Funktionen in PyCharm anzuhängen?

Ich habe ein Python-Projekt, dass viele der Funktionen und Klassen Docstrings fehlen. Ich weiß, dass PyCharm automatisch Docstrings durch die Insert-Dokumentation String Stub Befehl mit Absicht Aktion

6Hitze

2Antwort

Wie dokumentiere ich: rtype: für eine Funktion, die mehrere mögliche Datentypen zurückgibt?

In einem Python-Docstring wie sollte man die :rtype: für eine Funktion dokumentieren, die mehrere mögliche Datentypen zurückgeben kann? Zum Beispiel, wenn eine Funktion defaultdict ODER dict ODER list

15Hitze

1Antwort

Wie können mehrere Typen für einen einzelnen Parameter oder einen Rückgabewert in DocStrings ausgedrückt werden, die von Sphinx verarbeitet werden?

Manchmal akzeptiert eine Funktion in Python ein Argument eines flexiblen Typs. Oder es kann einen Wert eines flexiblen Typs zurückgeben. Jetzt kann ich mich an kein gutes Beispiel für eine solche Funk

2Hitze

2Antwort

Python Docstrings Vorlagen

Warum funktioniert das dynamische Formatieren von Docstrings nicht? Gibt es eine akzeptable Problemumgehung dafür zur Funktionsdefinitionszeit? Ich versuchte mit Old-Skool-Stil% s Formatierung und das

2Hitze

3Antwort

Gibt es einen Konsens, was in den Klassen und __init__ Docstrings dokumentiert werden sollte?

Ich fand keine Best Practice darüber, was in den Klassen und __init__ Docstrings dokumentiert werden sollte. Manchmal finde ich, dass die Konstruktorargumente bereits in den Klassen Docstring dokument

16Hitze

1Antwort

Python Docstring: raise vs. raises

Ich benutze die PyCharm IDE, die beim Erstellen von PEP0257-konformen Docstrings hilft. Es verfügt über zwei Attribute ich nicht ganz verstehen, die Unterscheidung/Verwendung zwischen: :raise Exceptio

3Hitze

1Antwort

Gibt es einen Grund, Code vor den Docstring in Python zu setzen?

Ich sehe in einigen Leuten Python-Code, dass sie einige Prüfungen vor dem Docstring der Funktion einfügen; so etwas wie dieses: def func(args): if x_version != 1.7: return """docstring