Python Jiří Znamenáček Anotace proměnných 2017-06-29

Python je dynamicky typovaný jazyk, což znamená, že o žádném místě v paměti (referencovaném nějakým jménem z programu) se dopředu neví, co v něm je, dokud se tam interpretr nepodívá. Což je sice pohodlné pro rychlou práci, nicméně to nebývá – alespoň v případě hlavních interpretrů Python'u – příliš rychlé.

Nejen z tohoto důvodu si tak postupem času spousta lidí začala do pythoních programů dopisovat označení typů a k nim armádu nástrojů na jejich ověřování či rovnou vynucování. Zkrátka typy..

A tak časem vývojáři Python'u vzali uvedený stav na vědomí a ustavili pro Python 3.0+ způsob zápisu tzv. anotací funkcí (function annotations) a později i anotace všech ostatních objektů, tedy proměnných globálních i třídních. O kterých právě je tato přednáška.

Anotace proměnných se zapisují takto:

# proměnná bez výchozí hodnoty PROMĚNNÁ: VÝRAZ # proměnná s výchozí hodnotou PROMĚNNÁ: VÝRAZ = výchozí_hodnota

Pár příkladů:

kapitán: str prvočísla: list[int] = []

Anotace proměnných zavedených na úrovni modulu jsou přítomné v magickém atributu __annotations__ příslušného modulu:

Tedy __annotations__ je slovník, jehož klíči jsou názvy příslušných proměnných a hodnotami odpovídající anotace.

Anotací může být jakýkoliv výraz:

>>> seznam: 'můj seznam čísel' = [] >>> __annotations__ {'seznam': 'můj seznam čísel'}

Jelikož se celkem pochopitelně předpokládá, že anotovat se bude především (základními) typy, byla – po přechodném období, kdy pro složené typy uvedenou funkcionalitu zajišťoval modul typing – od verze Python'u 3.9 upravena funkcionalita základních typů tak, aby je bylo možno použít ve všech těchto situacích:

prvočísla: list[int] = [] Než se základní konstruktory „naučily“ rozumět výrazům s [], musela se stejná funkcionalita zapsat takto: from typing import List prvočísla: List[int] = []

Kromě toho je vřele doporučováno zavádět si vlastní výmluvné aliasy na „běžné“ typy, například:

Url = str adresa: Url = 'http://vyuka.ookami.cz'

Samozřejmě je možno anotovat i proměnné tříd – anotace jsou pak (nepřekvapivě) dostupné na magickém atributu __annotations__ příslušné třídy (obšlehnuto z dokumentace):

>>> from typing import ClassVar >>> class BasicStarship: ... captain: str = 'Picard' ... damage: int ... stats: ClassVar[dict[str, int]] = {} >>> BasicStarship.__annotations__ {'captain': <class 'str'>, 'damage': <class 'int'>, 'stats': typing.ClassVar[dict[str, int]]} A právě anotace třídních proměnných (tedy odlišení od proměnných instančních; zde pomocí speciální třídy typing.ClassVar) je jeden z důvodů, proč i dnes zůstává v Python'u modul typing, přestože od verze 3.9 již není potřeba pro anotace složených typů – zatím není k dispozici lepší způsob, jak příslušné proměnné označit jako třídní. Na druhou stranu má PEP 526 status „provisional“, protože se způsob anotací pro třídní proměnné (a případně i jiné věci kolem anotací) nikomu moc nezamlouvá.

Je třeba nezapomínat na to, že Python byl/je/zůstává dynamicky typovaným jazykem a žádný z jeho interpretrů nemá v popisu práce s anotacemi dělat cokoliv jiného, než je „cpát“ do atributu __annotations__.

Anotace v Python'u jsou a dlouho (navěky?) budou pouze pro potřeby externích nástrojů (či editorů), které nemusí vůbec provádět typovou kontrolu, ale klidně něco úplně jiného (například budovat lepší nápovědu).

Nasazení anotací v praxi ukázalo některé slabiny původní implementace. Konkrétně nástroje napovídající typy se nemohly odkazovat na ještě neexistující objekty, protože anotace byly načítány do svých datových struktur v pořadí zpracování zdrojového textu a příslušné objekty tím pádem ještě neexistovaly.

A navíc díky anotacím programy startovaly o něco pomaleji.

Proto Python 3.7 přinesl zpožděné vyhodnocování anotací (postponed evaluation of annotations). Nicméně jelikož je to vlastnost zpětně nekompatibilní, musíte si ji vyžádat v každém modulu importem z __future__:

from __future__ import annotations

Uvedené chování bez tohoto importu bude výchozí až v Python'u 4.0.