Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / Python

Dopředné odkazy v typových anotacích

V Pythonu 3.12 zapiš název typu do uvozovek, pokud při definici metody ještě není dostupný. Potřebuješ-li objekt třídy, odkaz vyhodnoť později.

Verze: Python 3.12

Syntaxe

# Quote a name that is not bound yet:
def f(value: "Later") -> "Later": ...

# For a union, quote the entire expression:
def g(value: "int | Later") -> None: ...

# Alternatively, as a separate module using postponed evaluation:
from __future__ import annotations

def f(value: Later) -> Later: ...

Dopředný odkaz v typové anotaci odkazuje na typ, jehož název ještě není dostupný v místě definice funkce. V Pythonu 3.12 se bez odkladu anotace funkce vyhodnocují při provedení příkazu def, nikoli při volání funkce. Pokud název typu v danou chvíli není dostupný, jeho použití bez uvozovek vyvolá NameError. Anotace pomáhají nástrojům pro statickou kontrolu typů; samotný Python jimi argumenty ani návratové hodnoty nekontroluje.

V WorkItem.from_dict odkazuje -> "WorkItem" na třídu, jejíž tělo se právě provádí. V Project.add_module odkazuje module: "Module" na třídu definovanou níže. V obou případech řetězcový literál zaznamená odkaz bez okamžitého vyhledání názvu. U sjednocení typů dej do uvozovek celý výraz: "int | Module". Bez odkladu vyvolá int | "Module" výjimku TypeError, protože operátor | dostane typ a řetězec.

Další možností je uvést from __future__ import annotations na začátek modulu, za případný dokumentační řetězec. V Pythonu 3.12 tento import ukládá anotace funkcí jako řetězce, takže můžeš psát -> WorkItem a module: Module bez uvozovek. Neodkládá vyhodnocení běžných výrazů mimo anotace, například výchozích hodnot parametrů.

V příkladu obsahuje __annotations__ řetězce. Po definování obou tříd funkce typing.get_type_hints() vyhledá názvy v příslušných jmenných prostorech a vyhodnotí odkazy na objekty tříd. Pokud název chybí, například proto, že byl importován jen v if TYPE_CHECKING:, stále může nastat NameError. Nevyhodnocuj nedůvěryhodné anotace: vyhodnocení jejich výrazů může spustit kód.

Příklady

from typing import get_type_hints


class WorkItem:
    def __init__(self, title: str) -> None:
        self.title = title

    @classmethod
    def from_dict(cls, data: dict[str, str]) -> "WorkItem":
        return cls(data["title"])


class Project:
    def __init__(self) -> None:
        self.modules = []

    def add_module(self, module: "Module") -> None:
        self.modules.append(module)


class Module:
    pass


print(repr(WorkItem.from_dict.__annotations__["return"]))
print(repr(Project.add_module.__annotations__["module"]))
print(get_type_hints(WorkItem.from_dict)["return"] is WorkItem)
print(get_type_hints(Project.add_module)["module"] is Module)

Výsledek

'WorkItem'
'Module'
True
True

První dva řádky ukazují reprezentace řetězců z `__annotations__`. Dva výsledky `True` potvrzují, že vyhodnocené anotace jsou přesně objekty tříd `WorkItem` a `Module`.

Související lekce

  • Python · Lekce 3 · Pokročilá · Verze: 5
  • Python · Lekce 7 · Pokročilá · Verze: 5

Zdroje