Python Jiří Znamenáček Deskriptory 2011-05-05

Poměrně často můžeme po datových atributech chtít, aby se chovaly trochu také jako metody, které něco dělají, a ne jen udržovaly nějakou hodnotu. Typicky:

Toto chování v mnoha jazycích zajišťují tzv. getters & setters, v Python'u je však známější pod pojmenováním properties a nebo ještě spíše pod jménem protokolu, který slouží (nejen) k jejich implementaci – deskriptory (descriptors).

Představte si, že vyrobíte program pro kreslení plošných objektů do canvasu. Každý grafický objekt je představován nějakým programovým objektem. Jeden z datových atributů tohoto programového objektu (zvaný třeba color) udržuje povědomí o barvě objektu grafického. Uvedený datový atribut je možno číst – dostanete aktuální barvu objektu. Ale též je do něj možné zapisovat – pak by se zřejmě měla zároveň změnit i samotná barva grafického objektu.

Ukažme si nejdříve poněkud „ukecaný“, leč poměrně přímočarý způsob, jak zavést na objektu atributy, které se budou chovat požadovaným způsobem:

# zavedení objektu class Plocha: def __init__(self, barva=None): self._barva = barva def get_barvu(self): print("Vracím barvu.") return self._barva def set_barvu(self, val): print("Nastavuji barvu na:", val) self._barva = val barva = property(get_barvu, set_barvu) # zavedení instance objektu p = Plocha() # „hraní si“ s atributem barva b = p.barva print(b) print() p.barva = "zelená" print() b = p.barva print(b) Zde nepoužitá část pro odstranění atributu by vypadala následovně: def del_barvu(self): print("Odstraňuji barvu.") del self._barva barva = property(get_barvu, set_barvu, del_barvu)

Spustíme-li uvedený kód, obdržíme následující výstup (vysvětlující komentáře přidány):

Vracím barvu. # důsledek zavolání „b = p.barva“ None # vrácená hodnota (po __init__() je zatím None) Nastavuji barvu na: zelená # důsledek zavolání „p.barva = "zelená"“ Vracím barvu. # důsledek zavolání „b = p.barva“ zelená # vrácená hodnota

Vestavěná funkce property(), kterou jsme na předchozím slajdu použili pro konstrukci property-atributu barva, má v úplnosti následující záběr: 

    property(fget=None, fset=None, fdel=None, doc=None)

V plné šíři tedy může vygenerovat atribut, který nabídne obslužnou funkci při čtení (fget), zápisu (fset) a odstranění atributu (fdel; nepříliš častá operace) plus zavedení dokumentačního řetězce (doc).

Není-li parametr doc přítomen, pokusí se Python na jeho místo dosadit dokumentační řetězec funkce fget.

Výše uvedené použití však není zrovna ideální, pokud obslužné funkce nepotřebujeme na nic jiného (což nejspíše bude nejčastější případ) – pokud je totiž nezavedeme jako dvojpodtržítkové (na začátku jména), tak nám budou zcela zbytečně „zaneřáďovat“ jmenný prostor objektu:

>>> dir(p) ['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_barva', 'barva', 'del_barva', 'get_barva', 'set_barva'] Atribut _barva je v případě properties v některých verzích Python'u schovaný (například 3.4), ale většinou tedy ne.

Od Python'u 2.6 se (nejen) uvedený problém zaneřáďování jmenného prostoru řeší pomocí dekorátorů. Bohužel vybraný způsob zápisu je (nejen podle mě) velmi matoucí a nepřehledný:

class Plocha: def __init__(self, barva=None): self._barva = barva @property def barva(self): print("Vracím barvu.") return self._barva @barva.setter def barva(self, val): print("Nastavuji barvu na:", val) self._barva = val Funkce property tedy slouží jako dekorátor pro getter. Zde nepoužitý dekorátor pro odstranění atributu by byl @barva.deleter. Zajímavé je, že po této „operaci“ zůstal u Python'u 3.4 ve jmenném prostoru objektu už pouze atribut barva. Všude jinde uvidíte ovšem i atribut _barva. Chcete-li ho trochu více schovat, musíte použít podtržítka dvě: def __init__(self, barva=None): self.__barva = barva Je samozřejmě třeba upravit i zbývající volání.

Dosti nešťastná volba zápisu zavedení těchto „obojetných“ atributů pomocí dekorátorů způsobila zřejmě její poměrnou neoblibu mezi pythoními programátory.

Vzhledem k naprosté asymetričnosti použití dekorátorů se osobně také kloním spíše k tradičnímu používání funkce property() a důsledného dvojpodtržítkování všech pomocných funkcí a proměnných.

V kapitole o introspekci jsme viděli, že atributy objektu „žijí“ v jeho jmenném prostoru díky mapování v atributu __dict__. Dotaz na „běžný“ (ne-property) atribut se tak přeloží pomocí metod daného objektu..

..na odpovídající dotaz do slovníku příslušné instance nebo některé její rodičovské třídy:

# a) daný atribut je definován přímo na instanci INSTANCE.__dict__['ATRIBUT'] # b) daný atribut definuje základní třída této instance type(INSTANCE).__dict__['ATRIBUT'] # c) daný atribut je definován na některé předchozí rodičovské třídě …

Pokud se však jedná o property-atribut (tj. v odpovídající třídě je atribut definován jako property/deskriptor), všechno je jinak:

Property-atribut je ve slovníku __dict__ představován celou speciální třídou s vlastními metodami, tzv. deskriptorem.

Deskriptorové třídy definují následující metody (ne nutně všechny najednou):

Pokus o provedení příslušné operace na property-atributu (opět samozřejmě zprostředkovaný voláním metod objektu __getattribute__(), resp. __setattr__(), resp. __delattr__()) pak způsobí zavolání odpovídající „magické“ metody deskriptoru:

# A) čtení INSTANCE.ATRIBUT <=> type(INSTANCE).__dict__['ATRIBUT'].__get__(INSTANCE, type(INSTANCE)) # B) zápis INSTANCE.ATRIBUT = value <=> type(INSTANCE).__dict__['ATRIBUT'].__set__(INSTANCE, type(INSTANCE), value) # C) odstranění del INSTANCE.ATRIBUT <=> type(INSTANCE).__dict__['ATRIBUT'].__delete__(INSTANCE) Pro příslušné dotazy na třídě to dopadne trošku jinak, např. TŘÍDA.ATRIBUT <=> TŘÍDA.__dict__['ATRIBUT'].__get__(None, TŘÍDA) apod.

PS: Existuje i magická metoda __getattr__(). Narozdíl od __getattribute__(), která se volá vždy, je-li k dispozici, dochází k volání __getattr__() pouze tehdy, nepodaří-li se daný atribut nalézt jiným způsobem (a je-li definována).

Tak zvané datové deskriptory typicky definují metody __get__() i __set__(), nedatové deskriptory (tedy především funkce aneb metody) na druhou stranu pouze metodu __get__().

V praxi největší rozdíl mezi nimi je pak především ten, že metody (jakožto nedatové deskriptory) můžete na instancích „přepsat“ (jednoduše pod daným jménem uložíte něco nového), zatímco datové deskriptory nikoli (protože pokus o přiřazení vyvolá specifické chování deskriptoru). Čili především:

Deskriptory v Pyhton'u slouží k implementaci celé řady základních věcí: