Benutzerdefinierte PyCharm-Docstring-Stubs (dh für Google Docstring- oder Numpydoc-Formate)

75

Unterstützt PyCharm 2.7 (oder wird PyCharm 3) benutzerdefinierte Docstring- und Doctest-Stubs? Wenn ja, wie geht man vor, um diese spezielle Art von benutzerdefinierter Erweiterung zu schreiben?

In meinem aktuellen Projekt wurde die Verwendung des Google Python Style Guide ( http://google-styleguide.googlecode.com/svn/trunk/pyguide.html ) standardisiert . Ich mag die Docstring-Unterstützung von PyCharm, aber derzeit werden nur zwei Formate unterstützt: Epytext und reStructureText. Ich möchte und bin bereit, selbst ein PyCharm-Plugin zu schreiben, das einen Dokumentationskommentar-Stub erstellt, der entweder im Google- oder im Numpydoc-Stil formatiert ist ( https://pypi.python.org/pypi/sphinxcontrib-napoleon/ ). Von besonderer Bedeutung ist hier die Integration der Typinferenzfähigkeiten, die PyCharm mit den beiden anderen Dokumentationstypen besitzt.

kalefranz
quelle
4
Sieht aus wie youtrack.jetbrains.com/issue/PY-9795 .
CrazyCoder

Antworten:

101

Mit PyCharm 5.0 konnten wir endlich die Python Docstrings- Vorlagen von Google und NumPy Style auswählen .

Es wird auch im Abschnitt " Was ist neu " für PyCharm 5.0 erwähnt.

So ändern Sie das Docstring-Format:

Datei -> Einstellungen -> Tools -> Integrierte Python-Tools

Dort können Sie aus den verfügbaren Docstrings-Formaten auswählen:

Plain, Epytext, reStructuredText, NumPy, Google

Wie von jstol hervorgehoben: Für Mac-Benutzer ist dies unter

PyCharm -> Einstellungen -> Tools -> Integrierte Python-Tools.

Nras
quelle
8
Für Mac-Benutzer befindet sich dies unter PyCharm -> Einstellungen -> Tools -> Integrierte Python-Tools.
Jstol
3
Haben Sie eine Idee, wie Sie diese Auswahl beibehalten können, wenn ich ein neues Projekt starte? Es ist ein Schmerz, diese Einstellung jedes Mal suchen zu müssen.
Superbeck
1
Erwägen Sie, diese Antwort zu aktualisieren, um Informationen in den Kommentar von jstol
Kane C
4

Wie CrazyCoder erwähnt, ist es ein Ticket . Im Moment können Sie nur EpyTypeund verwenden reStructuredText.

Spiele Brainiac
quelle
1

Nur um @Nras Antwort explizit zu machen, ab PyCharm 5.0 :

Datei> Einstellungen> Tools> Integrierte Python-Tools> Docstrings> Google

Kamil Sindi
quelle