Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / Python

typing.TypedDict

Décrit un schéma de dictionnaire à clés textuelles connues et type de valeur propre à chaque champ.

Version : Python 3.14; repository image, production runtime not attested

Syntaxe

class Task(TypedDict): ...

Décrit un schéma de dictionnaire à clés textuelles connues et type de valeur propre à chaque champ.

Par défaut les clés sans NotRequired sont obligatoires. Le constructeur rend un dict ordinaire sans validation et isinstance avec la classe TypedDict lève TypeError. Depuis Python 3.13 ReadOnly marque un champ que le vérificateur interdit de modifier, indépendamment de sa présence obligatoire.

Le dictionnaire autorise l’écriture à l’exécution.

Exemples

from typing import TypedDict
class Point(TypedDict):
    x: int
    y: int
point = Point(x="other")
print(type(point) is dict, point, sorted(Point.__required_keys__))
try:
    isinstance(point, Point)
except TypeError:
    print("no instance check")
from typing import NotRequired, ReadOnly
class Label(TypedDict):
    id: ReadOnly[int]
    note: ReadOnly[NotRequired[str]]
label: Label = {"id": 1}
label["id"] = 2
assert Label.__readonly_keys__ == {"id", "note"}
assert Label.__required_keys__ == {"id"} and Label.__optional_keys__ == {"note"}
print(label)

Résultat

True {'x': 'other'} ['x', 'y']
no instance check
{'id': 2}

Le dictionnaire autorise l’écriture à l’exécution.

Sources