Comment configurer VSCode pour le formatage automatique et le peluchage en Python

Guide de configuration automatique du formatage et de l'inspection du code VSCode Python

VSCode est devenu l'éditeur de code de choix pour de nombreux développeurs Python en raison de sa flexibilité et de ses fonctionnalités puissantes, mais ce n'est que l'un des nombreux outils d'édition de code et d'automatisation. En fonction du flux de travail, les développeurs peuvent préférer d'autres IDE ou éditeurs comme PyCharm, Sublime Text ou même Vim. Ce guide se concentre sur VSCode, montrant comment configurer le formatage automatique et l'inspection du code, mais des principes similaires s'appliquent à d'autres outils.

Les développeurs Python s'efforcent d'obtenir un code concis et lisible, et des outils comme VSCode simplifient ce processus grâce au formatage automatique et à l'inspection du code. Dans ce guide, nous allons vous montrer comment configurer le formatage VSCode pour Python et l'inspection du code à l'aide de fichiers de configuration et de commandes CLI pour garantir l'automatisation et éviter toute intervention manuelle.

Pourquoi avez-vous besoin d'un formatage et d'une vérification automatiques du code ?

• Formatage automatique Garantissez un style de code cohérent, conforme à la PEP 8 et gagnez du temps sur les ajustements manuels.
L'
• Inspection du code identifie dès le début les erreurs de syntaxe, les importations inutilisées et d'autres problèmes potentiels.

Ensemble, les deux contribuent à maintenir un code de haute qualité et à réduire les erreurs.

Outils nécessaires au formatage et à l'inspection du code

Pour formater et inspecter efficacement le code Python, vous avez besoin des outils suivants :

Noir (outil de formatage)

• Objectif : Black est un puissant outil de formatage de code qui garantit automatiquement un style de code cohérent et la conformité aux spécifications PEP 8.
• Fonctions principales : Simplifiez le formatage du code sans ajustements manuels.
• Installer : Exécuter pip install black

pylint (outil de vérification de code)

• Objectif : pylint analyse le code Python pour identifier les erreurs, appliquer les normes de codage et mettre en évidence les problèmes potentiels tels que les importations inutilisées ou les variables non définies.
• Fonctionnalités clés : Détectez les erreurs et appliquez les meilleures pratiques.
• Installer : Exécuter pip install pylint

Configuration automatisée à l'aide de Black et pylint

Pour rationaliser davantage votre flux de travail, vous pouvez configurer VSCode pour formater et vérifier automatiquement le code lors de l'enregistrement. Cela élimine le besoin de vérification manuelle et garantit que votre code reste cohérent sans effort supplémentaire.

Activer le formatage automatique et l'inspection du code lors de l'enregistrement

Ajoutez les options suivantes à votre fichier settings.json :

{
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll": true
  }
}

• "editor.formatOnSave" : Formate automatiquement le code lors de l'enregistrement du fichier.
• "editor.codeActionsOnSave" : exécute tous les correctifs d'inspection de code disponibles lors de l'enregistrement, garantissant ainsi que tous les problèmes identifiés sont automatiquement résolus.

Vous pouvez utiliser settings.json fichiers de configuration pour définir les préférences de formatage et d'inspection du code sans avoir à ajuster manuellement les paramètres VSCode.

Mettre à jour les paramètres VSCode par programme

Créez ou mettez à jour des .vscode fichiers dans votre répertoire settings.json :

{
  "python.formatting.provider": "black",
  "editor.formatOnSave": true,
  "python.linting.enabled": true,
  "python.linting.pylintEnabled": true,
  "python.formatting.blackArgs": ["--line-length=79"],
  "python.linting.pylintArgs": ["--disable=C0114,C0115,C0116"]
}

Cela activera Black en tant que formateur, définira la longueur de ligne à 79 caractères, activera l'inspection du code pylint et désactivera les avertissements de docstring spécifiques.

Ajouter des extensions recommandées

Pour améliorer la cohérence du code à l'échelle de l'équipe et garantir que tous les membres utilisent les outils nécessaires, vous pouvez ajouter des extensions.json fichiers directement à votre projet :

{
  "recommendations": [
    "ms-python.python",
    "ms-python.black-formatter",
    "ms-python.pylint"
  ]
}

Enregistrez ce fichier dans le répertoire .vscode et nommez-le extensions.json.

Représentation visuelle des fichiers de configuration

Voici une répartition des fichiers et leurs utilisations :

文件	用途
.vscode/settings.json	定义项目特定的格式化和代码检查行为设置。
.vscode/extensions.json	推荐团队范围内的开发 IDE 扩展。

Exemple de structure de répertoire

<code>.vscode/
├── settings.json   # 配置格式化和代码检查行为
├── extensions.json # 推荐 VSCode 扩展</code>

Testez votre configuration

Exemples de formatage et d'inspection de code

1. Problèmes de codage :

   import os

   def example_function():
           print ( "Hello World" )
   print(undefined_variable)

2. Après avoir exécuté Black :

   import os

   def example_function():
       print("Hello World")

   print(undefined_variable)

3. Après avoir exécuté pylint : l'avertissement suivant sera marqué :
   • Import inutilisé : os
   • Variable non définie : variable_undéfinie

Utilisez Black et pylint ensemble

Pourquoi utiliser Black et pylint ensemble ?

• Le noir garantit automatiquement un formatage cohérent et la conformité à la PEP 8.
• pylint identifie les problèmes de code (par exemple, importations inutilisées, variables non définies) et applique les normes de codage.

Workflow utilisant ces deux outils

Mise à jour settings.json :

{
  "python.formatting.provider": "black",
  "editor.formatOnSave": true,
  "python.linting.enabled": true,
  "python.linting.pylintEnabled": true,
  "python.formatting.blackArgs": ["--line-length=79"],
  "python.linting.pylintArgs": ["--disable=C0114,C0115,C0116"]
}

Conclusion

Configurez VSCode pour le formatage automatique et la vérification du code à l'aide des commandes settings.json et CLI pour garantir un flux de travail de développement transparent et cohérent. En évitant les étapes manuelles et en tirant parti de l'automatisation, vous pouvez vous concentrer sur l'écriture de code Python de haute qualité sans vous soucier des problèmes de formatage ou d'inspection du code.

Bonne programmation !

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!