Outil pour convertir le code Python pour qu'il soit conforme PEP8

Je sais qu'il existe des outils qui valident si votre code Python est conforme à PEP8, par exemple, il existe à la fois un service en ligne et un module python .

Cependant, je ne trouve pas de service ou de module capable de convertir mon fichier Python en un fichier Python valide PEP8 autonome. Est-ce que quelqu'un sait s'il y en a?
Je suppose que c'est faisable puisque PEP8 concerne uniquement l'apparence du code, non?

Malheureusement, "pep8 storming" (l'ensemble du projet) a plusieurs effets secondaires négatifs:

• beaucoup de conflits de fusion
• briser le blâme git
• rendre la révision du code difficile

Comme alternative (et merci à @yp pour l'idée ), j'ai écrit un petit paquet qui autopep8s uniquement les lignes sur lesquelles vous travaillez depuis le dernier commit / branch:

Fondamentalement, laisser le projet un peu mieux que vous ne l'avez trouvé :

pip install pep8radius

Supposons que vous ayez terminé votre travail masteret que vous soyez prêt à vous engager:

# be somewhere in your project directory
# see the diff with pep, see the changes you've made since master
pep8radius master --diff
# make those changes
pep8radius master --diff --in-place

Ou pour nettoyer les nouvelles lignes que vous avez validées depuis le dernier commit:

pep8radius --diff
pep8radius --diff --in-place

# the lines which changed since a specific commit `git diff 98f51f`
pep8radius 98f51f --diff

Fondamentalement, pep8radiusapplique autopep8 aux lignes dans la sortie de git / hg diff (à partir du dernier commit partagé ).

Ce script fonctionne actuellement avec git et hg, si vous utilisez autre chose et que vous voulez que cela fonctionne, veuillez poster un commentaire / un problème / PR !

Vous pouvez utiliser autopep8 ! Pendant que vous vous préparez une tasse de café, cet outil supprime joyeusement toutes ces violations PEP8 embêtantes qui ne changent pas la signification du code.

Installez-le via pip:

pip install autopep8

Appliquez ceci à un fichier spécifique:

autopep8 py_file --in-place

ou à votre projet (récursivement), l'option verbeuse vous donne quelques commentaires sur la façon dont ça se passe :

autopep8 project_dir --recursive --in-place --pep8-passes 2000 --verbose

Remarque: Parfois, la valeur par défaut de 100 passes n'est pas suffisante, je la règle sur 2000 car elle est raisonnablement élevée et attrapera tous les fichiers sauf les plus gênants (elle cesse de passer une fois qu'elle ne trouve aucune infraction pep8 résoluble) ...

À ce stade, je suggère de retester et de faire un commit!

Si vous voulez une conformité PEP8 "complète" : une tactique que j'ai utilisée est d'exécuter autopep8 comme ci-dessus, puis exécutez PEP8, qui imprime les violations restantes (fichier, numéro de ligne, et quoi):

pep8 project_dir --ignore=E501

et modifiez-les manuellement individuellement (par exemple E712 - comparaison avec booléen).

Remarque: autopep8 propose un --aggressiveargument (pour "corriger" impitoyablement ces violations qui changent de sens), mais méfiez-vous si vous utilisez agressif, vous devrez peut-être déboguer ... (par exemple dans numpy / pandas True == np.bool_(True)mais pas True is np.bool_(True)!)

Vous pouvez vérifier le nombre de violations de chaque type (avant et après):

pep8 --quiet --statistics .

Remarque: je considère que les E501 (ligne trop longue) sont un cas spécial car il y en aura probablement beaucoup dans votre code et parfois ils ne sont pas corrigés par autopep8.

A titre d'exemple, j'ai appliqué cette technique à la base de code pandas .

@Andy Hayden a donné un bon aperçu de autopep8. En plus de cela, il existe un autre package appelé pep8ify qui fait également la même chose.

Cependant, les deux packages peuvent supprimer uniquement les erreurs de charpie mais ils ne peuvent pas formater le code.

little = more[3:   5]

Le code ci-dessus reste le même après avoir pep8ifying également. Mais le code n'a pas encore l'air bien. Vous pouvez utiliser des formateurs comme yapf , qui formateront le code même si le code est conforme à PEP8. Le code ci-dessus sera formaté pour

little = more[3:5]

Parfois, cela détruit même votre formatage manuel. Par exemple

BAZ = {
    [1, 2, 3, 4],
    [5, 6, 7, 8],
    [9, 10, 11, 12]
}

sera converti en

BAZ = {[1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12]}

Mais vous pouvez lui dire d'ignorer certaines parties.

BAZ = {
   [1, 2, 3, 4],
   [5, 6, 7, 8],
   [9, 10, 11, 12]
}  # yapf: disable

Tiré de mon ancien article de blog: automatiquement PEP8 et formatez votre code Python!

Si vous utilisez eclipse + PyDev, vous pouvez simplement activer autopep8 à partir des paramètres de PyDev: Windows -> Préférences -> tapez «autopep8» dans le filtre de recherche.

Cochez la case "utiliser autopep8.py pour le formatage du code?" -> OK

Maintenant, le formatage du code CTRL-SHIFT-F d'Eclipse devrait formater votre code en utilisant autopep8 :)

J'ai fait de nombreuses recherches sur différents instruments pour python et le style de code. Il existe deux types d'instruments: les linters - analysant votre code et donnant des avertissements sur les styles de code mal utilisés et montrant des conseils sur la façon de le corriger, et les formateurs de code - lorsque vous enregistrez votre fichier, il reformate votre document en utilisant le style PEP.

Parce que le reformatage doit être plus précis - s'il remodèle quelque chose que vous ne voulez pas, il est devenu inutile - ils couvrent moins une partie de PEP, les linters en montrent beaucoup plus.

Tous ont des autorisations différentes pour la configuration - par exemple, pylinter configurable dans toutes ses règles (vous pouvez activer / désactiver tous les types d'avertissements), noir non configurable du tout.

Voici quelques liens et tutoriels utiles:

Documentation:

• Conventions de la docstring PEP-257: https://www.python.org/dev/peps/pep-0257/
• Indice de type PEP-484: https://www.python.org/dev/peps/pep-0484
• Guide de style de chrome https://chromium.googlesource.com/chromiumos/docs/+/master/styleguide/python.md
• Style de code pour l'autotest https://chromium.googlesource.com/chromiumos/third_party/autotest/+/master/docs/coding-style.md
• Guide de style de codage de la Khan Academy https://github.com/Khan/style-guides/blob/master/style/python.md
• Le guide de l'auto-stoppeur de Python https://docs.python-guide.org/
• Guide de style EdX Python https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/python-guidelines.html
• Article de style de code sur RealPython https://realpython.com/python-pep8/

Linters (par ordre de popularité):

• mypy https://github.com/python/mypy linter pour les vérifications de type (PEP-484)
• pycodestyle https://github.com/PyCQA/pycodestyle - bon utilisant PEP-8, très populaire. Souvent utilisé à côté du pylint et du flocon8 (simultanément)
• pylint https://github.com/PyCQA/pylint très configurable, activement pris en charge
• bandit https://github.com/PyCQA/bandit линтер по безопасности
• prospecteur https://github.com/PyCQA/prospector pylint + vérification de la difficulté du code
• flake8 https://github.com/PyCQA/flake8 wrapper pycodestyle avec possibilité d'activer les plugins. Très grande liste de différents plugins configurables. Voici le repo flake8 génial: https://github.com/DmytroLitvinov/awesome-flake8-extensions
• wemake https://github.com/wemake-services/wemake-python-styleguide - en essayant de combiner beaucoup de linters différents dans un projet (en réalité, c'est un plugin flake8 combinant les styles de plusieurs autres linters)
• pylama https://github.com/klen/pylama essayant de combiner 10 autres linters en un (mypy, pylint, pycodeestyle, pydocstyle и др.). Je peux voir le seul problème ici - ancienne version (pas de mises à jour dans le dépôt github pendant environ 10 mois.)
• pydocstyle https://github.com/PyCQA/pydocstyle docstrings linter (PEP-257)

Formateurs de code (par ordre de popularité):

• black https://github.com/psf/black le formateur le plus populaire, utilisé dans plusieurs grandes entreprises. A été créé plus tard que yapf, mais a déjà plus de départs sur GitHub
• yapf https://github.com/google/yapf Formateur de code Google
• autopep8 https://github.com/hhatto/autopep8 s'appuie sur le pycodestyle

Il y a beaucoup de.

Les IDE ont généralement une capacité de formatage intégrée. IntelliJ Idea / PyCharm le fait, il en va de même pour le plugin Python pour Eclipse, etc.

Il existe des formateurs / linters qui peuvent cibler plusieurs langues. https://coala.io en est un bon exemple.

Il y a ensuite les outils à usage unique, dont beaucoup sont mentionnés dans d'autres réponses.

Une méthode spécifique de reformatage automatique consiste à analyser le fichier dans l'arborescence AST (sans laisser de commentaires), puis à le renvoyer au texte (ce qui signifie que rien du formatage d'origine n'est conservé). Un exemple de cela serait https://github.com/python/black .