So verwenden Sie Pylint in Python (Pylint-Code-Inspektion)_python

Pylint bietet eine einfache Möglichkeit, Python-Code zu analysieren, und seine hohe Konfigurierbarkeit erleichtert es den Mitarbeitern einer Abteilung, einen einheitlichen Codierungsstil zu verwenden. In diesem Artikel wird erklärt, wie Pylint Python-Code durch theoretische Einführung und Beispielanalyse standardisieren kann

1 Was ist Pylint

Pylint ist ein Python-Code-Analysetool, das Python-Code analysiert Fehler im Code, Suche nach Code, der nicht den Standards des Codierungsstils entspricht und potenzielle Probleme aufweist.
Pylint ist ein Python-Tool. Zusätzlich zu den Funktionen gewöhnlicher Codeanalysetools bietet es weitere Funktionen: z. B. die Überprüfung der Länge einer Codezeile, ob der Variablenname dem Benennungsstandard entspricht und ob eine deklarierte Variable vorhanden ist Schnittstelle tatsächlich implementiert ist usw.
Ein großer Vorteil von Pylint besteht darin, dass es in hohem Maße konfigurierbar und anpassbar ist und es einfach ist, kleine Plug-Ins zu schreiben, um Funktionalität hinzuzufügen.

Wenn Sie Pylint zweimal ausführen, werden die Ergebnisse sowohl der aktuellen als auch der letzten Ausführung angezeigt, sodass Sie sehen können, ob sich die Codequalität verbessert hat. Pylint ist derzeit auch im Pydev-Plugin von Eclipse integriert.

2. Installation von Pylint unter Linux

1. Installieren Sie unter Linux zunächst das Python-Paket (höher als Version 2.2) und legen Sie es in der Umgebungsvariablen $PATH fest Fügen Sie den Pfad zur ausführbaren Python-Datei hinzu.
2. Laden Sie die Pakete von Pylint, logilab-astng (Version >= 0.14) und logilab-common (Version >= 0.13) herunter und verwenden Sie tar zxvf *.tar.gz, um diese Pakete zu dekomprimieren.
3. Geben Sie der Reihe nach die Ordner ein, in die logilab-astng, logilab-common und Pylint extrahiert wurden, und führen Sie zur Installation den Befehl Python setup.py install aus.
4. Nachdem die Installation abgeschlossen ist, können Sie Pylint über pylint [options] module_or_package aufrufen.

3. Installation von Pylint unter Windows

1. Installieren Sie das Python-Paket (höher als Version 2.2), klicken Sie mit der rechten Maustaste auf das Arbeitsplatzsymbol und wählen Sie Eigenschaften, Erweitert, Umgebungsvariablen und fügen Sie den Python-Installationspfad zu $PATH hinzu, z. B. C:Python26.
2. Verwenden Sie das Dekomprimierungstool, um alle Pakete zu dekomprimieren.
3. Öffnen Sie das Befehlszeilenfenster, geben Sie mit cd nacheinander die entpackten Ordner logilab-astng, logilab-common und Pylint ein und führen Sie zur Installation den Befehl python setup.py install aus.
4. Nach Abschluss der Installation erscheint im Python-Installationspfad ein Skriptordner, der einige Bat-Skripte wie pylint.bat usw. enthält.
5. Um die Eingabe des vollständigen Pfads beim Aufruf von pylint.bat zu vermeiden, erstellen Sie eine Umleitungsdatei von pylint.bat im Python-Installationsverzeichnis. Dies ist eine Nur-Text-Datei, die pylint.bat enthält Pfad, wie zum Beispiel: C:\Python26Scriptspylint.bat.
6. Nachdem die Installation abgeschlossen ist, können Sie Pylint über pylint [options] module_or_package aufrufen.

4. Verwenden Sie Pylint

Verwenden Sie Pylint, um den Code eines Moduls module.py zu überprüfen:

1 befindet, funktioniert das Ausführen von

pylint [options] module.py

immer, da das aktuelle Arbeitsverzeichnis automatisch zum Python-Pfad hinzugefügt wird.

2. Führen Sie

pylint [options] directory/module.py

aus, ohne den Ordner einzugeben, in dem sich das Modul befindet. Diese Aufrufmethode kann funktionieren, wenn die folgenden Bedingungen erfüllt sind: Das Verzeichnis ist ein Python Das Paket (das beispielsweise eine __init__.py-Datei enthält) oder das Verzeichnis wird dem Suchpfad von Python hinzugefügt.

Verwenden Sie Pylint, um den Code eines Pakets zu überprüfen:

1 Geben Sie den Ordner ein, in dem sich das Paket befindet, und führen Sie

pylint [options] pakage

aus call Diese Methode funktioniert immer, da das aktuelle Arbeitsverzeichnis automatisch zum Python-Pfad hinzugefügt wird.

2. Führen Sie

pylint [options] directory/ pakage

aus, ohne den Ordner einzugeben, in dem sich das Paket befindet. In diesem Fall kann es funktionieren, wenn die folgenden Bedingungen erfüllt sind: Verzeichnis ist im Python-Pfad hinzugefügt. Unter Linux exportieren Sie beispielsweise das Verzeichnis PYTHONPATH=$PYTHONPATH:.
Darüber hinaus können Sie für Maschinen, auf denen das tkinter-Paket installiert ist, den Befehl pylint-gui verwenden, um eine einfache GUI-Schnittstelle zu öffnen. Geben Sie hier den Namen des Moduls oder Pakets ein (die Regeln sind dieselben wie in der Befehlszeile). Klicken Sie auf „Ausführen“, und die Ausgabe von Pylint wird in der GUI angezeigt.

5. Allgemeine Befehlszeilenparameter von Pylint

-h,--help : Alle Hilfeinformationen anzeigen.
--generate-rcfile: Sie können pylint --generate-rcfile verwenden, um eine Beispielkonfigurationsdatei zu generieren. Mithilfe der Umleitung können Sie diese Konfigurationsdatei zur späteren Verwendung speichern. Sie können auch andere Optionen voranstellen, sodass die Werte dieser Optionen in der generierten Konfigurationsdatei enthalten sind. Beispiel: pylint --persistent=n --generate-rcfile > Wenn Sie sich pylint.conf ansehen, können Sie sehen, dass persistent=no nicht mehr der Standardwert „yes“ ist.
--rcfile=: Geben Sie eine Konfigurationsdatei an. Fügen Sie die von Ihnen verwendete Konfiguration in die Konfigurationsdatei ein, wodurch nicht nur Ihr eigener Code standardisiert wird, sondern es auch einfacher wird, diese Spezifikationen mit anderen zu teilen.
-i , --include-ids=: Fügen Sie die Nachrichten-ID in die Ausgabe ein und verwenden Sie dann pylint --help-msg= diese Fehlerinformationen, damit der Fehler gezielt lokalisiert werden kann.
-r , --reports= Der Standardwert ist y, was bedeutet, dass die Ausgabe von Pylint nicht nur den Quellcode-Analyseteil, sondern auch den Berichtsteil enthält.
--files-output=: Geben Sie die Nachricht jedes Moduls/Pakets in eine Datei mit dem Namen [txt|html] aus. Wenn es einen Bericht gibt, geben Sie ihn in pylint_global aus html]-Datei. Standardmäßig erfolgt die Ausgabe auf dem Bildschirm und nicht in einer Datei.
-f , --output-format=: Legen Sie das Ausgabeformat fest. Die auswählbaren Formate sind Text, Parseable, Colorized, MSVS (Visual Studio) und HTML. Das Standardausgabeformat ist Text.
--disable-msg= Wenn die Ausgabe beispielsweise die Warnmeldung W0402 enthält, können Sie -- verwenden. disable-msg=W0402

6. Pylint-Ausgabe

Das Standardausgabeformat von Pylint ist das Rohtextformat, das mit -f um andere Ausgabeformate wie HTML usw. anzugeben.

Die Ausgabe von Pylint besteht aus zwei Teilen: dem Quellcode-Analyseteil und dem Berichtsteil.
Quellcode-Analyseteil:
Für jedes Python-Modul zeigt das Pylint-Ergebnis zunächst einige „*“-Zeichen an, gefolgt vom Namen des Moduls und dann einer Reihe von Meldungen. Das Format der Nachricht ist wie folgt : __MESSAGE_TYPE: LINE_NUM:[OBJECT:] MESSAGE__ MESSAGE_TYPE hat die folgenden Typen:

(C) Konvention. Verstößt gegen Codierungsstilstandards
(R) Refactoring. Sehr schlecht geschriebener Code.
(W) Warnung. Einige Python-spezifische Fragen.
(E) Fehler. Höchstwahrscheinlich ein Fehler im Code.
(F) Schwerwiegender Fehler. Ein Fehler, der die weitere Ausführung von Pylint verhindert.

Berichtsabschnitt:

Nach Abschluss der Quellcode-Analyse wird es eine Reihe von Berichten geben, wobei sich jeder Bericht auf bestimmte Aspekte des Projekts konzentriert. wie jede Die Anzahl der Nachrichten verschiedener Kategorien, Modulabhängigkeiten usw.
Im Einzelnen umfasst der Bericht folgende Aspekte: Die Anzahl der überprüften Module. Für jedes Modul der Prozentsatz der Fehler und Warnungen.
Zum Beispiel gibt es zwei Module A und B. Wenn insgesamt 4 Fehler erkannt werden, 1 Fehler in A und 3 Fehler in B liegen, dann beträgt der Prozentsatz der Fehler in A 25 %, und der Prozentsatz von Fehler in B beträgt 25 %. Der Prozentsatz beträgt 75 %. Die Gesamtzahl der Fehler und Warnungen.

So verwenden Sie Pylint in Python

Öffnen Sie unter Eclipse IDE das Dialogfeld „Fenster->Einstellungen...“ und wählen Sie „PyDev“->„Interpreter Python“. ", klicken Sie auf die Schaltfläche „Neu“, wählen Sie „Python.exe“ aus dem Python-Installationspfad aus. Anschließend wird ein Dialogfeld angezeigt, in dem Sie aufgefordert werden, „System-PYTHONPATH“ zu überprüfen. Ich habe beide ausgewählt, daher sollte es keine Rolle spielen. Klicken Sie abschließend auf OK, um den Vorgang zu beenden.

1. Entwicklung und Konfiguration des Django-Projekts

1. Erstellen Sie ein PyDev-Projekt

Eclipse IDE——>Datei——>Neu— —>Andere——>Pydev——>Pydev-Projekt auswählen——>Ein Projekt benennen (z. B. Demo)——>Pfad auswählen, z. B. E:/work——>Python auswählen passt zu Ihrer Version (meine ist 2.5) -> Deaktivieren Sie das Kontrollkästchen unten und erstellen Sie keine src-Datei -> Fertig stellen.

2. Django-Projekt erstellen

(1) django-admin.py startproject demo. (Es scheint, dass Sie django-admin.py nicht direkt in der Befehlszeile verwenden können, sondern C:/Python26/Scripts/django-admin.py verwenden müssen. Später erfuhr ich, dass Sie C:/Python26/Scripts zum Pfad hinzufügen müssen .)

(2) Kopieren Sie das generierte Django-Projektverzeichnis in das Verzeichnis unter dem gerade von Eclipse erstellten Projekt. Kehren Sie gerade zur Elicpse-IDE zurück. Aktualisieren Sie die neu erstellte Projektdemo in der PyDev-Paketansicht, um das Django-Projekt anzuzeigen. Das Hinzufügen und Löschen von Dateien und Verzeichnissen kann über das Rechtsklick-Menü erfolgen.

3. Django-Projekt-Engineering-Konfiguration

(1) Klicken Sie mit der rechten Maustaste auf das Projekt ––>Eigenschaften––>PyDev-PYTHONPATH auswählen–>Quellordner hinzufügen (wählen Sie die Projektdatei aus). Pfad zum Hinzufügen zum Projektcode:

(2) Konfigurieren Sie das Pydev-Projekt:

Wählen Sie den Namen des Pydev-Projekts aus. –> Durchsuchen Sie den Projektnamen und das Hauptmodul, wählen Sie „manage.py“ für „Hauptmodul“ aus. Geben Sie im Bereich „Erweitern“ runserver --noreload in die Argumente ein und fügen Sie das folgende Arbeitsverzeichnis zu Ihrem Basisverzeichnis hinzu.

2. Die Debug-Konfiguration des Django-Projekts

ähnelt der Entwicklungskonfiguration, es wurden jedoch zwei Umgebungsvariablen hinzugefügt:
( 1)Rechtsklick auf das Projekt –>Debuggen als –>Dialogfeld „Debuggen“ öffnen.
(2) Wählen Sie im Hauptfenster das Projekt aus, in dem sich manage.py befindet, und wählen Sie im Hauptmodul den Dateispeicherort aus, in dem sich manage.py befindet.
(3) Geben Sie runserver --noreload in den Argumenten ein.
(4)DJANGO_SETTINGS_MODULE=settings,PYTHONPATH=$PWD in der Umgebung hinzufügen.

3. Pylint konfigurieren

1. Einführung in Pylint

Pylint wird hauptsächlich verwendet, um Ihren PY-Code zu analysieren, Fehler herauszufinden und bereitzustellen Ein PYTHON-Modul, das Ihnen Hinweise gibt und Ihnen auch einige Hinweise zum Codierungsstil geben kann. Kurz gesagt besteht seine Funktion darin, Ihren Code dem in PEP 008 (http://www.python.org/dev/peps/pep-0008/) Titel: Style Guide for Python Code beschriebenen Codestil anzunähern, damit Ihr Der Code ist vereinheitlicht und besser lesbar.

2. Pylint herunterladen und installieren

pylint, logilab-astng, logilab-common Die Installationsmethode ist die gleiche wie die Installation von Django. Das heißt, verwenden Sie einfach
python setup.py install direkt.

3. Konfigurieren Sie die Verwendung von Pylint
(1)Fenster -> Pydev -> wie „C: /Python25/Lib/site-packages/pylint/lint.py“

(2) Und fügen Sie im letzten Bearbeitungsfeld Parameter hinzu, um die Ausgabe von Pylint zu begrenzen.

--persistent=n --comment=n

--disable-msg=C0103,C0301,W0312,W0511,W0232,E1101

(3) Projekt->Eigenschaften->PyDev-PYTHONPATH Fügen Sie das Quelldateiverzeichnis des Projekts zu „Projektquellordner“ hinzu.
                                       (4) Wählen Sie Projekt->Automatisch erstellen, damit Pylint beim Speichern von Änderungen automatisch den Code im Projekt überprüft. Andernfalls müssen Sie Strg+B verwenden, um Pylint manuell zu erstellen und auszulösen.

Referenzdokumentation:

http://pydev.org/manual_adv_pylint.html

Verwandte Empfehlungen:

So verwenden Sie Pylint zur Standardisierung des Python-Codestils (von IBM)_python

Python Das Code-Inspektionstool Pylint macht Ihr Python standardisierter

Das obige ist der detaillierte Inhalt vonSo verwenden Sie Pylint in Python (Pylint-Code-Inspektion)_python. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!