Tool zum Konvertieren von Python-Code in PEP8-kompatibel

Ich weiß, dass es Tools gibt, die überprüfen, ob Ihr Python-Code mit PEP8 kompatibel ist. Beispielsweise gibt es sowohl einen Onlinedienst als auch ein Python-Modul .

Ich kann jedoch keinen Dienst oder kein Modul finden , der meine Python-Datei in eine in sich geschlossene, PEP8-gültige Python-Datei konvertieren kann. Weiß jemand, ob es welche gibt?
Ich nehme an, es ist machbar, da es bei PEP8 nur um das Erscheinungsbild des Codes geht, oder?

Leider hat "pep8 Storming" (das gesamte Projekt) mehrere negative Nebenwirkungen:

• viele Zusammenführungskonflikte
• git Schuld brechen
• Codeüberprüfung erschweren

Als Alternative (und danke an @yp für die Idee ) habe ich ein kleines Paket geschrieben, das nur die Zeilen automatisch bearbeitet, an denen Sie seit dem letzten Commit / Branch gearbeitet haben:

Grundsätzlich verlassen Sie das Projekt ein wenig besser als Sie es vorgefunden haben :

pip install pep8radius

Angenommen, Sie haben Ihre Arbeit erledigt masterund sind bereit, sich zu verpflichten:

# 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

Oder um die neuen Zeilen zu bereinigen, die Sie seit dem letzten Festschreiben festgeschrieben haben:

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

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

Grundsätzlich pep8radiuswird autopep8 auf Zeilen in der Ausgabe von git / hg diff angewendet (vom letzten gemeinsamen Commit ).

Dieses Skript funktioniert derzeit mit git und hg. Wenn Sie etwas anderes verwenden und möchten, dass dies funktioniert, schreiben Sie bitte einen Kommentar / ein Problem / eine PR !

Sie können autopep8 verwenden ! Während Sie sich eine Tasse Kaffee machen, entfernt dieses Tool glücklich alle lästigen PEP8-Verstöße, die die Bedeutung des Codes nicht ändern .

Installieren Sie es über pip:

pip install autopep8

Wenden Sie dies auf eine bestimmte Datei an:

autopep8 py_file --in-place

oder zu Ihrem Projekt (rekursiv) gibt Ihnen die ausführliche Option ein Feedback darüber, wie es läuft :

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

Hinweis: Manchmal reicht die Standardeinstellung von 100 Durchgängen nicht aus. Ich habe sie auf 2000 gesetzt, da sie relativ hoch ist und alle bis auf die problematischsten Dateien abfängt (sie werden nicht mehr übergeben, sobald keine auflösbaren pep8-Verstöße festgestellt werden).

An dieser Stelle schlage ich vor, erneut zu testen und ein Commit durchzuführen!

Wenn Sie eine "vollständige" PEP8-Konformität wünschen: Eine Taktik, die ich verwendet habe, besteht darin, Autopep8 wie oben auszuführen und dann PEP8 auszuführen, das die verbleibenden Verstöße (Datei, Zeilennummer und was) druckt:

pep8 project_dir --ignore=E501

und ändern Sie diese manuell einzeln (zB E712s - Vergleich mit Booleschen Werten).

Hinweis: autopep8 bietet ein --aggressiveArgument (um diese bedeutungsverändernden Verstöße rücksichtslos zu "beheben"), aber Vorsicht, wenn Sie aggressiv sind, müssen Sie möglicherweise debuggen ... (z. B. in numpy / pandas, True == np.bool_(True)aber nicht True is np.bool_(True)!)

Sie können überprüfen, wie viele Verstöße jedes Typs (vorher und nachher):

pep8 --quiet --statistics .

Hinweis: Ich halte E501s (Zeile zu lang) für einen Sonderfall, da wahrscheinlich viele davon in Ihrem Code enthalten sind und diese manchmal nicht durch Autopep8 korrigiert werden.

Als Beispiel habe ich diese Technik auf die Pandas- Codebasis angewendet .

@Andy Hayden gab einen guten Überblick über autopep8. Darüber hinaus gibt es ein weiteres Paket namens pep8ify , das dasselbe tut.

Beide Pakete können jedoch nur Flusenfehler entfernen, aber keinen Code formatieren.

little = more[3:   5]

Der obige Code bleibt auch nach pep8ifying gleich. Aber der Code sieht noch nicht gut aus. Sie können Formatierer wie yapf verwenden , die den Code auch dann formatieren , wenn der Code PEP8-kompatibel ist. Der obige Code wird mit formatiert

little = more[3:5]

Manchmal zerstört dies sogar Ihre manuelle Formatierung. Beispielsweise

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

wird konvertiert zu

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

Sie können jedoch festlegen, dass einige Teile ignoriert werden sollen.

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

Entnommen aus meinem alten Blog-Beitrag: Automatisch PEP8 & Formatieren Sie Ihren Python-Code!

Wenn Sie eclipse + PyDev verwenden, können Sie autopep8 einfach über die PyDev-Einstellungen aktivieren: Windows -> Einstellungen -> geben Sie 'autopep8' in den Suchfilter ein.

Überprüfen Sie die Option "Verwenden Sie autopep8.py für die Code-Formatierung?". -> OK

Jetzt sollte die CTRL-SHIFT-F-Code-Formatierung von eclipse Ihren Code mit autopep8 formatieren :)

Ich habe mich intensiv mit verschiedenen Instrumenten für Python und Code befasst. Es gibt zwei Arten von Instrumenten: Linters - Analysieren Ihres Codes und Warnen vor schlecht verwendeten Codestilen und Anzeigen von Ratschlägen zur Behebung des Problems sowie Code-Formatierer - Wenn Sie Ihre Datei speichern, wird Ihr Dokument im PEP-Stil neu formatiert.

Da die Neuformatierung genauer sein muss - wenn sie etwas remorfiert, von dem Sie nicht möchten, dass sie unbrauchbar wird -, decken sie weniger Teile von PEP ab, zeigen Linters viel mehr.

Alle haben unterschiedliche Berechtigungen für die Konfiguration - zum Beispiel Pylinter, der in all seinen Regeln konfigurierbar ist (Sie können jede Art von Warnungen ein- und ausschalten), schwarz überhaupt nicht konfigurierbar.

Hier sind einige nützliche Links und Tutorials:

Dokumentation:

• PEP-257 Docstring-Konventionen: https://www.python.org/dev/peps/pep-0257/
• PEP-484 Typ Hinweis: https://www.python.org/dev/peps/pep-0484
• Chromium Style Guide https://chromium.googlesource.com/chromiumos/docs/+/master/styleguide/python.md
• Codestil für Autotest https://chromium.googlesource.com/chromiumos/third_party/autotest/+/master/docs/coding-style.md
• Khan Academy Coding Style Guide https://github.com/Khan/style-guides/blob/master/style/python.md
• Der Per Anhalter durch Python https://docs.python-guide.org/
• EdX Python Style Guide https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/python-guidelines.html
• Artikel im Codestil zu RealPython https://realpython.com/python-pep8/

Linters (in der Reihenfolge ihrer Beliebtheit):

• mypy https://github.com/python/mypy linter für Typprüfungen (PEP-484)
• pycodestyle https://github.com/PyCQA/pycodestyle - gut mit PEP-8, sehr beliebt. Wird oft zusammen mit Pylint und Flake8 verwendet (gleichzeitig)
• pylint https://github.com/PyCQA/pylint sehr konfigurierbar, aktiv unterstützt
• Bandit https://github.com/PyCQA/bandit линтер по безопасности
• Prospektor https://github.com/PyCQA/prospector Pylint + Code Schwierigkeitsgradprüfung
• flake8 https://github.com/PyCQA/flake8 pycodestyle wrapper mit der Möglichkeit, Plugins einzuschalten. Sehr große Liste verschiedener konfigurierbarer Plugins. Hier ist ein fantastisches Flake8-Repo: https://github.com/DmytroLitvinov/awesome-flake8-extensions
• wemake https://github.com/wemake-services/wemake-python-styleguide - versucht, viele verschiedene Linters in einem Projekt zu kombinieren (eigentlich ist es ein flake8-Plugin, das Stile aus mehreren anderen Lintern kombiniert)
• pylama https://github.com/klen/pylama versucht 10 weitere Linters in einem zu kombinieren (mypy, pylint, pycodeestyle, pydocstyle и др.). Ich kann hier das einzige Problem sehen - alte Version (keine Updates in Github Repo für ca. 10 Monate.)
• pydocstyle https://github.com/PyCQA/pydocstyle docstrings linter (PEP-257)

Code-Formatierer (in der Reihenfolge ihrer Beliebtheit):

• schwarz https://github.com/psf/black meist bevölkerungsreicher Formatierer, der in mehreren großen Unternehmen verwendet wird. Wurde später als yapf erstellt, hat aber bereits mehr Starts bei GitHub
• yapf https://github.com/google/yapf Google-Code-Formatierer
• autopep8 https://github.com/hhatto/autopep8 baut auf dem Pycodestyle auf

Es gibt viele.

In IDEs sind normalerweise einige Formatierungsfunktionen integriert. IntelliJ Idea / PyCharm funktioniert, dies gilt auch für das Python-Plugin für Eclipse und so weiter.

Es gibt Formatierer / Linters, die auf mehrere Sprachen abzielen können. https://coala.io ist ein gutes Beispiel dafür.

Dann gibt es die Einzweckwerkzeuge, von denen viele in anderen Antworten erwähnt werden.

Eine spezielle Methode zur automatischen Neuformatierung besteht darin, die Datei in einen AST-Baum zu analysieren (ohne Kommentare zu löschen) und sie dann wieder in Text zu kopieren (was bedeutet, dass nichts von der ursprünglichen Formatierung erhalten bleibt). Ein Beispiel hierfür wäre https://github.com/python/black .