Chyby v kódu jsou noční můrou každého programátora. V ideálním případě je odhalíme během vývoje a testování, ale i tak může odstraňování chyb zabrat spoustu času a způsobit frustraci. V horším případě se dostanou do produkčního kódu, kde způsobí chaos a selhání aplikace.
Důsledkem mohou být malé nepříjemnosti pro uživatele nebo velké, život ohrožující katastrofy. Ať už je dopad jakýkoliv, vývojáři by měli usilovat o co nejčasnější odhalení a odstranění chyb.
V tomto článku si představíme metodu, jak toho dosáhnout v Pythonu, a to pomocí lintingu. Prozkoumáme nejlepší nástroje a platformy pro lintování kódu v Pythonu.
Co je to linting a jaké jsou Python lintery?
Linting je automatická analýza zdrojového kódu za účelem odhalení stylistických a programátorských chyb. Název pochází z Unixového nástroje Lint, který sloužil ke kontrole kódu napsaného v jazyce C.
Postupem času se linting rozšířil i mimo jazyk C a nyní se používá i pro kontrolu kódu napsaného v dalších populárních jazycích, včetně Pythonu. Python lintery jsou nástroje, které slouží k provádění lintingu pro různé Python programy.
Proč jsou lintery v programování důležité?
- Linting snižuje počet chyb v produkčním kódu tím, že provádí automatickou kontrolu. Funguje jako další pár očí, který pomáhá odhalit chyby včas a s menším úsilím. Díky tomu se zvyšuje produktivita a kvalita kódu.
- Také pomáhá optimalizovat kód z hlediska efektivity a výkonu, identifikuje nepoužívané konstrukce, jako jsou proměnné a nedosažitelný kód. To vede ke zmenšení velikosti zdrojového kódu a výsledného programu.
- Napomáhá standardizaci kódu tím, že sjednocuje používání tabulátorů a mezer, čímž se zajišťuje konzistence kódu.
- Linting usnadňuje revizi kódu, protože ověřuje, zda jsou dodrženy určité standardy. Recenzent se tak nemusí zabývat například kontrolou, zda jsou všechny proměnné psány pomocí snake_case.
Existuje mnoho nástrojů, které můžete použít pro lintování kódu v Pythonu. Pro výběr toho nejlepšího je třeba zvážit funkce, které nabízí, jako je rozsah pravidel, flexibilita, cena a možnost sdílet pravidla s ostatními členy týmu.
S ohledem na tyto a další aspekty si představíme seznam nejlepších nástrojů.
Ruff
Ruff je Python linter, který vytvořila společnost Astral. Je zdarma a open-source. Ruff je napsaný v jazyce Rust, a proto je ve srovnání s jinými lintery neuvěřitelně rychlý. Snadno se instaluje pomocí pip a dokáže prověřit váš kód pomocí více než 500 pravidel.
Kromě toho se Ruff dobře integruje s editory jako Visual Studio Code, Neovim, Sublime Text a další. Podporuje automatické opravy, takže můžete snadno opravit chyby bez nutnosti manuálně přepisovat kód.
V době psaní tohoto článku je Ruff ve verzi 0.0.267, což znamená, že nemusí fungovat zcela bezchybně a před vydáním verze 1.0 může dojít k zásadním změnám.
Sonar
SonarLint je bezplatný lintovací nástroj, který funguje jako plugin pro IDE. Lze jej nainstalovat do většiny hlavních IDE, jako je Visual Studio Code, PyCharm a Eclipse.
Kromě Pythonu podporuje i další jazyky, jako je JavaScript, Java a C++. Spouští se během psaní kódu a poskytuje okamžitou zpětnou vazbu pro opravu kódu v reálném čase.
SonarLint lze integrovat s platformami SonarQube nebo SonarCloud, což umožňuje sdílení standardů kódu v rámci týmu. To pomáhá při standardizaci kódu a dodržování týmových osvědčených postupů.
pytype
PyType je oblíbený linter, který byl vytvořen a používán společností Google pro mnoho jejích Python projektů. Je zdarma a open source. PyType kontroluje kód a odvozuje typy proměnných. To znamená, že dokáže detekovat chyby související s typy, aniž byste museli explicitně definovat typové anotace.
PyType také kontroluje kód z různých souborů, aby zajistil jeho správnost. Lze jej nainstalovat pomocí pip a používat jako nástroj příkazové řádky.
PyType byl vyvinut a testován na Linuxu, proto na tomto operačním systému funguje nejlépe. Pro MacOS vyžaduje PyType verzi 10.7 nebo vyšší a XCode verzi 8 nebo vyšší. V současné době nepodporuje Windows, pokud jej nepoužíváte v subsystému Windows pro Linux.
Codacy
Codacy je placený nástroj pro linting s bezplatným plánem pro open-source projekty. Pomáhá identifikovat problémy v kódu, včetně bezpečnostních slabin a chyb.
Pomocí Codacy můžete nastavit standardy kódu pro organizaci, které budou aplikovány napříč různými týmy a projekty. Získáte také přehled o tom, jak časté jsou problémy v kódu a jak je řešit. Navíc Codacy umožňuje i inline anotace.
Codacy lze integrovat do pracovních postupů pomocí nástrojů jako Git, Jira, Slack a poskytovatelů Git, jako jsou GitLab a BitBucket. Podporuje více než 40 nejpoužívanějších programovacích jazyků.
Pylint
Pylint je oblíbený nástroj pro lintování Python kódu. Je zdarma a open source. Pylint dokáže prosadit standardy pro psaní kódu, jako je omezení délky řádku nebo zajištění, že názvy proměnných jsou v souladu s konvencemi. Navíc detekuje i chyby, jako jsou neimportované moduly.
Pylint lze přizpůsobit pomocí konfiguračních souborů. Dobře se integruje s editory jako Emacs, Vim, Eclipse, Spyder a TextMate. Pylint lze automatizovat pomocí nástrojů, jako je Apycot, Hudson nebo Jenkins a vytvářet CI/CD pipeline. Pro instalaci Pylintu můžete použít správce balíčků na Linuxu nebo Pip na Windows a MacOS.
Flake8
Flake8 je bezplatný a open-source Python linter. Kontroluje dodržování PEP8, pyflakes a kruhové složitosti. Obvykle je velmi přesný a vytváří málo falešně pozitivních výsledků. Výsledkem je celkově lepší kód a lepší prostředí pro vývoj.
Flake8 můžete přidat do svého Python IDE nebo editoru, jako je PyCharm nebo Sublime Text. Flake8 podporuje Python 2 i Python 3. Alternativně jej můžete spustit z příkazové řádky nebo jako balíček Pythonu.
Flake8 je přizpůsobitelný, protože umožňuje předávat možnosti jako argumenty příkazů. Pro opětovné použití voleb vám Flake8 umožňuje uložit je do konfiguračního souboru.
Black
Black je nekompromisní a „tvrdohlavý“ Python linter. Výsledkem je, že je rychlý a deterministický. Deterministický je proto, že používá vlastní interní standardy a prosazuje je napříč různými projekty.
Tím je zajištěno, že kód naformátovaný pomocí Black vypadá stejně bez ohledu na projekt. Black patří mezi nejoblíbenější nástroje používané významnými open-source projekty, jako jsou Pytest, Django a SQLAlchemy.
Organizace jako Facebook, Mozilla a Tesla používají Black pro své Python projekty. Black je open-source projekt.
autopep8
autopep8 je oblíbený Python linter, který formátuje kód tak, aby odpovídal doporučením PEP8, což je oficiální styl pro psaní kódu v Pythonu. Na rozdíl od některých jiných linterů kódu se Autopep8 zaměřuje na opravu formátování a nemění logiku ani strukturu kódu.
Autopep8 také nabízí řadu konfiguračních možností pro přizpůsobení jeho chování. Můžete zadat preference formátování, povolit nebo zakázat specifická pravidla, ovládat délku řádků a konfigurovat další aspekty podle požadavků projektu. Jako většina linterů se i autopep8 dobře integruje se stávajícími IDE a editory.
Pychecker
PyChecker je Python linter, který pomáhá identifikovat problémy, jako je nedosažitelný kód, nepoužívané proměnné a nepřiřazené parametry. Pomáhá vývojářům rychleji nalézt chyby a usnadňuje údržbu kódu.
Lze jej použít z příkazové řádky, což umožňuje lintovat celé projekty jediným příkazem. Může totiž rekurzivně procházet všechny soubory v adresáři a provádět jejich linting. Lze jej také použít v kódu Python a dokáže analyzovat kód napsaný v libovolném stylu. Je v souladu s PEP8 a dalšími pravidly formátování.
Pylama
Pylama je obal pro různé samostatné lintery. Integruje se s několika známými lintry, jako jsou Pylint, PyFlakes, pycodestyle, Mypy a další. Použitím více linterů poskytuje komplexní analýzu kvality kódu a prosazuje širokou škálu standardů.
Často se integruje do systémů kontinuální integrace, jako je GitHub Actions. Pylama také funguje z příkazové řádky a lze jej integrovat do většiny IDE a editorů kódu.
Závěrem
Tento článek pojednává o lintingu a běžných nástrojích, které můžete použít pro lintování vašeho Python projektu. Python lintovací nástroje jsou oblíbenou součástí vývojářských nástrojů v Pythonu a přispívají ke zlepšení produktivity.
Dále se můžete podívat na nástroje pro práci se soubory CSV, které umožňují převod, formátování, validaci a další.