Python Jiří Znamenáček Generické funkce 2022-11-26

Dokonce ještě před rozšířením používání anotací pro označení typů mohlo mít (a mělo) smysl upravit chování funkce podle typu přijatých parametrů.

Zatímco klasickým způsobem bylo testování typu při vstupu do funkce (případně dokonce natvrdo aserce na typ požadovaný funkcí), jdou na to generické funkce jinak:

Implementace generické funkce je složena z vícero samostatných funkcí, přičemž při zavolání je jedna konkrétní z nich vybrána na základě tzv. výběrového algoritmu (dispatch algorithm).

Základní funkce, která definuje jméno celé této „rodiny“, je pak použita v případě, že výběrový algoritmus nedokáže vybrat žádnou ze specifičtějších implementací.

S generickými funkcemi se můžeme v Python'u setkat od verze 3.4 ve formě tzv. „single-dispatch“ funkcí, neboli funkcí, kde je konkrétní implementace vybrána na základě typu jediného parametru (a to toho prvního).

Prakticky se tyto funkce zavádějí odekorováním základní funkce rodiny dekorátorem @singledispatch z modulu functools..

from functools import singledispatch @singledispatch def funkce(argument): "Základní funkce generické rodiny spolupracujících funkcí." ...

..čímž tato funkce získá funkční atribut register, který funguje jako dekorátor pro související implementace, které přetěžují tuto základní.

Generická funkce s třemi módy chování:

PS: Ačkoli anotace přes sjednocení typů (zde tedy int | float) funguje už od Python'u 3.10, její použití v generických funkcích až od verze Python'u 3.11!

Pár poznámek přímo podle dokumentace:

Atribut základu generické funkce register je opravdu normální dekorátor, takže ho můžete použít pro registraci již existující funkce funkcionálním způsobem:

funkce.register(type(None), jiná_funkce)

Navíc atribut register při použití vrací originální neodekorovanou funkci (sic!), takže ho můžete vrstvit samého na sebe, přičemž každé použití je nezávislé na ostatních:

K vlastním implementacím příslušné generické funkce se dá nepřekvapivě dostat i přímo z programu. Schovávají se v atributu registry v podobě mapování („slovníku“) dostupných implementací dané generické funkce:

PS: <class 'object'> odpovídá základní funkci (tedy implementaci, která bude použita, pokud nebude možno vybrat konkrétnější).

Která implementace bude vybrána pro daný vstup, pak umožňuje ukázat metoda dispatch():

Jelikož metody instancí jsou samozřejmě také funkce, není divu, že Python umožňuje i je psát jako generické. Jen dekorátor k tomu použitý se jinak jmenuje (singledispatchmethod) a z důvodu zachování funkcionality musí býti tím nejposlednějším (tedy tím nejvíce „vnějším“) ze všech. Bez invence příklad přímo z dokumentace:

from functools import singledispatchmethod class Negator: @singledispatchmethod def neg(self, arg): raise NotImplementedError("Cannot negate a") @neg.register def _(self, arg: int): return -arg @neg.register def _(self, arg: bool): return not arg Řetězení dekorátorů tedy musí být takovéto: @neg.register @classmethod def _(cls, arg: int): return -arg Výběr implementace probíhá podle prvního argumentu za self či cls, jsou-li na metodě přítomny.