CKTIS / Python
Annotation de type avec référence anticipée
En Python 3.12, une annotation de type entre guillemets peut désigner un nom qui ne devient disponible qu’après la définition de la fonction.
Version : Python 3.12
Syntaxe
def run_test(test: "Callable[[], None]") -> None:
test()En Python 3.12, sans from __future__ import annotations, les annotations d’une fonction sont évaluées à l’exécution de l’instruction def, et non à l’appel de la fonction. Un nom sans guillemets qui n’est pas encore disponible peut alors provoquer une exception NameError. Une annotation à référence anticipée peut s’écrire sous forme de chaîne, par exemple "Callable[[], None]", afin de résoudre l’expression de type plus tard.
Dans la signature de run_test, Callable[[], None] décrit un objet appelable qui n’accepte aucun argument ([]) et renvoie None. Le -> None distinct indique ce que renvoie run_test elle-même. Les guillemets ne signifient pas qu’il faut passer une chaîne, et Python ne vérifie pas automatiquement que l’argument respecte l’annotation.
run_test.__annotations__["test"] contient la chaîne. typing.get_type_hints(run_test) évalue l’expression dans l’espace de noms approprié et peut lever NameError si Callable reste introuvable. Si Callable est déjà disponible à l’exécution de def, les guillemets sont inutiles. Ne résolvez pas d’annotations provenant de sources non fiables : l’évaluation de leurs expressions peut exécuter du code.
Exemples
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)Résultat
'Callable[[], None]' True Test ran
L’import depuis `collections.abc` est volontairement placé après la définition de `run_test`. La première ligne affiche la représentation de la chaîne, `True` confirme que le type résolu correspond au type attendu, et `Test ran` est affiché par la fonction de test appelée.
Leçons associées
- Python · Leçon 26 · Débutant · Version : 3