Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Python

Odwołania wprzód w adnotacjach typów

W Pythonie 3.12 zapisz nazwę typu w cudzysłowie, jeśli nie jest jeszcze dostępna przy definiowaniu metody. Rozwiąż odwołanie później, jeśli potrzebujesz obiektu klasy.

Wersja: Python 3.12

Składnia

# 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: ...

Odwołanie wprzód w adnotacji typu wskazuje typ, którego nazwa nie jest jeszcze dostępna w miejscu definiowania funkcji. W Pythonie 3.12 bez odroczenia adnotacje funkcji są obliczane podczas wykonywania instrukcji def, a nie przy wywołaniu funkcji. Jeśli nazwa typu nie jest wtedy dostępna, użycie jej bez cudzysłowu powoduje NameError. Adnotacje służą m.in. do statycznej kontroli typów; sam Python nie sprawdza na ich podstawie argumentów ani wyników.

W WorkItem.from_dict adnotacja -> "WorkItem" wskazuje klasę, której ciało jest jeszcze wykonywane. W Project.add_module adnotacja module: "Module" wskazuje klasę zdefiniowaną niżej. W obu przypadkach literał tekstowy pozwala zapisać odwołanie bez natychmiastowego wyszukiwania nazwy. Dla unii ujmij w cudzysłów całe wyrażenie: "int | Module". Bez odroczenia int | "Module" powoduje TypeError, ponieważ operator | otrzymuje typ i napis.

Alternatywnie umieść from __future__ import annotations na początku modułu, po ewentualnym docstringu. W Pythonie 3.12 ten import zachowuje adnotacje funkcji w postaci tekstowej, więc można pisać -> WorkItem i module: Module bez cudzysłowu. Nie odracza jednak obliczania zwykłych wyrażeń poza adnotacjami, np. wartości domyślnych argumentów.

W przykładzie __annotations__ zawiera napisy. Gdy obie klasy są już zdefiniowane, typing.get_type_hints() rozwiązuje odwołania do obiektów klas, korzystając z odpowiednich przestrzeni nazw. Jeśli nazwy tam brakuje, np. gdy zaimportowano ją tylko w if TYPE_CHECKING:, nadal może wystąpić NameError. Nie rozwiązuj niezaufanych adnotacji: obliczanie zapisanych w nich wyrażeń może wykonać kod.

Przykłady

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)

Wynik

'WorkItem'
'Module'
True
True

Pierwsze dwa wiersze pokazują reprezentacje napisów z `__annotations__`. Dwa wyniki `True` potwierdzają, że rozwiązane adnotacje są dokładnie obiektami klas `WorkItem` i `Module`.

Powiązane lekcje

  • Python · Lekcja 3 · Zaawansowany · Wersja: 5
  • Python · Lekcja 7 · Zaawansowany · Wersja: 5

Źródła