Avantages, inconvénients et dangers de PyLint

Tirez le meilleur parti de PyLint.

Frapper au tableau : PyLint est en fait plutôt bon !

« PyLint peut vous sauver la vie » est une exagération, mais pas autant qu'on pourrait le penser. PyLint peut vous éviter des défauts très difficiles à trouver et complexes. Au pire, cela ne fait que gagner du temps d’exécution des tests. Au mieux, cela vous aide à éviter des erreurs complexes en production.

Pros

Je suis gêné de dire à quel point c'est courant. Les noms de tests sont toujours tellement bizarres : personne ne se soucie du nom, et souvent un nom naturel ne peut pas être trouvé. Par exemple, le code suivant :

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

Le test prend effet :

collected 2 items test.py .. 2 passed

Mais voici le problème : si vous remplacez le nom d'un test, le framework de test ignorera volontiers le test !

En réalité, ces fichiers peuvent contenir des centaines de lignes, et la personne qui ajoute le nouveau test peut ne pas connaître tous les noms. Tout semble bien jusqu'à ce que l'on examine de plus près le résultat du test.

Le pire, c'est l'ajout de tests couverts, les dommages causés par les tests couverts et les effets d'entraînementpeuvent prendre des jours, des mois, voire des années à découvrir.

PyLint le trouvera

Comme un bon ami, PyLint peut vous aider.

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

Inconvénients

Tout comme la sitcom des années 90, plus vous en apprenez sur PyLint, plus vous recevez de questions. Voici le code habituel d'un programme de modélisation boursière :

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

Mais PyLint semble avoir ses propres opinions (probablement formées dans les années 90) et n'a pas peur de les énoncer comme des faits :

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

Dangers

Y avez-vous déjà pensé dans un Ajouter vos propres opinions non fondées à un outil utilisé par des millions de personnes ? PyLint compte 12 millions de téléchargements par mois.

"Si vous êtes trop pointilleux, les gens annuleront le chèque" — Il s'agit du numéro 6987 de PyLint GitHub, soulevé le 3 juillet 2022

C'est une attitude envers l'ajout d'un test qui peut avoir de nombreux faux positifs .. “ Hmm”.

Faites que cela fonctionne pour vous

PyLint est génial, mais vous devez y faire attention. Pour que PyLint fonctionne pour vous, voici les trois choses que je recommande :

1 Version fixe

Épinglez la version de PyLint que vous utilisez pour éviter toute surprise !

Définissez dans votre ​​.toml​​ fichier :

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

Définissez en code :

from unittest import mock

Cela correspond au code suivant :

# 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. Désactivez par défaut

Désactivez toutes les vérifications, puis activez celles qui, selon vous, ont un faux positif taux élevé. (Pas seulement le ratio faux négatifs/faux positifs !)

# 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. Dames

Voici les dames que j'aime. Améliorez la cohérence du projet et évitez les erreurs évidentes.

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

Utilisation de PyLint

Vous pouvez simplement utiliser PyLint pour les bonnes parties. Exécutez-le dans CI pour plus de cohérence et utilisez des vérificateurs courants.

Supprimez la mauvaise partie : vérificateur désactivé par défaut.

Évitez les pièces dangereuses : Version corrigée pour éviter les surprises.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!