Formatierung von Python in VS Code

Formatierung macht Quellcode für Menschen leichter lesbar. Durch die Erzwingung bestimmter Regeln und Konventionen wie Zeilenabstände, Einrückungen und Abstände um Operatoren wird der Code visuell organisierter und verständlicher. Ein Beispiel finden Sie auf der autopep8-Seite. Beachten Sie, dass die Formatierung die Funktionalität des Codes selbst nicht beeinflusst.

Linting hilft, Fehler zu vermeiden, indem Code auf gängige syntaktische, stilistische und funktionale Fehler sowie unkonventionelle Programmierpraktiken analysiert wird. Obwohl es geringfügige Überschneidungen zwischen Formatierung und Linting gibt, ergänzen sich die beiden Funktionen.

Formatierer auswählen

Suchen Sie im VS Code Marketplace nach der Formatiererweiterung Ihrer Wahl.

Microsoft veröffentlicht die folgenden Formatiererweiterungen

Formatiererweiterungen, die von der Community angeboten werden

Darüber hinaus gibt es Formatiererweiterungen, die die Sortierung von Importen unterstützen

Hinweis: Wenn Sie Ihren bevorzugten Formatierer nicht in der obigen Tabelle oder im Marketplace finden, können Sie über eine Erweiterung Unterstützung dafür hinzufügen. Sie können die Python Extension Template verwenden, um neue Python-Tools in VS Code zu integrieren.

Standardformatierer festlegen

Nachdem Sie eine Formatiererweiterung installiert haben, können Sie diese als Standardformatierer für Python-Dateien in VS Code auswählen, indem Sie die folgenden Schritte ausführen

1. Öffnen Sie eine Python-Datei in VS Code.
2. Klicken Sie mit der rechten Maustaste auf den Editor, um das Kontextmenü anzuzeigen.
3. Wählen Sie Mit... formatieren.
4. Wählen Sie im Dropdown-Menü Standardformatierer konfigurieren....
5. Wählen Sie Ihre bevorzugte Formatiererweiterung aus der Liste aus.

Alternativ können Sie ihn als Standardformatierer für alle Python-Dateien festlegen, indem Sie "editor.defaultFormatter" in Ihrer Benutzer-settings.json-Datei unter einem [python]-Geltungsbereich setzen. Sie können settings.json mit dem Befehl Preferences: Open User Settings (JSON) öffnen.

Um beispielsweise Black Formatter als Standardformatierer festzulegen, fügen Sie die folgende Einstellung zu Ihrer Benutzer-settings.json-Datei hinzu

  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter"
  }

Um eine Formatiererweiterung als Import-Sorter festzulegen, können Sie Ihre Präferenz unter "editor.codeActionsOnSave" in Ihrer Benutzer-settings.json-Datei oder Ihrer Arbeitsbereichs-settings.json-Datei unter einem [python]-Geltungsbereich festlegen. Sie können diese settings.json-Dateien mit den Befehlen Preferences: Open User Settings (JSON) und Preferences: Open Workspace Settings (JSON) öffnen. Dies aktiviert die Import-Sortierung beim Speichern für alle Python-Dateien.

Um beispielsweise Ruff als Ihren bevorzugten Import-Sorter festzulegen, können Sie die folgende Einstellung zu Ihrer Benutzer-settings.json- oder Ihrer Arbeitsbereichs-settings.json-Datei hinzufügen

{
  "[python]": {
    "editor.codeActionsOnSave": {
      "source.organizeImports.ruff": "explicit"
    }
  }
}

Code formatieren

Sie können Ihren Code formatieren, indem Sie mit der rechten Maustaste auf den Editor klicken und Dokument formatieren auswählen oder die Tastenkombination ⇧⌥F (Windows Shift+Alt+F, Linux Ctrl+Shift+I) verwenden.

Sie können auch die folgende Einstellung zu Ihrer Benutzer-settings.json-Datei hinzufügen, um die Formatierung beim Speichern für Ihren Code zu aktivieren

  "[python]": {
    "editor.formatOnSave": true
  }

Allgemeine Formatierungseinstellungen

Sie können im README jeder Formatiererweiterung weitere Details zu den unterstützten Einstellungen finden. Die folgenden Einstellungen werden von den meisten Formatiererweiterungen unterstützt

Formatierungsprobleme beheben

Wenn die Formatierung fehlschlägt, überprüfen Sie die folgenden möglichen Ursachen

Hinweis: Wenn Sie Ihren bevorzugten Formatierer nicht oben aufgeführt finden, können Sie über eine Erweiterung Unterstützung dafür hinzufügen. Die Python Extension Template erleichtert die Integration neuer Python-Tools in VS Code.

Nächste Schritte

• Debugging - Erfahren Sie, wie Sie Python lokal und remote debuggen.
• Testen - Konfigurieren Sie Testumgebungen und entdecken, führen Sie Tests aus und debuggen Sie sie.
• Grundlegende Bearbeitung – Erfahren Sie mehr über den leistungsstarken VS Code-Editor.
• Code-Navigation – Schnelles Bewegen durch Ihren Quellcode.
• Python Extension Template - Erstellen Sie eine Erweiterung, um Ihren bevorzugten Linter in VS Code zu integrieren.