Lint du code Python

S’applique à :Visual Studio Visual Studio pour Mac Visual Studio Code

Le linting met en évidence les problèmes syntaxiques et stylistiques dans votre code source Python, ce qui vous permet souvent d’identifier et de corriger les erreurs de programmation subtiles ou les pratiques de codage non conventionnelles qui peuvent entraîner des erreurs. Par exemple, le linting détecte l’utilisation d’une variable non initialisée ou non définie, des appels à des fonctions non définies, des parenthèses manquantes, et même des problèmes plus subtils comme une tentative de redéfinition des types ou des fonctions intégrés. Le linting est différent de la mise en forme, car il analyse la façon dont le code s’exécute et détecte les erreurs, tandis que la mise en forme restructure seulement la façon dont le code s’affiche.

PyLint et mypy sont des outils largement utilisés qui recherchent les erreurs dans le code Python et encouragent les bons modèles de codage Python. Tous deux sont intégrés à Visual Studio pour les projets Python.

Exécuter un linter

Dans Visual Studio, cliquez avec le bouton droit sur un projet Python dans l’Explorateur de solutions et sélectionnez Python, puis choisissez Exécuter PyLint ou Exécuter Mypy :

Cette commande vous invite à installer le linter de votre choix dans votre environnement actif, s’il n’est pas déjà présent.

Les avertissements et erreurs de linting s’affichent dans la fenêtre Liste d’erreurs :

Un double-clic sur une erreur vous dirige directement vers le code source à l’origine du problème.

Définir les options de ligne de commande

Pylint et mypy offrent tous deux des options de ligne de commande afin de configurer les paramètres de linting pour votre projet.

Dans cet exemple, nous utilisons les options de ligne de commande de PyLint pour contrôler le comportement de PyLint avec un fichier de configuration .pylintrc. Vous pouvez placer ce type de fichier à la racine d’un projet Python dans Visual Studio, ou à un autre emplacement, en fonction de la portée d’application souhaitée pour ces paramètres (pour plus de détails, consultez les options de ligne de commande).

Par exemple, pour supprimer les avertissements « missing docstring » affichés sur l’image précédente avec un fichier .pylintrc dans un projet, effectuez ces étapes :

1. Sur la ligne de commande, accédez à la racine de votre projet (qui contient le fichier .pyproj), puis exécutez la commande ci-après pour générer un fichier de configuration commenté :

   pylint --generate-rcfile > .pylintrc
   

2. Dans la fenêtre Explorateur de solutions, cliquez avec le bouton droit sur votre projet, puis sélectionnez Ajouter>Élément existant. Accédez ensuite au nouveau fichier .pylintrc, sélectionnez-le, puis sélectionnez Ajouter.

3. Ouvrez le fichier. Celui-ci contient plusieurs paramètres que vous pouvez changer. Pour désactiver un avertissement, recherchez la section [MESSAGES CONTROL], puis localisez le paramètre disable dans cette section. Il existe une longue chaîne de messages spécifiques auxquels vous pouvez ajouter les avertissements de votre choix. Dans cet exemple, ajoutez ,missing-docstring (y compris la virgule de délimitation).

4. Enregistrez le fichier .pylintrc, puis réexécutez PyLint pour vérifier que les avertissements sont désormais supprimés.

   Conseil

   Pour utiliser un fichier .pylintrc à partir d’un partage réseau, créez une variable d’environnement nommée PYLINTRC avec la valeur du nom de fichier sur le partage réseau, en utilisant un chemin UNC (Universal Naming Convention) ou une lettre de lecteur mappée. Par exemple : PYLINTRC=\\myshare\python\.pylintrc.