Überprüfen Sie den Python-Codestil mit pep8
2019.08.01 Siehe unten, wie es alt ist. ** Die Geschichte von Python, die von Cowboys gehasst wird ** https://qiita.com/mima_ita/items/cabcf014aa08e27c8de7
Überblick
In diesem Dokument wird beschrieben, wie Sie nach Verstößen gegen PEP8, den Codierungsstil für Python-Code, suchen.
PEP 8 -- Style Guide for Python Code http://legacy.python.org/dev/peps/pep-0008/
Übersetzung: https://dl.dropboxusercontent.com/u/555254/pep-0008.ja.html
Wie installiert man
PEP8 - Installieren Sie den Python Style Guide Checker https://pypi.python.org/pypi/pep8/
easy_install pep8
Oder
pip install pep8
Auf diese Weise können Sie pep8 über die Befehlszeile ausführen.
pep8 test.py
pep8 /test/directory
Wenn ein Verzeichnis angegeben ist, wird auch das Unterverzeichnis überprüft.
Hauptoptionen
| Optionsname | Erläuterung |
|---|---|
| --version | Version anzeigen |
| -h,--help | Hilfe erhalten |
| -v,--verbose | Zeigen Sie Statusmeldungen an, z. B. den Namen der zu überprüfenden Datei.--Die Debug-Meldung wird in vv angezeigt |
| -q,--quiet | Zeigen Sie nur den Dateinamen an.-qq zeigt nichts an. |
| --first | Im Falle des gleichen Fehlers nur am Anfang anzeigen |
| --exclude=patterns | Beschreiben Sie das Muster der auszuschließenden Dateinamen und Verzeichnisnamen. Sie können mehrere haben, indem Sie sie durch Kommas trennen. Standard:.svn,CVS,.bzr,.hg,.git,pycache |
| --filename=patterns | Bei der Suche in einem Verzeichnis werden nur Dateien mit dem hier angegebenen Muster durchsucht. Sie können mehrere durch Kommas getrennte Elemente angeben. Standard: *.py |
| --select=errors | Geben Sie Fehler und Warnungen an Beispiel: E.,W6 |
| --ignore=errors | Ignorieren Sie den angegebenen Fehler Beispiel: E.,W6 |
| --show-source | Quelle für jeden Fehler anzeigen |
| --show-pep8 | Fügen Sie jedem Fehler eine Beschreibung von PEP8 hinzu.--Sie sollten es zuerst mit verwenden |
| --statistics | Aggregieren Sie die Anzahl der Fehler und Warnungen und zeigen Sie sie am Ende an |
| --count | Zeigen Sie abschließend die Gesamtzahl der Fehler und Warnungen an |
| --config=path | Sie können den Speicherort der Einstellungsdatei angeben. |
Einstellungsdatei
Der Wert jeder Option kann in der Konfigurationsdatei angegeben werden, die mit der Konfigurationsoption angegeben werden kann.
[pep8]
ignore = E111
Verwendung von Python
Es kann auch aus Python verwendet werden, indem pep8 importiert wird.
import pep8
pep8style = pep8.StyleGuide(quiet=True)
ret = pep8style.check_files(['test.py']);
print ret.total_errors
Verwendung von Jenkins
Die Aggregation ist mit Violations, einem Jenkins-Plug-In, möglich.
Bei der Ausführung über ein Shell-Skript muss am Anfang "#! / Bin / sh" geschrieben und am Ende wie folgt kein Fehlercode zurückgegeben werden.
#!/bin/sh
pep8 /share/py/test.py > ${WORKSPACE}/test.txt
echo "....finished"
Auf der folgenden Seite finden Sie den Grund, warum Sie dies tun müssen. Informationen zum Ausführen der Jenkins-Shell Die Einstellungen für Verstöße sind wie folgt.
Es ist nicht erforderlich, in XML auszugeben.
Recommended Posts