Journal Pyment: patcher les docstrings Python

Posté par . Licence CC by-sa
16
14
mar.
2014

Voici Pyment, une application Python qui permet de générer des patches sur du code Python pour ajouter ou modifier des docstrings.
Vous pouvez par exemple remplacer/harmoniser toutes les docstrings d'un projet par des docstrings dans un format particulier (reST pour Sphinx, Google style, javadoc style).

Voici le projet:

https://github.com/dadadel/pyment

Il est possible de spécifier un fichier python ou un dossier qui sera parsé (avec ses sous-dossiers) à la recherche de fichiers Python. Pour chaque fichier un patche sera généré.

Pyment reconnaît automatiquement pour chaque docstring son style et effectue la conversion si nécessaire.
Il ajoute également les valeurs par défaut s'il y en a et qu'elles ne sont pas mentionnées. Si une fonction n'a pas de docstring il en créée une (un squelette).

Il s'agit d'une première version alpha. Si ça vous intéresse, n'hésitez pas à la tester et faire des critiques.

  • # inclusion dans une librairie de refactoring

    Posté par . Évalué à 1.

    Bonjour,

    est-ce qu'il ne serait pas intéressant d'intégrer pyment dans une librairie de refactoring plutôt que de faire un projet indépendant; rope ?

    • [^] # Re: inclusion dans une librairie de refactoring

      Posté par . Évalué à 1.

      Je ne connais pas rope. Je vais me renseigner. Peut-être que Pyment pourrait s'y intégrer à terme. Je comptais le rendre utilisable en tant que lib. J'ai dans ma todolist de séparer justement d'avantage le code d'utilisation des classes utiles.
      En tout cas, pour moi il a son utilité en tant que projet indépendant ne serait-ce que pour générer des patchs facilement en spécifiant uniquement un fichier ou un dossier et éventuellement un format de sortie.

  • # Canal IRC

    Posté par . Évalué à 1. Dernière modification le 17/03/14 à 16:31.

    Si ça vous intéresse d'en discuter, j'ai créé un canal IRC dédié sur Freenode: #pyment

Suivre le flux des commentaires

Note : les commentaires appartiennent à ceux qui les ont postés. Nous n'en sommes pas responsables.