Comment utiliser pylint en python (inspection du code pylint)_python

Pylint fournit un moyen simple d'analyser le code Python, et sa haute configurabilité permet aux personnes d'un service d'utiliser facilement un style de codage unifié. Cet article expliquera comment Pylint peut standardiser le code Python grâce à une introduction théorique et à des exemples d'analyse

1 Qu'est-ce que Pylint

Pylint est un outil d'analyse de code Python qui analyse le code Python. Erreurs dans le code, recherche de code qui ne répond pas aux normes de style de codage et présente des problèmes potentiels.
Pylint est un outil Python. En plus des fonctions des outils d'analyse de code ordinaires, il fournit plus de fonctions : comme vérifier la longueur d'une ligne de code, si le nom de la variable est conforme à la norme de dénomination et si une valeur déclarée est définie. l'interface est réellement implémentée, etc.
Un grand avantage de Pylint est qu'il est hautement configurable et personnalisable, et qu'il est facile d'écrire de petits plug-ins pour ajouter des fonctionnalités.

Si vous exécutez Pylint deux fois, il affichera les résultats de l'exécution en cours et de la dernière, vous permettant de voir si la qualité du code s'est améliorée. Pylint est actuellement également intégré au plug-in pydev d'Eclipse.

2. Installation de Pylint sous Linux

1 Sous Linux, installez d'abord le package Python (supérieur à la version 2.2) et définissez-le dans la variable d'environnement $PATH. Ajoutez le chemin d'accès au fichier exécutable Python.
2. Téléchargez les packages de Pylint, logilab-astng (version >= 0.14) et logilab-common (version >= 0.13), et utilisez tar zxvf *.tar.gz pour décompresser ces packages.
3. Entrez les dossiers dans lesquels logilab-astng, logilab-common et Pylint ont été extraits dans l'ordre, et exécutez la commande Python setup.py install pour installer.
4. Une fois l'installation terminée, vous pouvez appeler Pylint via pylint [options] module_or_package.

3. Installation de Pylint sous Windows

1. Installez le package Python (supérieur à la version 2.2), cliquez avec le bouton droit sur l'icône Poste de travail sur le bureau, sélectionnez Propriétés, Avancé, Variables d'environnement et ajoutez le chemin d'installation de Python à $PATH, tel que C:Python26.
2. Utilisez l'outil de décompression pour décompresser tous les packages.
3. Ouvrez la fenêtre de ligne de commande, utilisez cd pour entrer dans l'ordre les dossiers décompressés de logilab-astng, logilab-common et Pylint, et exécutez la commande python setup.py install pour installer.
4. Une fois l'installation terminée, un dossier Scripts apparaîtra dans le chemin d'installation de Python, qui contient certains scripts bat, tels que pylint.bat, etc.
5. Afin d'éviter de saisir le chemin complet lors de l'appel de pylint.bat, créez un fichier de redirection de pylint.bat dans le répertoire d'installation de Python. Il s'agit d'un fichier texte brut pylint.bat, qui contient pylint.bat Actual. chemin, tel que : C:\Python26Scriptspylint.bat.
6. Une fois l'installation terminée, vous pouvez appeler Pylint via pylint [options] module_or_package.

4. Utilisez pylint

Utilisez Pylint pour vérifier le code d'un module module.py :

1 Entrez le dossier où se trouve le module. situé, Running

pylint [options] module.py

fonctionnera toujours car le répertoire de travail actuel sera automatiquement ajouté au chemin Python.

2. Sans saisir le dossier où se trouve le module, exécutez

pylint [options] directory/module.py

Cette méthode d'appel peut fonctionner lorsque les conditions suivantes sont remplies : le répertoire est un Python. Le package (par exemple, contenant un fichier __init__.py) ou le répertoire est ajouté au chemin de recherche de Python.

Utilisez Pylint pour vérifier le code d'un package :

1. Entrez le dossier où se trouve le package et exécutez

pylint [options] pakage

Ceci call Cette méthode fonctionnera toujours car le répertoire de travail actuel sera automatiquement ajouté au chemin Python.

2. Sans saisir le dossier où se trouve le package, exécutez

pylint [options] directory/ pakage

Dans ce cas, cela peut fonctionner lorsque les conditions suivantes sont remplies : le répertoire est ajouté dans le chemin Python. Par exemple, sous Linux, exportez le répertoire PYTHONPATH=$PYTHONPATH:.
De plus, pour les machines sur lesquelles le package tkinter est installé, vous pouvez utiliser la commande pylint-gui pour ouvrir une interface graphique simple, saisir ici le nom du module ou du package (les règles sont les mêmes que la ligne de commande), cliquez sur Exécuter et la sortie de Pylint sera dans l'interface graphique affichée.

5. Paramètres de ligne de commande courants de Pylint

-h,--help : Affiche toutes les informations d'aide.
--generate-rcfile : Vous pouvez utiliser pylint --generate-rcfile pour générer un exemple de fichier de configuration. Vous pouvez utiliser la redirection pour enregistrer ce fichier de configuration pour une utilisation ultérieure. Vous pouvez également ajouter d'autres options devant afin que les valeurs de ces options soient incluses dans le fichier de configuration généré. Par exemple : pylint -- persistent=n --generate-rcfile > pylint.conf, vous pouvez voir que persistent=no n'est plus sa valeur par défaut de yes.
--rcfile= : Spécifiez un fichier de configuration. Mettez la configuration que vous utilisez dans le fichier de configuration, ce qui non seulement standardise votre propre code, mais facilite également le partage de ces spécifications avec d'autres.
-i , --include-ids= : incluez l'identifiant du message dans la sortie, puis utilisez pylint --help-msg= ces informations d'erreur afin que l'erreur puisse être localisée spécifiquement.
-r , --reports= : La valeur par défaut est y, ce qui signifie que la sortie de Pylint inclut non seulement la partie analyse du code source, mais également la partie rapport.
--files-output= : Affichez le message de chaque module/package dans un fichier nommé pylint_module/package [txt|html]. html] fichier. La valeur par défaut est la sortie à l'écran et non dans un fichier.
-f , --output-format= : Définissez le format de sortie. Les formats pouvant être sélectionnés sont texte, analysable, colorisé, msvs (visual studio) et html. Le format de sortie par défaut est le texte.
--disable-msg= : Désactivez les messages avec les identifiants spécifiés. Par exemple, si la sortie contient le message d'avertissement W0402, si vous ne souhaitez pas qu'il apparaisse dans la sortie, vous pouvez utiliser --. Disable-msg= W0402

6. Sortie Pylint

Le format de sortie par défaut de Pylint est le format de texte brut, qui peut être transmis -f pour spécifier d'autres formats de sortie tels que html, etc.

Il y a deux parties dans la sortie de Pylint : la partie analyse du code source et la partie rapport.
Partie analyse du code source :
Pour chaque module Python, le résultat Pylint affiche d'abord quelques caractères "*", suivis du nom du module, puis une série de messages. Le format du message est le suivant. : __MESSAGE_TYPE : LINE_NUM:[OBJECT :] MESSAGE__ MESSAGE_TYPE a les types suivants :

(C) Convention. Viole les normes de style de codage
(R) Refactoring. Code très mal écrit.
(W) Attention. Quelques questions spécifiques à Python.
(E) Erreur. Très probablement un bug dans le code.
(F) Erreur fatale. Une erreur qui empêche Pylint de continuer à fonctionner.

Section Rapport :

Une fois l'analyse du code source terminée, il y aura une série de rapports, chaque rapport se concentrant sur certains aspects du projet, comme chacun Le nombre de messages de différentes catégories, les dépendances des modules, etc.
Plus précisément, le rapport comprendra les aspects suivants : Le nombre de modules vérifiés. Pour chaque module, le pourcentage d'erreurs et d'avertissements.
Par exemple, il y a deux modules A et B. Si un total de 4 erreurs sont détectées, 1 erreur est en A et 3 erreurs sont en B, alors le pourcentage d'erreurs en A est de 25 %, et le pourcentage de les erreurs en B sont de 25%. Le pourcentage est de 75%. Le nombre total d'erreurs et d'avertissements.

Comment utiliser pylint en python

Sous Eclipse IDE, ouvrez la boîte de dialogue Fenêtre->Préférences... et sélectionnez " PyDev" -> "Interpreter Python ", cliquez sur le bouton Nouveau, sélectionnez Python.exe dans le chemin d'installation de Python, puis une boîte de dialogue apparaîtra vous demandant de vérifier le système PYTHONPATH. J'ai sélectionné les deux, donc cela ne devrait pas avoir d'importance. Cliquez enfin sur OK pour quitter.

1. Développement et configuration du projet Django

1. Établir le projet PyDev

Eclipse IDE——>Fichier——>Nouveau— —>Autre——>Pydev——>Sélectionner un projet Pydev——>Nommer un projet (tel qu'une démo)——>Sélectionner un chemin, tel que E:/work——>Choisir le Python qui vous convient Version (la mienne est 2.5) -> Décochez la case ci-dessous et ne créez pas le fichier src -> Terminer.

2. Créer un projet Django

(1) django-admin.py startproject démo. (Il semble que vous ne puissiez pas utiliser django-admin.py directement sur la ligne de commande, mais que vous deviez utiliser C:/Python26/Scripts/django-admin.py. Plus tard, j'ai appris que vous deviez ajouter C:/Python26/Scripts au chemin .)

(2) Copiez le répertoire du projet Django généré dans le répertoire sous le projet qui vient d'être créé par Eclipse. Revenez tout à l'heure à l'IDE Elicpse——> Actualisez la démo du projet nouvellement créé dans la vue Package PyDev pour voir le projet Django. L'ajout et la suppression de fichiers et de répertoires peuvent être effectués via le menu contextuel.

3. Configuration d'ingénierie du projet Django

(1) Cliquez avec le bouton droit sur le projet——>Propriétés——>Sélectionnez PyDev-PYTHONPATH——>Ajoutez le dossier source (sélectionnez le fichier du projet chemin à ajouter au code du projet——> OK

(2) Configurez le projet Pydev :

Sélectionnez le nom du projet Pydev——>Exécuter en tant que——>Ouvrir la boîte de dialogue d'exécution——>Exécution Python——>Clic droit sur Nouveau——>Écrivez le nom du projet dans le panneau principal et chargez-le via Parcourez le nom du projet et le module principal, sélectionnez manage.py pour le module principal——> Dans le panneau Augmentation, entrez runserver --noreload dans les arguments et ajoutez le répertoire de travail suivant à votre répertoire de base.

2. La configuration de débogage du projet Django

est similaire à la configuration de développement, mais deux variables d'environnement sont ajoutées. Les opérations spécifiques sont les suivantes :
( 1) projet Cliquez avec le bouton droit ——> Déboguer en tant que ——> ouvrir la boîte de dialogue de débogage.
(2) Dans la fenêtre principale, sélectionnez le projet où se trouve Manage.py et dans le module principal, sélectionnez l'emplacement du fichier où se trouve Manage.py.
(3) Entrez runserver --noreload dans les arguments.
(4)Ajoutez DJANGO_SETTINGS_MODULE=settings,PYTHONPATH=$PWD dans l'environnement.

3. Configurer pylint

1. Introduction à pylint

Pylint est principalement utilisé pour analyser votre code PY, découvrir les erreurs et fournir Un module PYTHON qui vous donne des astuces et peut également vous donner des astuces de style de codage. En bref, sa fonction est de rapprocher votre code du style de code décrit dans PEP 008 (http://www.python.org/dev/peps/pep-0008/) Titre : Guide de style pour le code Python, afin que votre le code est unifié et plus lisible.

2. Téléchargez et installez pylint

pylint, logilab-astng, logilab-common La méthode d'installation est la même que pour l'installation de Django. Autrement dit, utilisez simplement
python setup.py install directement.

3. Configurez l'utilisation de pylint
(1)Fenêtre -> préférences -> Pydev ->, sélectionnez "Utiliser pylint ?", puis entrez l'adresse de lint.py, tel que "C: /Python25/Lib/site-packages/pylint/lint.py"

(2) Et ajoutez des paramètres dans la dernière zone d'édition pour limiter la sortie de pylint.

--persistent=n --comment=n

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

(3) Projet->Propriétés->PyDev-PYTHONPATH Ajoutez le répertoire du fichier source du projet aux « Dossiers sources du projet ».
                                       (4) Sélectionnez Projet->Construire automatiquement, afin que pylint vérifie automatiquement le code du projet lors de l'enregistrement des modifications, sinon vous devez utiliser Ctrl+B pour créer et déclencher manuellement pylint.

Documentation de référence :

http://pydev.org/manual_adv_pylint.html

Recommandations associées :

Comment utiliser Pylint pour standardiser le style de code Python (d'IBM)_python

python L'outil d'inspection de code pylint rend votre python plus standardisé

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!