Python-Formatierer

Was das Tool macht

Der Python-Formatierer schreibt Python-Code im weit verbreiteten Black-Stil um: einheitliche Einrückung, Leerzeichen um Operatoren, doppelte Anführungszeichen, zwei Leerzeilen zwischen Definitionen auf oberster Ebene und lange Zeilen, die an sinnvollen Stellen umbrochen werden.

Unter der Haube läuft der Formatierer von Ruff, dem schnellen, in Rust geschriebenen Python-Linter und -Formatierer, kompiliert zu WebAssembly. Die Ausgabe von Ruff stimmt fast Zeile für Zeile mit Black überein, daher wird hier formatierter Code vom Pre-Commit-Hook deines Projekts nicht noch einmal umformatiert.

So benutzt du es

1. Füge Python-Code ein oder öffne eine .py-Datei.
2. Der formatierte Code erscheint schon beim Tippen rechts.
3. Passe die Optionen an, wenn dein Projekt einen anderen Stil verwendet:
   • Einrückung: 4 Leerzeichen entsprechen PEP 8 und dem Standard; 2 Leerzeichen und Tabs sind verfügbar.
   • Zeilenbreite: 88 ist der Standard von Black, 79 das Limit von PEP 8, und 100 oder 120 passen zu breiteren Bildschirmen.
   • Anführungszeichen: doppelt, einfach oder die Anführungszeichen beibehalten, die jeder String bereits verwendet.
   • Nachgestellte Kommas respektieren: Sammlungen, die mit einem Komma enden, aufgeklappt lassen.
4. Kopier das Ergebnis oder lade es herunter.

Lässt sich der Code nicht parsen, zeigt die Fehlermeldung, wo der Parser abgebrochen hat, etwa Expected `,`, found `=` in Zeile 4, und du kannst direkt zu dieser Zeile springen.

Beispiel

Das Beispiel ist ein kleines, nachlässig geschriebenes Modul: Imports in einer Zeile ohne Leerzeichen, eine Dataclass mit einem Leerzeichen vor dem Doppelpunkt, eine mit zwei Leerzeichen eingerückte Methode und eine einzeilige if-Anweisung. Nach dem Formatieren verwendet jeder Block vier Leerzeichen Einrückung, der if-Rumpf wandert in eine eigene Zeile, Operatoren bekommen Leerzeichen, einfache Anführungszeichen werden zu doppelten, und zwischen Klasse und Funktionen werden Leerzeilen eingefügt. Die Liste, die mit einem nachgestellten Komma endete, wird mit einem Dictionary pro Zeile aufgeklappt.

Was der Formatierer nicht macht

Formatieren ändert nur das Layout. Imports werden nicht sortiert, unbenutzte Variablen nicht entfernt und nichts umbenannt; das sind Aufgaben eines Linters (ruff check --fix erledigt sie). Kommentare und Docstrings bleiben erhalten, und Code, den der Formatierer nicht parsen kann, lässt er lieber unverändert, statt zu raten.

Tipps

• Verwende dieselbe Zeilenbreite wie in der pyproject.toml deines Projekts, damit das Ergebnis zu deiner CI passt.
• Ein Snippet vor dem Posten in einer Frage oder einem Review zu formatieren, macht es viel leichter lesbar.
• Stammt der Code aus einem Notebook oder Chat und mischt Tabs und Leerzeichen, vereinheitlicht der Formatierer das in einem Schritt.