WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

Typannotation mit Vorwärtsreferenz

In Python 3.12 kann eine Typannotation in Anführungszeichen auf einen Namen verweisen, der erst nach der Funktionsdefinition verfügbar ist.

Version: Python 3.12

Syntax

def run_test(test: "Callable[[], None]") -> None:
    test()

Ohne from __future__ import annotations werden Funktionsannotationen in Python 3.12 ausgewertet, wenn die def-Anweisung ausgeführt wird, nicht erst beim Funktionsaufruf. Ein nicht verfügbarer Name ohne Anführungszeichen kann dabei NameError auslösen. Bei einer Typannotation mit Vorwärtsreferenz lässt sich der Typausdruck als Zeichenfolge wie "Callable[[], None]" schreiben und später auflösen.

In der Signatur von run_test beschreibt Callable[[], None] ein aufrufbares Objekt, das keine Argumente ([]) entgegennimmt und None zurückgibt. Das separate -> None beschreibt den Rückgabewert von run_test selbst. Die Anführungszeichen bedeuten nicht, dass man eine Zeichenfolge übergeben soll. Python prüft nicht automatisch, ob das Argument zur Annotation passt.

run_test.__annotations__["test"] enthält die Zeichenfolge. typing.get_type_hints(run_test) wertet den Ausdruck im passenden Namensraum aus und kann NameError auslösen, wenn Callable noch fehlt. Ist Callable bei der Ausführung von def bereits verfügbar, sind die Anführungszeichen unnötig. Löse keine Annotationen aus nicht vertrauenswürdigen Quellen auf: Beim Auswerten der enthaltenen Ausdrücke kann Code ausgeführt werden.

Beispiele

from typing import get_type_hints


def run_test(test: "Callable[[], None]") -> None:
    test()


from collections.abc import Callable  # Deliberately imported after run_test.


def smoke_test() -> None:
    print("Test ran", end="")


print(repr(run_test.__annotations__["test"]))
print(get_type_hints(run_test)["test"] == Callable[[], None])
run_test(smoke_test)

Ergebnis

'Callable[[], None]'
True
Test ran

Der Import aus `collections.abc` steht absichtlich nach der Definition von `run_test`. Die erste Zeile zeigt die Darstellung der Zeichenfolge, `True` bestätigt die Übereinstimmung des aufgelösten Typs mit dem erwarteten Typ, und `Test ran` stammt aus der aufgerufenen Testfunktion.

Zugehörige Lektionen

  • Python · Lektion 26 · Grundlagen · Version: 3

Quellen