Formatter Python

Co robi to narzędzie

Formatter Python przepisuje kod Pythona w popularnym stylu Black: spójne wcięcia, spacje wokół operatorów, podwójne cudzysłowy, dwie puste linie między definicjami najwyższego poziomu i długie linie zawijane w sensownych miejscach.

Pod spodem działa formatter z Ruff — szybkiego lintera i formattera Pythona napisanego w Ruście — skompilowany do WebAssembly. Wynik Ruff pokrywa się z Black niemal linia w linię, więc kod sformatowany tutaj nie zostanie ponownie przeformatowany przez hook pre-commit w twoim projekcie.

Jak używać

1. Wklej kod Pythona lub otwórz plik .py.
2. Sformatowany kod pojawia się po prawej w trakcie pisania.
3. Dostosuj opcje, jeśli twój projekt używa innego stylu:
   • Wcięcie: 4 spacje to PEP 8 i wartość domyślna; dostępne są też 2 spacje i tabulatory.
   • Szerokość linii: 88 to wartość domyślna Black, 79 to limit PEP 8, a 100 lub 120 pasują do szerszych ekranów.
   • Cudzysłowy: podwójne, pojedyncze albo bez zmian — tak, jak już używa ich każdy string.
   • Respektuj końcowe przecinki: kolekcje kończące się przecinkiem pozostają rozwinięte.
4. Skopiuj lub pobierz wynik.

Gdy kodu nie da się sparsować, komunikat błędu pokazuje, gdzie zatrzymał się parser, np. Expected `,`, found `=` w linii 4, a ty możesz przejść prosto do tej linii.

Przykład

Przykład to mały moduł napisany niedbale: importy w jednej linii bez spacji, dataclass ze spacją przed dwukropkiem, metoda wcięta dwiema spacjami i jednoliniowa instrukcja if. Po sformatowaniu każdy blok ma wcięcie czterech spacji, ciało if przechodzi do osobnej linii, operatory dostają spacje, pojedyncze cudzysłowy zmieniają się w podwójne, a między klasą a funkcjami pojawiają się puste linie. Lista zakończona przecinkiem zostaje rozwinięta, po jednym słowniku na linię.

Czego formatter nie robi

Formatowanie zmienia tylko układ. Nie sortuje importów, nie usuwa nieużywanych zmiennych ani niczego nie przemianowuje; to zadania lintera (zajmuje się nimi ruff check --fix). Komentarze i docstringi są zachowywane, a kodu, którego nie da się sparsować, formatter nie zmienia, zamiast zgadywać.

Wskazówki

• Użyj tej samej szerokości linii co w pyproject.toml twojego projektu, aby wynik był zgodny z CI.
• Sformatowanie fragmentu przed wklejeniem go do pytania lub code review znacznie ułatwia jego czytanie.
• Jeśli kod pochodzi z notatnika lub czatu i miesza tabulatory ze spacjami, formatter ujednolica go w jednym kroku.