Python: Code quality

Tento online kurz je zameraný na zlepšenie kvality kódu v Pythone, pokrývajúce širokú škálu tém od správy projektov až po business hľadisko code quality.

Kurz začína so správou projektu, kde sa študenti naučia o význame virtuálnych prostredí, a ako používať nástroje ako poetry na inštaláciu a distribúciu balíčkov. Ďalej sa kurz venuje lintingu pomocou nástrojov ako pylint a ruff, ktoré pomáhajú udržovať kód konzistentnejší a bezpečnejší.

V lekcii o formátovaní sa kurz zameria na dodržiavanie PEP štandardov, a predstaví nástroje ako black pre automatizáciu tohto procesu. Typing je ďalšou kľúčovou oblasťou, kde sa študenti zoznámia s typovými anotáciami a nástrojmi ako mypy na zaistenie typovej bezpečnosti kódu.

Dokumentácia je nevyhnutná pre každý projekt, a tento kurz pokrýva ako písať užitočné komentáre a docstringy, merať pokrytie docstringov, používať doctesty, a vytvárať dokumentáciu vo formátoch ako Google, NumPy, a reStructuredText. Študenti sa tiež naučia písať zrozumiteľné README súbory a vytvárať UML diagramy tried či OpenAPI dokumentáciu.

Testovanie je ďalším kľúčovým prvkom udržateľného vývoja, a kurz tak zahŕňa rôzne typy testov, nástroje ako pytest a ako merať pokrytie testov. Bezpečnosť je zásadná, a študenti sa naučia ako písať bezpečnejší kód a vyhodnocovať bezpečnosť externých balíčkov pomocou nástrojov ako bandít a safety.

Ďalšou témou bude aj zložitosť kódu. Zložitý kód môže spôsobovať horšiu čitateľnosť a taktiež môže byť náročné ho ďalej upravovať a rozširovať. Predstavíme si tak niekoľko metrík a nástrojov, ktoré nám pomôžu zložitosť vyhodnotiť.

V sekcii o hardvérovej náročnosti kurz preskúma, ako zlepšiť výkon aplikácií z hľadiska CPU a RAM, výber dátových štruktúr, upgrade Pythonu, zmenu výpočtového modelu, použitie JIT kompilátorov, zmenu interpretérov a využitie bindingov z iných jazykov.

Automatizácia je nevyhnutná pre efektívny vývoj, a kurz predstavuje nástroje a task runnery ako make alebo poe the poet, spoločne s komplexnou code quality platformou a pre-commit hooky. Obsahom je tiež continuous integration/continuous delivery (CI/CD).

Po prebratí všetkých tém kurz aplikuje väčšinu nových znalostí na open source projekte FastAPI, vrátane použitia linterov, formátovacích nástrojov či mypov.

Záver kurzu sa venuje business perspektíve code quality, skúma vzťah medzi rýchlosťou vývoja a kvalitou kódu, rôzne úrovne kvality kódu, a predstavuje príklady implementácie code quality v skutočných projektoch. Tento komplexný prístup pripraví študentov na písanie vysoko kvalitného, bezpečného a efektívneho kódu vo svojich budúcich projektoch.

Celkovo kurz ponúkne 14 kapitol obsahu, cez 3 hodiny plných informácií, povieme si asi o 40 rôznych knižniciach, vyskúšame si napísať kód v 4 rôznych jazykoch - samozrejme predovšetkým hlavne v pythone a odkážeme aj na ďalšiu nadväzujúcu literatúru a súvisiace zdroje.