2019.08.01 Voir ci-dessous car il est ancien. ** L'histoire de Python détesté par les cowboys ** https://qiita.com/mima_ita/items/cabcf014aa08e27c8de7

Aperçu

Ce document décrit comment vérifier les violations de PEP8, le style de codage du code Python.

PEP 8 -- Style Guide for Python Code http://legacy.python.org/dev/peps/pep-0008/

Traduction: https://dl.dropboxusercontent.com/u/555254/pep-0008.ja.html

Comment installer

PEP8 - Installer le vérificateur de guide de style Python https://pypi.python.org/pypi/pep8/

easy_install pep8

pip install pep8

Cela vous permet d'exécuter pep8 à partir de la ligne de commande.

pep8 test.py
pep8 /test/directory

Si un répertoire est spécifié, le sous-répertoire est également vérifié.

Options principales

Nom de l'option	La description
--version	Afficher la version
-h,--help	Obtenir de l'aide
-v,--verbose	Affichez les messages d'état tels que le nom du fichier en cours de vérification.--Le message de débogage est affiché dans vv
-q,--quiet	Afficher uniquement le nom du fichier.-qq n'affiche rien.
--first	Dans le cas de la même erreur, afficher uniquement au début
--exclude=patterns	Décrivez le modèle des noms de fichier et des noms de répertoire à exclure. Vous pouvez en avoir plusieurs en les séparant par des virgules. Défaut:.svn,CVS,.bzr,.hg,.git,pycache
--filename=patterns	Lors de la recherche d'un répertoire, seuls les fichiers avec le modèle spécifié ici sont recherchés. Vous pouvez spécifier plusieurs éléments séparés par des virgules. Défaut: *.py
--select=errors	Spécifiez les erreurs et les avertissements Exemple: E,W6
--ignore=errors	Ignorer l'erreur spécifiée Exemple: E,W6
--show-source	Afficher la source pour chaque erreur
--show-pep8	Ajoutez une description de PEP8 à chaque erreur.--Vous devriez l'utiliser avec d'abord
--statistics	Regroupez le nombre d'erreurs et d'avertissements et affichez-les à la fin
--count	Enfin, affichez le nombre total d'erreurs et d'avertissements
--config=path	Vous pouvez spécifier l'emplacement du fichier de paramètres.

fichier de configuration

La valeur de chaque option peut être spécifiée dans le fichier de configuration qui peut être spécifié avec l'option config.

[pep8]
ignore = E111

Utilisation depuis Python

Il peut également être utilisé depuis Python en important pep8.

import pep8
pep8style = pep8.StyleGuide(quiet=True)
ret = pep8style.check_files(['test.py']);
print ret.total_errors

Utilisation de Jenkins

L'agrégation est possible en utilisant Violations, un plug-in Jenkins.

Lors de l'exécution à partir d'un script shell, il est nécessaire d'écrire "#! / Bin / sh" au début et le processus qui ne retourne pas de code d'erreur à la fin comme suit.

#!/bin/sh
pep8 /share/py/test.py > ${WORKSPACE}/test.txt
echo "....finished"

Consultez la page ci-dessous pour connaître la raison pour laquelle vous devez le faire. À propos de l'exécution du shell Jenkins Les paramètres des violations sont les suivants.

Il n'est pas nécessaire de générer une sortie en XML.