CKTIS / Python
Vorwärtsreferenzen in Typannotationen
Setze in Python 3.12 einen Typnamen in Anführungszeichen, wenn er beim Definieren einer Methode noch nicht verfügbar ist. Löse die Referenz später auf, falls du das Klassenobjekt brauchst.
Version: Python 3.12
Syntax
# 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: ...Eine Vorwärtsreferenz in einer Typannotation verweist auf einen Typ, dessen Name an der Stelle der Funktionsdefinition noch nicht verfügbar ist. In Python 3.12 werden Funktionsannotationen ohne Aufschub beim Ausführen von def ausgewertet, nicht beim Aufruf der Funktion. Ein zu diesem Zeitpunkt nicht verfügbarer Typname ohne Anführungszeichen löst NameError aus. Die Annotationen helfen bei der statischen Typprüfung; Python selbst prüft damit weder Argumente noch Rückgabewerte.
In WorkItem.from_dict verweist -> "WorkItem" auf die Klasse, deren Rumpf gerade ausgeführt wird. In Project.add_module verweist module: "Module" auf eine weiter unten definierte Klasse. In beiden Fällen hält das Stringliteral die Referenz fest, ohne den Namen sofort nachzuschlagen. Bei einer Union gehört der ganze Ausdruck in Anführungszeichen: "int | Module". Ohne Aufschub löst int | "Module" einen TypeError aus, weil | einen Typ und einen String erhält.
Alternativ kannst du from __future__ import annotations an den Modulanfang setzen, direkt nach einem gegebenenfalls vorhandenen Modul-Docstring. In Python 3.12 werden Funktionsannotationen damit als Strings gespeichert. Du kannst also -> WorkItem und module: Module ohne Anführungszeichen schreiben. Gewöhnliche Ausdrücke außerhalb von Annotationen, etwa Standardwerte von Parametern, werden dadurch nicht aufgeschoben.
Im Beispiel enthält __annotations__ Strings. Sobald beide Klassen definiert sind, löst typing.get_type_hints() die Referenzen zu Klassenobjekten auf, indem es die Namen in den passenden Namensräumen nachschlägt. Fehlt ein Name, etwa weil er nur in if TYPE_CHECKING: importiert wurde, kann weiterhin NameError auftreten. Löse keine nicht vertrauenswürdigen Annotationen auf: Bei der Auswertung der Ausdrücke kann Code ausgeführt werden.
Beispiele
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)
Ergebnis
'WorkItem' 'Module' True True
Die ersten beiden Zeilen zeigen die Darstellungen der Strings aus `__annotations__`. Die beiden Ausgaben `True` bestätigen, dass die aufgelösten Annotationen genau die Klassenobjekte `WorkItem` und `Module` sind.
Zugehörige Lektionen
- Python · Lektion 3 · Fortgeschritten · Version: 5
- Python · Lektion 7 · Fortgeschritten · Version: 5