web-dev-qa-db-fra.com

Bouts de docstring PyCharm personnalisés (c'est-à-dire pour les formats google docstring ou numpydoc)

PyCharm 2.7 (ou PyCharm 3) prend-il en charge les talons de docstring et doctest personnalisés? Si oui, comment procéder pour écrire ce type spécifique d'extension personnalisée?

Mon projet actuel a normalisé l'utilisation du Google Python ( http://google-styleguide.googlecode.com/svn/trunk/pyguide.html ). J'adore le support de docstring de PyCharm, mais ce ne sont que deux formats pris en charge actuellement epytext et reStructureText. Je veux, et je suis prêt à m'écrire moi-même, un plugin PyCharm qui crée un stub de commentaire de documentation formaté dans le style Google ou Numpydoc ( https://pypi.python.org/pypi/sphinxcontrib-napoleon/ ). Il est particulièrement important d'intégrer ici les capacités d'inférence de type que PyCharm possède avec les deux autres types de documentation.

66
kalefranz

Avec PyCharm 5.0, nous avons finalement pu sélectionner Google et NumPy Style Python Docstrings modèles).

Il est également mentionné dans la section whatsnew pour PyCharm 5.0.

Comment changer le format Docstring:

Fichier -> Paramètres -> Outils -> Python Outils intégrés

Là, vous pouvez choisir parmi les formats Docstrings disponibles:

Ordinaire, Epytext, reStructuredText, NumPy, Google

Comme l'a souligné jstol: pour les utilisateurs Mac, c'est sous

PyCharm -> Préférences -> Outils -> Python Outils intégrés.

89
Nras

Comme le mentionne CrazyCoder, c'est un ticket . Pour le moment, vous ne pouvez utiliser que EpyType et reStructuredText.

4
Games Brainiac

Juste pour que la réponse de @Nras soit explicite, à partir de PyCharm 5. :

Fichier> Paramètres> Outils> Python Outils intégrés> Docstrings> Google

1
ksindi