So konfigurieren Sie VSCode für die automatische Formatierung und Linting in Python

VSCode Python-Code-Konfigurationsanleitung zur automatischen Formatierung und Codeprüfung

VSCode ist aufgrund seiner Flexibilität und leistungsstarken Funktionen für viele Python-Entwickler zum Code-Editor der Wahl geworden, aber es ist nur eines von vielen Tools zur Codebearbeitung und -automatisierung. Abhängig vom Workflow bevorzugen Entwickler möglicherweise andere IDEs oder Editoren wie PyCharm, Sublime Text oder sogar Vim. Dieser Leitfaden konzentriert sich auf VSCode und zeigt, wie man die automatische Formatierung und Codeprüfung einrichtet. Ähnliche Prinzipien gelten jedoch auch für andere Tools.

Python-Entwickler streben nach prägnantem und lesbarem Code, und Tools wie VSCode vereinfachen diesen Prozess durch automatische Formatierung und Codeprüfung. In diesem Leitfaden zeigen wir Ihnen, wie Sie VSCode für die Python-Formatierung und Code-Inspektion mithilfe von Konfigurationsdateien und CLI-Befehlen konfigurieren, um die Automatisierung sicherzustellen und manuelle Eingriffe zu vermeiden.

Warum benötigen Sie eine automatische Formatierung und Codeprüfung?

• Automatische Formatierung Sorgen Sie für einen konsistenten Codestil, die Einhaltung von PEP 8 und sparen Sie Zeit bei manuellen Anpassungen.
• Code-Inspektion erkennt Syntaxfehler, ungenutzte Importe und andere potenzielle Probleme frühzeitig.

Zusammen tragen beide dazu bei, qualitativ hochwertigen Code aufrechtzuerhalten und Fehler zu reduzieren.

Für die Formatierung und Codeprüfung erforderliche Tools

Um Python-Code effektiv zu formatieren und zu überprüfen, benötigen Sie die folgenden Tools:

Schwarz (Formatierungstool)

• Zweck: Black ist ein leistungsstarkes Codeformatierungstool, das automatisch einen konsistenten Codestil und die Einhaltung der PEP 8-Spezifikationen gewährleistet.
• Hauptfunktionen: Vereinfachen Sie die Codeformatierung ohne manuelle Anpassungen.
• Installieren: Ausführen pip install black

Pylint (Tool zur Codeprüfung)

• Zweck: pylint analysiert Python-Code, um Fehler zu identifizieren, Codierungsstandards durchzusetzen und potenzielle Probleme wie nicht verwendete Importe oder undefinierte Variablen hervorzuheben.
• Hauptfunktionen: Fehler erkennen und Best Practices durchsetzen.
• Installieren: Ausführen pip install pylint

Automatisierte Konfiguration mit Black und Pylint

Um Ihren Workflow weiter zu optimieren, können Sie VSCode so konfigurieren, dass Code beim Speichern automatisch formatiert und überprüft wird. Dadurch entfällt die Notwendigkeit einer manuellen Überprüfung und es wird sichergestellt, dass Ihr Code ohne zusätzlichen Aufwand konsistent bleibt.

Automatische Formatierung und Codeprüfung beim Speichern aktivieren

Fügen Sie Ihrer settings.json-Datei die folgenden Optionen hinzu:

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

• "editor.formatOnSave": Formatieren Sie den Code beim Speichern der Datei automatisch.
• "editor.codeActionsOnSave": Führt beim Speichern alle verfügbaren Code-Inspektion-Fixes aus und stellt so sicher, dass alle identifizierten Probleme automatisch behoben werden.

Sie können settings.json Konfigurationsdateien verwenden, um Formatierungs- und Code-Inspektion-Einstellungen zu definieren, ohne die VSCode-Einstellungen manuell anpassen zu müssen.

VSCode-Einstellungen programmgesteuert aktualisieren

Erstellen oder aktualisieren Sie .vscode-Dateien in Ihrem settings.json-Verzeichnis:

{
  "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"]
}

Dadurch wird Black als Formatierer aktiviert, die Zeilenlänge auf 79 Zeichen festgelegt, die Pylint-Code-Inspektion aktiviert und bestimmte Docstring-Warnungen deaktiviert.

Empfohlene Erweiterungen hinzufügen

Um die teamweite Codekonsistenz zu verbessern und sicherzustellen, dass alle Mitglieder die erforderlichen Tools verwenden, können Sie extensions.json Dateien direkt zu Ihrem Projekt hinzufügen:

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

Speichern Sie diese Datei im Verzeichnis .vscode und nennen Sie sie extensions.json.

Visuelle Darstellung der Konfigurationsdateien

Hier ist eine Aufschlüsselung der Dateien und ihrer Verwendung:

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

Beispiel für eine Verzeichnisstruktur

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

Testen Sie Ihre Konfiguration

Beispiele für Formatierung und Codeprüfung

1. Codierungsprobleme:

   import os

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

2. Nachdem Black ausgeführt wurde:

   import os

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

   print(undefined_variable)

3. Nach dem Ausführen von Pylint: Die folgende Warnung wird markiert:
   • Unbenutzter Import: os
   • Undefinierte Variable: undefinierte_Variable

Verwenden Sie Black und Pylint zusammen

Warum Black und Pylint zusammen verwenden?

• Schwarz sorgt automatisch für eine konsistente Formatierung und die Einhaltung von PEP 8.
• pylint identifiziert Codeprobleme (z. B. nicht verwendete Importe, undefinierte Variablen) und setzt Codierungsstandards durch.

Workflow mit diesen beiden Tools

Update 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"]
}

Fazit

Konfigurieren Sie VSCode für die automatische Formatierung und Codeprüfung mit settings.json und CLI-Befehlen, um einen nahtlosen und konsistenten Entwicklungsworkflow zu gewährleisten. Indem Sie manuelle Schritte vermeiden und die Automatisierung nutzen, können Sie sich auf das Schreiben von qualitativ hochwertigem Python-Code konzentrieren, ohne sich um Formatierungs- oder Codeüberprüfungsprobleme kümmern zu müssen.

Viel Spaß beim Programmieren!

Das obige ist der detaillierte Inhalt vonSo konfigurieren Sie VSCode für die automatische Formatierung und Linting in Python. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!