Vor-, Nachteile und Gefahren von PyLint

Holen Sie das Beste aus PyLint heraus.

Klopf an die Tafel: PyLint ist eigentlich ziemlich gut!

„PyLint kann Ihr Leben retten“ ist übertrieben, aber nicht so übertrieben, wie Sie vielleicht denken. PyLint kann Sie vor sehr schwer zu findenden und komplexen Fehlern bewahren. Im schlimmsten Fall spart es nur Testlaufzeit. Im besten Fall hilft es Ihnen, komplexe Fehler in der Produktion zu vermeiden.

Vorteile

Es ist mir peinlich zu sagen, wie häufig das vorkommt. Testnamen sind immer so seltsam: Der Name interessiert niemanden und oft lässt sich kein natürlicher Name finden. Zum Beispiel der folgende Code:

def test_add_small():# Math, am I right?assert 1 + 1 == 3def test_add_large():assert 5 + 6 == 11def test_add_small():assert 1 + 10 == 11

Der Test wird wirksam:

collected 2 items test.py .. 2 passed

Aber hier ist die Sache: Wenn Sie den Namen eines Tests überschreiben, überspringt das Test-Framework den Test problemlos!

In Wirklichkeit können diese Dateien Hunderte von Zeilen enthalten und die Person, die den neuen Test hinzufügt, kennt möglicherweise nicht alle Namen. Alles sieht gut aus, bis man sich die Testausgabe genauer ansieht.

Das Schlimmste daran ist, dass die Hinzufügung abgedeckter Tests, der durch abgedeckte Tests verursachte Schaden und Welleneffekte Tage, Monate oder sogar Jahre dauern kann, bis man sie entdeckt.

PyLint wird es finden

Wie ein guter Freund kann PyLint Ihnen helfen.

test.py:8:0: E0102: function already defined line 1 (function-redefined)

Nachteile

Genau wie in der Sitcom der 90er Jahre: Je mehr Sie über PyLint erfahren, desto mehr Fragen erhalten Sie. Hier ist der reguläre Code für ein Aktienmodellierungsprogramm:

"""Inventory abstractions"""import attrs@attrs.defineclass Laptop:"""A laptop"""ident: strcpu: str

Aber PyLint scheint seine eigenen Meinungen zu haben (wahrscheinlich in den 90er Jahren gebildet) und scheut sich nicht, sie als Tatsachen darzustellen:

$ pylint laptop.py | sed -n '/^laptop/s/[^ ]*: //p'R0903: Too few public methods (0/2) (too-few-public-methods)

Gefahren

Haben Sie jemals darüber nachgedacht? in a Ihre eigenen unbegründeten Meinungen zu einem Tool hinzufügen, das von Millionen verwendet wird? PyLint hat 12 Millionen Downloads pro Monat.

„Wenn Sie zu wählerisch sind, werden die Leute die Prüfung stornieren“ – Dies ist das PyLint-GitHub-Problem 6987, das am 3. Juli 2022 angesprochen wurde.

Es ist die Einstellung zum Hinzufügen eines Tests, der viele falsch positive Ergebnisse liefern kann. Hmm“.

Lassen Sie es für sich arbeiten

PyLint ist großartig, aber Sie müssen damit vorsichtig sein. Damit PyLint für Sie funktioniert, empfehle ich die folgenden drei Dinge:

1. Feste Version

Pinnen Sie die PyLint-Version, die Sie verwenden, um Überraschungen zu vermeiden!

Definieren Sie in Ihrer ​​.toml​​ Datei:

[project.optional-dependencies]pylint = ["pylint"]

Definieren Sie im Code:

from unittest import mock

Dies entspricht dem folgenden Code:

# noxfile.py...@nox.session(python=VERSIONS[-1])def refresh_deps(session):"""Refresh the requirements-*.txt files"""session.install("pip-tools")for deps in [..., "pylint"]:session.run("pip-compile","--extra",deps,"pyproject.toml","--output-file",f"requirements-{deps}.txt",)

2. Standardmäßig deaktivieren

Deaktivieren Sie alle Prüfungen und aktivieren Sie dann diejenigen, von denen Sie glauben, dass sie falsch positiv sind Rate Hoch. (Nicht nur das Falsch-Negativ/Falsch-Positiv-Verhältnis!)

# noxfile.py...@nox.session(python="3.10")def lint(session):files = ["src/", "noxfile.py"]session.install("-r", "requirements-pylint.txt")session.install("-e", ".")session.run("pylint","--disable=all",*(f"--enable={checker}" for checker in checkers)"src",)

3. Checker

Hier sind die Checker, die ich mag. Verbessern Sie die Projektkonsistenz und vermeiden Sie offensichtliche Fehler.

checkers = ["missing-class-docstring","missing-function-docstring","missing-module-docstring","function-redefined",]

PyLint verwenden

Sie können PyLint nur für die guten Teile verwenden. Führen Sie es aus Gründen der Konsistenz in CI aus und verwenden Sie gängige Prüfprogramme.

Lassen Sie den schlechten Teil weg: Die Prüfung ist standardmäßig deaktiviert.

Gefährliche Teile vermeiden: Feste Version, um Überraschungen zu vermeiden.

Das obige ist der detaillierte Inhalt vonVor-, Nachteile und Gefahren von PyLint. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!