Outil pour faire respecter le code python de style/normes

Dans le passé, j'ai surtout l'utilisation PyLint - il peut mettre en évidence lors de l'utilisation d'une variable non définie, lorsque vous importez des choses sans les utiliser et ainsi de suite.

Il peut être un peu verbeux, de se plaindre pour des choses comme des lignes de plus de 80 caractères, la variable ne correspond pas à certains regex, les classes ayant trop peu de public, des méthodes, les méthodes manquantes docs-trings.

Par exemple, pour le script..

import os
import somefakelib

def myfunc(x):
    blah = "Something"
    print os.listdir( x+blh )

PyLint génère les messages suivants:

C:  1: Missing docstring
F:  2: Unable to import 'somefakelib' (No module named somefakelib)
C:  4:myfunc: Missing docstring
C:  4:myfunc: Invalid name "x" (should match [a-z_][a-z0-9_]{2,30}$)
C:  4:myfunc: Invalid name "x" (should match [a-z_][a-z0-9_]{2,30}$)
E:  6:myfunc: Undefined variable 'blh'
W:  5:myfunc: Unused variable 'blah'
W:  2: Unused import somefakelib

Elles sont toutes les plaintes valides, mais j'ai tendance à désactiver beaucoup de la convention et de refactoring des messages. Vous pouvez désactiver les messages, soit comme des commentaires dans votre code:

#pylint:disable-msg=R0903,C0103,R0903,F0401,C0301

..ou que les arguments de ligne de commande pour le PyLint commande:

pylint --disable-msg=R0903,C0103,R0903,F0401,C0301 myfile.py

Avec les messages ci-dessus désactivé, il génère les messages suivants pour le code ci-dessus:

C:  1: Missing docstring
C:  4:myfunc: Missing docstring
E:  6:myfunc: Undefined variable 'blh'
W:  5:myfunc: Unused variable 'blah'
W:  2: Unused import somefakelib

PyLint génère également un "code de rapport", y compris le nombre de lignes de code/commentaires/docstring/espaces du fichier, le nombre de messages par catégorie, et donne à votre code d'un "score": 10 pas de messages, 0 étant généralement une erreur de syntaxe

Une autre option est PyFlakes, que je trouve un peu moins excessivement bavard (j'ai récemment commencé à l'utiliser à la place de PyLint). En utilisant à nouveau le script ci-dessus, PyFlakes donne les messages suivants:

example.py:2: 'somefakelib' imported but unused
example.py:6: undefined name 'blh'

La dernière option que j'utilise est pep8.py, qui comme son nom l'indique applique PEP8. Il est de loin le plus.. pédant script, l'application des choses comme correcte vide-lignes avant/après de fonctions/classes, l'espacement autour de code, correct 4-l'espace de l'indentation et ainsi de suite..

En cours d'exécution sur le code ci-dessus, ce produit est le suivant:

example.py:4:1: E302 expected 2 blank lines, found 1
example.py:6:23: E201 whitespace after '('
example.py:6:32: W292 no newline at end of file

Il est principalement applique stylistique des choses comme correcte espaces, il ne fait pas beaucoup d'analyse statique du code comme PyLint ou PyFlakes, donc j'utilise pep8.py en conjonction avec PyLint ou PyFlakes.

pep8.py a été initialement annoncé sur le python liste de diffusion ici, mais le lien de téléchargement dans ce qui est maintenant mort.. Il y a un github miroir par cburroughs, avec quelques corrections mineures à github.com/cburroughs/pep8.py, ou vous pouvez récupérer la version non modifiée de une ancienne révision

PyChecker est une autre option, bien que je n'ai pas l'utiliser

Trouvé ce stackoverflow question lors de la recherche pour un pep8 style de l'application de l'outil lors de la reprise d'un existant (ancienne) de projet.

https://github.com/hhatto/autopep8

autopep8 -i yourpythonsourcefile.py

sera automatiquement convertir l'ensemble du code source à confirmer avec pep8. Essayé sur mon projet de l'héritage et il fonctionne très bien. J'ai donc pensé que je voudrais mettre à jour cette réponse ici dans la.