23. diel - Najčastejšie chyby Python nováčikov - Vieš pomenovať objekty

V nasledujúcej lekcii, Ako správne rozdeliť Python aplikácie do tried - SRP a SoC, si vysvetlíme, čo sú to abstraktné triedy.

V dnešnom Python tutoriáli si ukážeme prvé dobré praktiky pre objektovo orientované programovanie v Pythone. Pozri sa, či nerobíš jednu z najčastejších chýb.

Slovo senior programátora

Gratulujem k zdolaniu základnej problematiky objektovo orientovaného programovania! 🏆 Dostal si sa k záchytnému bodu, v ktorom sa trochu vydýchame a ukážeme si, ako správne použiť nadobudnuté informácie, než sa pustíme do ďalších. Materiál pre dnešnú lekciu som zostavil na základe 20-ročných skúseností s programovaním a jej obsah bude mať zásadný vplyv na tvoje ohodnotenie na trhu práce.

Miliónové straty

O dobrých praktikách sme sa už bavili v kurze Základné konštrukcie jazyka Python a vieme, že neprehľadné programy nie sú vôbec žiadna malichernosť. Sú totiž:

• Nezrozumiteľné pre ostatných - Keď tím 5 programátorov, každý s platom 5.000 € mesačne, strávi 20 % pracovnej doby lúštením kódu, stojí to ročne 60.000 €!
• Náchylné k chybám - Tržby aj malých e-shopov sú mesačne obvykle v stovkách tisíc eur, 1 deň nefunkčnosti teda stoja majiteľa desiatky tisíc eur, dodávateľovi hrozia nemalé zmluvné pokuty.
• Prakticky nerozšíriteľné - V súčasnej funkčnosti sa už nikto nevyzná a nemožno ju rozšíriť. Programátorský tím o niekoľkých ľuďoch musí vytvoriť aplikáciu znova, sme opäť v stovkách tisíc eur.
• Netestovateľné, nezabezpečené a takto by sme mohli pokračovať.

Niet pochýb, že dobré praktiky sú pre vývoj softvéru v tíme úplne zásadné a následky ich porušenia potom úplne fatálne.

Ako správne pomenovávať triedy, atribúty a metódy?

Vieme vytvárať množstvo nových objektových konštrukcií, v programoch nám vzniká množstvo nových identifikátorov (mien). V dnešnej lekcii sa budeme zaoberať tým, ako "objektové súčiastky" našich aplikácií správne pomenovať, aby boli prehľadné.

Motivačný príklad

K doktorovi príde pacient a hovorí mu, že má problém so svojím orgánom Move. Nefunguje mu shoe. Pacient sa zdá byť nejaký popletený a doktorovi trvá pomerne dlho, kým z neho dostane, že ho pichá v päte a preto si nemôže obuť ani topánku. Keď konečne vypustí pacienta z ordinácie, zistí, že bol súčasťou skupiny a takých ich tam ešte čaká niekoľko desiatok.

Pozrime sa ešte na druhý príbeh. Programátorovi pridelí program, ktorý spadne s chybou v triede MoveData, metóda data(). Program sa zdá byť nejaký popletený a programátorovi trvá dlho, než zistí, že ide o triedu importujúcu dáta z externej zálohy a že sa prvýkrát musí ručne zavolať metóda work(), ktorá import vykoná. Keď chybu konečne opraví, objaví sa ďalšia a zistí, že v programe je niekoľko desiatok tried a metód, z ktorých názvu vôbec nespozná, čo robia.

Určite vidíme paralelu týchto dvoch príbehov. Zatiaľ čo u ľudského tela by nás asi ťažko napadlo hovoriť o orgáne "presúvať" a funkciu "topánka", v programoch bohužiaľ nie je taký problém naraziť na objekty pomenované ako deje a funkcie pomenované ako veci, aj keď je princíp úplne rovnaký. Niet divu, že si Indescriptive naming vyslúžilo svoje miesto v šestici najhorších programátorských praktík STUPID.

Pomenovanie tried

Triedy definujú objekty, z ktorých je aplikácia zložená. Z toho vyplýva niekoľko triviálnych pravidiel. Názvy tried:

• sú podstatné mená! - Ide o jednotlivé počítateľné objekty bez ohľadu na to, koľko objektov od triedy potom vytvoríme.
• nie sú názvy dejov - Ide o objekty (veci). Triedy teda nemôžeme nazvať napr. WorkWithFile alebo Printing, ale napr. FileManager alebo Printer (alebo ešte lepšie UserInterface, pretože zriedka kedy tvoríme celú triedu len na vypísanie niečoho).
• začínajú s veľkým písmenom - Každé ďalšie slovo má veľké písmeno (notácia) PascalCase. Je tak vidieť, že ide o všeobecnú triedu a nie o jej konkrétnu inštanciu.
• sú pomenované podľa toho, akú súčasť programu reprezentujú, čo nemusí byť vždy rovnaké, ako to, čo vo vnútri robia.

Ukážme si niekoľko príkladov:

class employee:
class Employees:
class invoice_item:
class WorkingWithFile:
class Print:
class EnteringData:

class Employee:
class EmployeeManager:
class InvoiceItem:
class FileDatabase:
class UserInterface:

Ak narazíte na program, kde sa trieda volá WorkingWithFile, jeho autor si pravdepodobne len vygooglil, že kód sa píše do class bez toho, aby tušil, že tým založil nejaký objekt.

Triedy v množnom čísle

V množnom čísle pomenovávame triedy veľmi zriedka. V Jave takto nájdeme napr. triedu Arrays. Od tej nevytvárame inštancie a používame ju len pre prácu s inštanciami triedy Array, teda s poľami. Pole zotriedime napr. ako:

Arrays.sort(employees);

Osobne by mi oveľa väčší zmysel dávalo, aby tieto metódy mala na sebe priamo trieda Array a písali sme teda:

employees.sort()

Autori Javy pravdepodobne nechceli triedu Array príliš zložitú a tak pre niektoré metódy vytvorili túto druhú triedu. Výsledný prínos je diskutabilný. My triedy v množnom čísle väčšinou deklarovať nebudeme.

Pomenovanie tried v angličtine

Keď si doma programujete aplikáciu pre seba, môžete samozrejme používať slovenčinu. Kódy tých pokročilých sú rovnako ako reálne obchodné aplikácie po anglicky. Pre anglické názvy tried platí samozrejme to isté, čo sme povedali vyššie. Môžeme však ľahko urobiť nasledujúce chyby:

• Jednotné čísla - Keď v slovenčine pomenujeme triedu pracujúcu s autami SpravcaAut, mohol by sa ponúkať anglický preklad CarsManager. Správne je však CarManager, jednotné číslo, pretože Car tu funguje ako prídavné meno.
• Poradie slov - Na rozdiel od slovenčiny je podstatné meno na konci súslovia, správca áut teda nie je ManagerCars alebo ManageCars, ale CarManager. Cesta k súboru nie je PathFile (čo by bol cestový súbor), ale FilePath a pod.

V angličtine sa u tried často používa koncovka -er, napr. TaskRunner, podľa toho, čo trieda robí.

Ukážme si pár príkladov:

class CarsManager:
class PathFile:
class RunTasks:

class CarManager:
class FilePath:
class TaskRunner:

Pomenovanie atribútov

Atribúty sú "premenné" danej triedy. Pre ich pomenovanie teda platia úplne tie isté zásady ako pre premenné, ktoré si už detailne vysvetľovali v lekcii Časté chyby Python nováčikov - Vieš pomenovať premenné?.

Základným pravidlom opäť je, že atribúty pomenovávame podľa toho, čo je v nich uložené. Názov atribútu chápeme v kontexte názvu triedy a nemusí teda dávať zmysel sám o sebe. Z jazykového hľadiska sú názvy atribútov:

• podstatné mená (name, employees...)
• prídavné mená (disabled, sent...)

Pripomeňme si tu aj zvyšné zásady:

• všetky atribúty pomenovávame buď slovensky bez diakritiky alebo anglicky, ale nie kombináciou týchto jazykov,
• viacslovné atribúty pomenovávame pomocou notácie snake_case,
• ak atribút obsahuje kolekciu s viacerými hodnotami (napr. zoznam), je jeho názov v množnom čísle.

Ukážme si opäť nejaké príklady názvov atribútov tried:

self._Name = ""
self._send = False
self._phonenumbers = []
self._tlačidlo = Button()
self._uzivatel_address = []

self._name = ""
self._sent = False
self._phone_numbers = []
self._tlacidlo = Button() # ideálne _button
self._user_addresses = []

Pomenovanie metód a parametrov

Metódy označujú deje, ich názov obsahuje teda sloveso ! Môže ísť o:

• prikazovací tvar (load_images(), set_id()) - Metóda prevažne vykonáva nejakú činnosť a jej výsledok môže alebo nemusí vracať. Nevolíme infinitív alebo -ing tvar, napr. loading().
• opýtací tvar - Metódou sa prevažne pýtame na nejakú hodnotu, než aby sme chceli vykonať nejakú akciu napr. get_rank() alebo is_disabled() pre premenné typu boolean. Už vieme, že takýmto metódam hovoríme gettery.

Metódy pomenovávame podľa toho, čo robia! Vyhýbame sa neurčitým názvom ako work(), action(), run() apod.

Ukážme si príklady:

def printing(employee):
def get_enabled():
def _data():
def work():

def print_info(employee):
def is_enabled():
def _generate_data():
def import_backup():

Parametre metód

Parameter metódy je premenná a preto pre ich názov platia tie isté pravidlá, ako pre premenné a atribúty (napríklad nikdy nepomenujeme parameter param ). Je tu však jedna dôležitá vec na uváženie a to je použitie dvojitej negácie. Ukážme si posledný príklad:

def import_data(disable_foreign_keys = False):

def import_data(enable_foreign_keys = True):

Kto z vás na prvú dobrú dokáže povedať, či sú v prvom variante s odovzdaním hodnoty False kľúče povolené? Všetko je zas o ľudskom mozgu, ktorý nie je zvyknutý fungovať pod dvojakou negáciou. Volíme teda skôr druhý variant.

V nasledujúcej lekcii, Ako správne rozdeliť Python aplikácie do tried - SRP a SoC, si vysvetlíme dobré praktiky SRP (Single Responsibility Principle) a SoC (Separation of Concerns). Nahryzneme aj tému závislostí.