2013-09-06 7 views
55

Bietet PyCharm 2.7 (oder wird PyCharm 3) Unterstützung für benutzerdefinierte Docstring- und Doctest-Stubs? Wenn ja, wie schreibt man diesen spezifischen Typ von benutzerdefinierter Erweiterung?Benutzerdefinierte PyCharm-Docstring-Stubs (d. H. Für google Docstring- oder numpydoc-Formate)

Mein aktuelles Projekt hat den Google Python Style Guide (http://google-styleguide.googlecode.com/svn/trunk/pyguide.html) standardisiert. Ich liebe PyCharms Docstring-Unterstützung, aber es gibt nur zwei unterstützte Formate, Epytext und reStructureText. Ich möchte und bin bereit, mir selbst ein PyCharm-Plugin zu schreiben, das einen Dokumentationskommentar-Stub im Google- oder Numpydoc-Stil erstellt (https://pypi.python.org/pypi/sphinxcontrib-napoleon/). Von besonderer Bedeutung ist hier die Berücksichtigung der Inferenzfähigkeiten, die PyCharm mit den beiden anderen Dokumentationsarten hat.

+4

Sieht aus wie http: // youtrack.jetbrains.com/issue/PY-9795. – CrazyCoder

Antwort

68

Mit PyCharm 5.0 können wir nun Google and NumPy Style Python Docstrings Vorlagen auswählen.

Es wird auch in der whatsnew Abschnitt für PyCharm 5.0 erwähnt.

Wie die Docstring Format ändern:

Datei -> Einstellungen -> Extras -> Python Integrierte Werkzeuge

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

Plain, Epytext, reStructuredText, NumPy, Google

Wie bereits von jstol aus: für Mac-Benutzer, ist dies unter

PyCharm -> Einstellungen -> Extras -> Python Integrierte Werkzeuge.

+6

Für Mac-Benutzer ist dies unter PyCharm -> Einstellungen -> Werkzeuge -> Integrierte Python-Tools. – jstol

+2

Irgendeine Idee, wie man diese Auswahl hält, wenn ich ein neues Projekt starte? Es ist ein Schmerz, diese Einstellung jedes Mal aufzuspüren. – superbeck

+1

Erwägen Sie, diese Antwort zu aktualisieren, um Informationen in den Kommentar von jstol einzufügen –

4

Wie CrazyCoder erwähnt, ist es ein ticket. Im Moment können Sie nur EpyType und reStructuredText verwenden.

1

Nur um machen @Nras explizit beantworten, wie von PyCharm 5.0:

Datei> Einstellungen> System> Python Integrated Tools> Docstrings> Google

Verwandte Themen