← retour aux snippets

typing.TypeAlias: déclarer un alias de type stable

Documenter explicitement un alias de type public.

python typing #typing#alias

objectif

Documenter explicitement un alias de type public.

code minimal

from typing import TypeAlias
UserName: TypeAlias = str
name: UserName = "Ada"
print(isinstance(name, str))  # attendu: True

utilisation

from typing import TypeAlias, Dict, Tuple
Point: TypeAlias = Tuple[int, int]
Graph: TypeAlias = Dict[int, Point]
g: Graph = {1: (0,0)}
print((1 in g) and isinstance(g[1][0], int))

variante(s) utile(s)

from typing import TypeAlias
print("TypeAlias" in str(TypeAlias))

notes

  • Rend explicite l’intention d’exposer un alias dans une API.
  • Utile avec les outils de documentation et linters.