python-code-style
Automatyczne formatowanie, linting i dokumentacja kodu Python — zgodnie ze standardami branżowymi
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do zarządzania stylem kodu Python, lintingiem i dokumentacją. Pomaga w konfiguracji narzędzi takich jak ruff i mypy, pisaniu docstringów oraz ustalaniu standardów kodowania w zespole. Obejmuje konwencje nazewnictwa zgodne z PEP 8, type hints oraz best practices dla nowoczesnego Pythona. Idealny do tworzenia spójnych, łatwych w utrzymaniu projektów.
Jak używać
Zainstaluj nowoczesne narzędzia do lintingu i formatowania, uruchamiając w terminalu: pip install ruff mypy. Ruff zastępuje flake8, isort i black jednym szybkim narzędziem.
Utwórz lub edytuj plik pyproject.toml w katalogu głównym projektu. Dodaj sekcję [tool.ruff] z konfiguracją linii (np. line-length = 120) i docelową wersją Pythona (target-version = "py312").
W sekcji [tool.ruff.lint] zdefiniuj reguły do sprawdzania — wybierz kategorie takie jak E (błędy pycodestyle), F (pyflakes), I (isort), B (bugbear) i UP (pyupgrade). Dodaj sekcję [tool.mypy] z opcją strict = true dla ścisłej kontroli typów.
Uruchom ruff na swoim kodzie poleceniem ruff check . aby znaleźć problemy ze stylem i konsystencją. Użyj ruff format . aby automatycznie naprawić formatowanie.
Podczas pisania lub przeglądu kodu zwróć uwagę na docstringi — utrzymuj je obok kodu, który opisują. Dodaj type hints do publicznych API projektu.
Skonfiguruj mypy do sprawdzania typów, uruchamiając mypy . w katalogu projektu. Narzędzie wychwyta błędy typów przed uruchomieniem kodu.