# `typing` — Prise en charge des annotations de type

Nouveau dans la version 3.5.

Code source : Lib/typing.py

Note

Le moteur d'exécution Python n'applique pas les annotations de type pour les fonctions et les variables. Elles peuvent être utilisées par des outils tiers tels que les contrôleurs de type, les IDE, les analyseurs de code, etc.

Ce module fournit la gestion des annotations de type à l'exécution. La prise en compte de base comprend les types `Any`, `Union`, `Callable`, `TypeVar` et `Generic`. Pour les spécifications complètes, voir la PEP 484. Pour une introduction simplifiée aux annotations de type, voir la PEP 483.

La fonction ci-dessous prend et renvoie une chaîne de caractères, et est annotée comme suit :

    def greeting(name: str) -> str:
        return 'Hello ' + name

La fonction `greeting` s'attend à ce que l'argument `name` soit de type `str` et le type de retour `str`. Les sous-types sont acceptés comme arguments.

Le module `typing` est fréquemment enrichi de nouvelles fonctionnalités. Le package typing_extensions fournit des rétro-portages de ces fonctionnalités vers les anciennes versions de Python.

Voir aussi

For a quick overview of type hints, refer to this cheat sheet.

The "Type System Reference" section of https://mypy.readthedocs.io/ -- since the Python typing system is standardised via PEPs, this reference should broadly apply to most Python type checkers, although some parts may still be specific to mypy.

La documentation https://typing.readthedocs.io/ est une référence utile pour les fonctionnalités du système de types, les outils liés au typage et les bonnes pratiques de typage.La documentation sur https://typing.readthedocs.io/ sert de référence pour les fonctionnalités, les outils utiles et les meilleures pratiques liés au système de typage.

## PEPs pertinentes

Depuis l'introduction initiale des annotations de type dans les PEP 484 et PEP 483, plusieurs PEPs ont modifié et amélioré le framework d'annotation de type. Cela inclut :

- PEP 526 : Syntaxe pour les Annotations de Variables

    Introduction d'une syntaxe permettant d'annoter les variables autrement qu'au sein de la définition d'une fonction et de `ClassVar`

- PEP 544: Protocoles : Sous-typage Structurel (duck-typing statique)

    Ajout de `Protocol` et du décorateur `@runtime_checkable`

- PEP 585: Annotations de Type Générique dans les Collections Natives

    Ajout de `types.GenericAlias` et de la possibilité d'utiliser les classes de bibliothèques natives comme les types génériques

- PEP 586: Types Littéraux

    Ajout de `Literal`

- PEP 589: TypedDict: Annotations de Type pour les Dictionnaires ayant un Ensemble Fixe de Clés

    Ajout de `TypedDict`

- PEP 591: Ajout d'un qualificatif final au typage

    Ajout de `Final` et du décorateur `@final`

- PEP 593: fonction Flexible et annotations de variables

    Ajout de `Annotated`

- PEP 604: Permettre l'écriture de types union tels que `X | Y`

    Ajout de `types.UnionType` et la possibilité d'utiliser l'opérateur binaire `|` (ou) pour signifier union of types

- PEP 612: Variables de Spécification de Paramètre

    Ajout de `ParamSpec` et de `Concatenate`

- PEP 613: Explicit Type Aliases

    Ajout de `TypeAlias`

- PEP 647: Gardes de Types Définies par l'Utilisateur

    Ajout de `TypeGuard`

## Alias de type

A type alias is defined by assigning the type to the alias. In this example, `Vector` and `list[float]` will be treated as interchangeable synonyms:

    Vector = list[float]

    def scale(scalar: float, vector: Vector) -> Vector:
        return [scalar * num for num in vector]

    # passes type checking; a list of floats qualifies as a Vector.
    new_vector = scale(2.0, [1.0, -4.2, 5.4])

Les alias de type sont utiles pour simplifier les signatures complexes. Par exemple :

    from collections.abc import Sequence

    ConnectionOptions = dict[str, str]
    Address = tuple[str, int]
    Server = tuple[Address, ConnectionOptions]

    def broadcast_message(message: str, servers: Sequence[Server]) -> None:
        ...

    # The static type checker will treat the previous type signature as
    # being exactly equivalent to this one.
    def broadcast_message(
            message: str,
            servers: Sequence[tuple[tuple[str, int], dict[str, str]]]) -> None:
        ...

Notez que `None` comme indication de type est un cas particulier et est remplacé par `type(None)`.

## NewType

Utilisez la classe `NewType` pour créer des types distincts :

    from typing import NewType

    UserId = NewType('UserId', int)
    some_id = UserId(524313)

Le vérificateur de type statique traite le nouveau type comme s'il s'agissait d'une sous-classe du type original. C'est utile pour aider à détecter les erreurs logiques :

    def get_user_name(user_id: UserId) -> str:
        ...

    # passes type checking
    user_a = get_user_name(UserId(42351))

    # fails type checking; an int is not a UserId
    user_b = get_user_name(-1)

Vous pouvez toujours effectuer toutes les opérations applicables à un entier (type `int`) sur une variable de type `UserId`, mais le résultat sera toujours de type `int`. Ceci vous permet de passer un `UserId` partout où un `int` est attendu, mais vous empêche de créer accidentellement un `UserId` d'une manière invalide :

    # 'output' is of type 'int', not 'UserId'
    output = UserId(23413) + UserId(54341)

Notez que ces contrôles ne sont exécutés que par le vérificateur de types statique. À l'exécution, l'instruction `Derived = NewType('Derived', Base)` fait de `Derived` une fonction qui renvoie immédiatement le paramètre que vous lui passez. Cela signifie que l'expression `Derived(some_value)` ne crée pas une nouvelle classe et n'introduit pas de surcharge au-delà de celle d'un appel de fonction normal.

Plus précisément, l'expression `some_value is Derived(some_value)` est toujours vraie au moment de l'exécution.

La création d'un sous-type de `Derived` est invalide:

    from typing import NewType

    UserId = NewType('UserId', int)

    # Fails at runtime and does not pass type checking
    class AdminUserId(UserId): pass

Il est néanmoins possible de créer un `NewType` basé sur un `NewType` « dérivé » :

    from typing import NewType

    UserId = NewType('UserId', int)

    ProUserId = NewType('ProUserId', UserId)

et la vérification de type pour `ProUserId` fonctionne comme prévu.

Voir la PEP 484 pour plus de détails.

Note

Rappelons que l'utilisation d'un alias de type déclare que deux types sont équivalents l'un à l'autre. Écrire `Alias = Original` fait que le vérificateur de type statique traite `Alias` comme étant exactement équivalent à `Original` dans tous les cas. C'est utile lorsque vous voulez simplifier des signatures complexes.

En revanche, `NewType` déclare qu'un type est un sous-type d'un autre. Écrire `Derived = NewType('Derived', Original)` fait en sorte que le vérificateur de type statique traite `Derived` comme une sous-classe de `Original`, ce qui signifie qu'une valeur de type `Original` ne peut être utilisée dans les endroits où une valeur de type `Derived` est prévue. C'est utile lorsque vous voulez éviter les erreurs logiques avec un coût d'exécution minimal.

Nouveau dans la version 3.5.2.

Modifié dans la version 3.10: `NewType` est maintenant une classe (plutôt qu'une fonction). Cela entraine un coût supplémentaire en temps d'exécution lors d'un appel. Cependant, ce coût sera réduit dans la version 3.11.0.

## Appelable

Les cadriciels (frameworks en anglais) qui attendent des fonctions de rappel ayant des signatures spécifiques peuvent être typés en utilisant `Callable[[Arg1Type, Arg2Type], ReturnType]`.

Par exemple :

    from collections.abc import Callable

    def feeder(get_next_item: Callable[[], str]) -> None:
        # Body

    def async_query(on_success: Callable[[int], None],
                    on_error: Callable[[int, Exception], None]) -> None:
        # Body

    async def on_update(value: str) -> None:
        # Body
    callback: Callable[[str], Awaitable[None]] = on_update

Il est possible de déclarer le type de retour d'un appelable sans spécifier la signature de l'appel en indiquant des points de suspension à la liste des arguments dans l'indice de type : `Callable[..., ReturnType]`.

Les appelables qui prennent en argument d'autres appelables peuvent indiquer que leurs types de paramètres dépendent les uns des autres en utilisant `ParamSpec`. De plus, si un appelable ajoute ou supprime des arguments d'autres appelables, l'opérateur `Concatenate` peut être utilisé. Ils prennent la forme `Callable[ParamSpecVariable, ReturnType]` et `Callable[Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable], ReturnType]` respectivement.

Modifié dans la version 3.10: `Callable` prend désormais en charge `ParamSpec` et `Concatenate`. Voir PEP 612 pour plus de détails.

Voir aussi

La documentation pour `ParamSpec` et `Concatenate` fournit des exemples d'utilisation dans `Callable`.

## Génériques

Comme les informations de type sur les objets conservés dans des conteneurs ne peuvent pas être déduites statiquement de manière générique, les classes de base abstraites ont été étendues pour prendre en charge la sélection (subscription en anglais) et indiquer les types attendus pour les éléments de conteneur.

    from collections.abc import Mapping, Sequence

    def notify_by_email(employees: Sequence[Employee],
                        overrides: Mapping[str, str]) -> None: ...

Generics can be parameterized by using a factory available in typing called `TypeVar`.

    from collections.abc import Sequence
    from typing import TypeVar

    T = TypeVar('T')      # Declare type variable

    def first(l: Sequence[T]) -> T:   # Generic function
        return l[0]

## Types génériques définis par l'utilisateur

Une classe définie par l'utilisateur peut être définie comme une classe générique.

    from typing import TypeVar, Generic
    from logging import Logger

    T = TypeVar('T')

    class LoggedVar(Generic[T]):
        def __init__(self, value: T, name: str, logger: Logger) -> None:
            self.name = name
            self.logger = logger
            self.value = value

        def set(self, new: T) -> None:
            self.log('Set ' + repr(self.value))
            self.value = new

        def get(self) -> T:
            self.log('Get ' + repr(self.value))
            return self.value

        def log(self, message: str) -> None:
            self.logger.info('%s: %s', self.name, message)

`Generic[T]` en tant que classe de base définit que la classe `LoggedVar` prend un paramètre de type unique `T`. Ceci rend également `T` valide en tant que type dans le corps de la classe.

The `Generic` base class defines `__class_getitem__()` so that `LoggedVar[T]` is valid as a type:

    from collections.abc import Iterable

    def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None:
        for var in vars:
            var.set(0)

A generic type can have any number of type variables. All varieties of `TypeVar` are permissible as parameters for a generic type:

    from typing import TypeVar, Generic, Sequence

    T = TypeVar('T', contravariant=True)
    B = TypeVar('B', bound=Sequence[bytes], covariant=True)
    S = TypeVar('S', int, str)

    class WeirdTrio(Generic[T, B, S]):
        ...

Chaque argument de variable de type `Generic` doit être distinct. Ceci n'est donc pas valable :

    from typing import TypeVar, Generic
    ...

    T = TypeVar('T')

    class Pair(Generic[T, T]):   # INVALID
        ...

Vous pouvez utiliser l'héritage multiple avec `Generic` :

    from collections.abc import Sized
    from typing import TypeVar, Generic

    T = TypeVar('T')

    class LinkedList(Sized, Generic[T]):
        ...

Lors de l'héritage de classes génériques, certaines variables de type peuvent être corrigées :

    from collections.abc import Mapping
    from typing import TypeVar

    T = TypeVar('T')

    class MyDict(Mapping[str, T]):
        ...

Dans ce cas, `MyDict` a un seul paramètre, `T`.

L'utilisation d'une classe générique sans spécifier de paramètres de type suppose `Any` pour chaque position. Dans l'exemple suivant, `MyIterable` n'est pas générique mais hérite implicitement de `Iterable[Any]` :

    from collections.abc import Iterable

    class MyIterable(Iterable): # Same as Iterable[Any]

Les alias de type générique définis par l'utilisateur sont également pris en charge. Exemples :

    from collections.abc import Iterable
    from typing import TypeVar
    S = TypeVar('S')
    Response = Iterable[S] | int

    # Return type here is same as Iterable[str] | int
    def response(query: str) -> Response[str]:
        ...

    T = TypeVar('T', int, float, complex)
    Vec = Iterable[tuple[T, T]]

    def inproduct(v: Vec[T]) -> T: # Same as Iterable[tuple[T, T]]
        return sum(x*y for x, y in v)

Modifié dans la version 3.7: `Generic` n'a plus de métaclasse personnalisée.

User-defined generics for parameter expressions are also supported via parameter specification variables in the form `Generic[P]`. The behavior is consistent with type variables' described above as parameter specification variables are treated by the typing module as a specialized type variable. The one exception to this is that a list of types can be used to substitute a `ParamSpec`:

    >>> from typing import Generic, ParamSpec, TypeVar

    >>> T = TypeVar('T')
    >>> P = ParamSpec('P')

    >>> class Z(Generic[T, P]): ...
    ...
    >>> Z[int, [dict, float]]
    __main__.Z[int, (<class 'dict'>, <class 'float'>)]

Furthermore, a generic with only one parameter specification variable will accept parameter lists in the forms `X[[Type1, Type2, ...]]` and also `X[Type1, Type2, ...]` for aesthetic reasons. Internally, the latter is converted to the former, so the following are equivalent:

    >>> class X(Generic[P]): ...
    ...
    >>> X[int, str]
    __main__.X[(<class 'int'>, <class 'str'>)]
    >>> X[[int, str]]
    __main__.X[(<class 'int'>, <class 'str'>)]

Do note that generics with `ParamSpec` may not have correct `__parameters__` after substitution in some cases because they are intended primarily for static type checking.

Modifié dans la version 3.10: `Generic` can now be parameterized over parameter expressions. See `ParamSpec` and PEP 612 for more details.

A user-defined generic class can have ABCs as base classes without a metaclass conflict. Generic metaclasses are not supported. The outcome of parameterizing generics is cached, and most types in the typing module are hashable and comparable for equality.

## Le type `Any`

Un type particulier est `Any`. Un vérificateur de type statique traite chaque type comme étant compatible avec `Any` et `Any` comme étant compatible avec chaque type.

This means that it is possible to perform any operation or method call on a value of type `Any` and assign it to any variable:

    from typing import Any

    a: Any = None
    a = []          # OK
    a = 2           # OK

    s: str = ''
    s = a           # OK

    def foo(item: Any) -> int:
        # Passes type checking; 'item' could be any type,
        # and that type might have a 'bar' method
        item.bar()
        ...

Notice that no type checking is performed when assigning a value of type `Any` to a more precise type. For example, the static type checker did not report an error when assigning `a` to `s` even though `s` was declared to be of type `str` and receives an `int` value at runtime!

De plus, toutes les fonctions sans type de retour ni type de paramètre sont considérées comme utilisant `Any` implicitement par défaut :

    def legacy_parser(text):
        ...
        return data

    # A static type checker will treat the above
    # as having the same signature as:
    def legacy_parser(text: Any) -> Any:
        ...
        return data

Ce comportement permet à `Any` d'être utilisé comme succédané lorsque vous avez besoin de mélanger du code typé dynamiquement et statiquement.

Comparons le comportement de `Any` avec celui de `object`. De la même manière que pour `Any`, chaque type est un sous-type de `object`. Cependant, contrairement à `Any`, l'inverse n'est pas vrai : `object` n'est pas un sous-type de chaque autre type.

Cela signifie que lorsque le type d'une valeur est `object`, un vérificateur de type rejette presque toutes les opérations sur celle-ci, et l'affecter à une variable (ou l'utiliser comme une valeur de retour) d'un type plus spécialisé est une erreur de typage. Par exemple :

    def hash_a(item: object) -> int:
        # Fails type checking; an object does not have a 'magic' method.
        item.magic()
        ...

    def hash_b(item: Any) -> int:
        # Passes type checking
        item.magic()
        ...

    # Passes type checking, since ints and strs are subclasses of object
    hash_a(42)
    hash_a("foo")

    # Passes type checking, since Any is compatible with all types
    hash_b(42)
    hash_b("foo")

Utilisez `object` pour indiquer qu'une valeur peut être de n'importe quel type de manière sûre. Utiliser `Any` pour indiquer qu'une valeur est typée dynamiquement.

## Sous-typage nominal et sous-typage structurel

Initially PEP 484 defined the Python static type system as using nominal subtyping. This means that a class `A` is allowed where a class `B` is expected if and only if `A` is a subclass of `B`.

This requirement previously also applied to abstract base classes, such as `Iterable`. The problem with this approach is that a class had to be explicitly marked to support them, which is unpythonic and unlike what one would normally do in idiomatic dynamically typed Python code. For example, this conforms to PEP 484:

    from collections.abc import Sized, Iterable, Iterator

    class Bucket(Sized, Iterable[int]):
        ...
        def __len__(self) -> int: ...
        def __iter__(self) -> Iterator[int]: ...

La PEP 544 permet de résoudre ce problème en permettant aux utilisateurs d'écrire le code ci-dessus sans classes de base explicites dans la définition de classe, permettant à `Bucket` d'être implicitement considéré comme un sous-type de `Sized` et `Iterable[int]` par des vérificateurs de type statique. C'est ce qu'on appelle le sous-typage structurel (ou typage canard) :

    from collections.abc import Iterator, Iterable

    class Bucket:  # Note: no base classes
        ...
        def __len__(self) -> int: ...
        def __iter__(self) -> Iterator[int]: ...

    def collect(items: Iterable[int]) -> int: ...
    result = collect(Bucket())  # Passes type check

De plus, en sous-classant une classe spéciale `Protocol`, un utilisateur peut définir de nouveaux protocoles personnalisés pour profiter pleinement du sous-typage structurel (voir exemples ci-dessous).

## Classe de données

The module defines the following classes, functions and decorators.

Note

This module defines several types that are subclasses of pre-existing standard library classes which also extend `Generic` to support type variables inside `[]`. These types became redundant in Python 3.9 when the corresponding pre-existing classes were enhanced to support `[]`.

The redundant types are deprecated as of Python 3.9 but no deprecation warnings will be issued by the interpreter. It is expected that type checkers will flag the deprecated types when the checked program targets Python 3.9 or newer.

The deprecated types will be removed from the `typing` module in the first Python version released 5 years after the release of Python 3.9.0. See details in PEP 585—Type Hinting Generics In Standard Collections.

### Special typing primitives

#### Special types

These can be used as types in annotations and do not support `[]`.

`typing.``Any`

  Type spécial indiquant un type non contraint.

  - Chaque type est compatible avec `Any`.

  - `Any` est compatible avec tous les types.

`typing.``NoReturn`

  Type spécial indiquant qu'une fonction ne renvoie rien. Par exemple :

      from typing import NoReturn

      def stop() -> NoReturn:
          raise RuntimeError('no way')

  Nouveau dans la version 3.5.4.

  Nouveau dans la version 3.6.2.

`typing.``TypeAlias`

  Special annotation for explicitly declaring a type alias. For example:

      from typing import TypeAlias

      Factors: TypeAlias = list[int]

  See PEP 613 for more details about explicit type aliases.

  Nouveau dans la version 3.10.

#### Special forms

These can be used as types in annotations using `[]`, each having a unique syntax.

`typing.``Tuple`

  Type « n-uplet » ; `Tuple[X, Y]` est le type d'un n-uplet à deux éléments avec le premier élément de type X et le second de type Y. Le type du n-uplet vide peut être écrit comme `Tuple[()]`.

  Exemple : `Tuple[T1, T2]` est une paire correspondant aux variables de type `T1` et `T2`. `Tuple[int, float, str]` est un triplet composé d'un entier, d'un flottant et d'une chaîne de caractères.

  Pour spécifier un n-uplet de longueur variable et de type homogène, utilisez une ellipse, par exemple `Tuple[int, ....]`. Un n-uplet `Tuple` est équivalent à `Tuple[Any, ....]` et, à son tour, à `tuple`.

  Obsolète depuis la version 3.9: `builtins.tuple` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

`typing.``Union`

  Union type; `Union[X, Y]` is equivalent to `X | Y` and means either X or Y.

  To define a union, use e.g. `Union[int, str]` or the shorthand `int | str`. Using that shorthand is recommended. Details:

  - Les arguments doivent être des types et il doit y en avoir au moins un.

  - Les unions d'unions sont aplanies, par exemple :

        Union[Union[int, str], float] == Union[int, str, float]

  - Les unions d'un seul argument disparaissent, par exemple :

        Union[int] == int  # The constructor actually returns int

  - Les arguments redondants sont ignorés, par exemple :

        Union[int, str, int] == Union[int, str] == int | str

  - Lors de la comparaison d'unions, l'ordre des arguments est ignoré, par exemple :

        Union[int, str] == Union[str, int]

  - You cannot subclass or instantiate a `Union`.

  - Vous ne pouvez pas écrire `Union[X][Y]`.

  Modifié dans la version 3.7: Ne supprime pas les sous-classes explicites des unions à l'exécution.

  Modifié dans la version 3.10: Unions can now be written as `X | Y`. See union type expressions.

`typing.``Optional`

  Type « optionnel ».

  `Optional[X]` is equivalent to `X | None` (or `Union[X, None]`).

  Notez que ce n'est pas le même concept qu'un argument optionnel, qui est un argument qui possède une valeur par défaut. Un argument optionnel (qui a une valeur par défaut) ne nécessite pas, à ce titre, le qualificatif `Optional` sur son annotation de type. Par exemple :

      def foo(arg: int = 0) -> None:
          ...

  Par contre, si une valeur explicite de `None` est permise, l'utilisation de `Optional` est appropriée, que l'argument soit facultatif ou non. Par exemple :

      def foo(arg: Optional[int] = None) -> None:
          ...

  Modifié dans la version 3.10: Optional can now be written as `X | None`. See union type expressions.

`typing.``Callable`

  Type Appelable. `Callable[[int], str]` est une fonction de type `(int) -> str`.

  La syntaxe de sélection (subscription en anglais) doit toujours être utilisée avec exactement deux valeurs : la liste d'arguments et le type de retour. La liste d'arguments doit être une liste de types ou une ellipse ; il doit y avoir un seul type de retour.

  Il n'y a pas de syntaxe pour indiquer les arguments optionnels ou les arguments par mots-clés ; de tels types de fonctions sont rarement utilisés comme types de rappel. `Callable[..., ReturnType]` (ellipse) peut être utilisé pour annoter le type d'un appelable, prenant un nombre quelconque d'arguments et renvoyant `ReturnType`. Un simple `Callable` est équivalent à `Callable[..., Any]` et, à son tour, à `collections.abc.Callable`.

  Les appelables qui prennent en argument d'autres appelables peuvent indiquer que leurs types de paramètres dépendent les uns des autres en utilisant `ParamSpec`. De plus, si un appelable ajoute ou supprime des arguments d'autres appelables, l'opérateur `Concatenate` peut être utilisé. Ils prennent la forme `Callable[ParamSpecVariable, ReturnType]` et `Callable[Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable], ReturnType]` respectivement.

  Obsolète depuis la version 3.9: `collections.abc.Callable` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

  Modifié dans la version 3.10: `Callable` prend désormais en charge `ParamSpec` et `Concatenate`. Voir PEP 612 pour plus de détails.

  Voir aussi

  The documentation for `ParamSpec` and `Concatenate` provide examples of usage with `Callable`.

`typing.``Concatenate`

  Used with `Callable` and `ParamSpec` to type annotate a higher order callable which adds, removes, or transforms parameters of another callable. Usage is in the form `Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable]`. `Concatenate` is currently only valid when used as the first argument to a `Callable`. The last parameter to `Concatenate` must be a `ParamSpec`.

  For example, to annotate a decorator `with_lock` which provides a `threading.Lock` to the decorated function, `Concatenate` can be used to indicate that `with_lock` expects a callable which takes in a `Lock` as the first argument, and returns a callable with a different type signature. In this case, the `ParamSpec` indicates that the returned callable's parameter types are dependent on the parameter types of the callable being passed in:

      from collections.abc import Callable
      from threading import Lock
      from typing import Concatenate, ParamSpec, TypeVar

      P = ParamSpec('P')
      R = TypeVar('R')

      # Use this lock to ensure that only one thread is executing a function
      # at any time.
      my_lock = Lock()

      def with_lock(f: Callable[Concatenate[Lock, P], R]) -> Callable[P, R]:
          '''A type-safe decorator which provides a lock.'''
          def inner(*args: P.args, **kwargs: P.kwargs) -> R:
              # Provide the lock as the first argument.
              return f(my_lock, *args, **kwargs)
          return inner

      @with_lock
      def sum_threadsafe(lock: Lock, numbers: list[float]) -> float:
          '''Add a list of numbers together in a thread-safe manner.'''
          with lock:
              return sum(numbers)

      # We don't need to pass in the lock ourselves thanks to the decorator.
      sum_threadsafe([1.1, 2.2, 3.3])

Nouveau dans la version 3.10.

Voir aussi

- PEP 612 -- Parameter Specification Variables (the PEP which introduced `ParamSpec` and `Concatenate`).

- `ParamSpec` and `Callable`.

class `typing.``Type`(Generic[CT_co])

  Une variable annotée de `C` peut accepter une valeur de type `C`. En revanche, une variable annotée avec `Type[C]` peut accepter des valeurs qui sont elles-mêmes des classes — plus précisément, elle accepte l'objet class de `C`. Par exemple :

      a = 3         # Has type 'int'
      b = int       # Has type 'Type[int]'
      c = type(a)   # Also has type 'Type[int]'

  Notez que `Type[C]` est covariant :

      class User: ...
      class BasicUser(User): ...
      class ProUser(User): ...
      class TeamUser(User): ...

      # Accepts User, BasicUser, ProUser, TeamUser, ...
      def make_new_user(user_class: Type[User]) -> User:
          # ...
          return user_class()

  Le fait que `Type[C]` soit covariant implique que toutes les sous-classes de `C` doivent implémenter la même signature de constructeur et les signatures de méthode de classe que `C`. Le vérificateur de type doit signaler les manquements à cette règle. Il doit également autoriser les appels du constructeur dans les sous-classes qui correspondent aux appels du constructeur dans la classe de base indiquée. La façon dont le vérificateur de type est tenu de traiter ce cas particulier peut changer dans les futures révisions de PEP 484.

  Les seuls paramètres légitimes pour `Type` sont les classes, `Any`, type variables, et les unions de ces types. Par exemple :

      def new_non_team_user(user_class: Type[BasicUser | ProUser]): ...

  `Type[Any]` est équivalent à `Type` qui à son tour est équivalent à `type`, qui est la racine de la hiérarchie des métaclasses de Python.

  Nouveau dans la version 3.5.2.

  Obsolète depuis la version 3.9: `builtins.type` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

`typing.``Literal`

  Type pour indiquer aux vérificateurs de type que la variable ou le paramètre de fonction correspondant a une valeur équivalente au littéral fourni (ou un parmi plusieurs littéraux). Par exemple :

      def validate_simple(data: Any) -> Literal[True]:  # always returns True
          ...

      MODE = Literal['r', 'rb', 'w', 'wb']
      def open_helper(file: str, mode: MODE) -> str:
          ...

      open_helper('/some/path', 'r')  # Passes type check
      open_helper('/other/path', 'typo')  # Error in type checker

  `Literal[...]` ne peut être sous-classé. Lors de l'exécution, une valeur arbitraire est autorisée comme argument de type pour `Literal[...]`, mais les vérificateurs de type peuvent imposer des restrictions. Voir la PEP 586 pour plus de détails sur les types littéraux.

  Nouveau dans la version 3.8.

  Modifié dans la version 3.9.1: `Literal` now de-duplicates parameters. Equality comparisons of `Literal` objects are no longer order dependent. `Literal` objects will now raise a `TypeError` exception during equality comparisons if one of their parameters are not hashable.

`typing.``ClassVar`

  Construction de type particulière pour indiquer les variables de classe.

  Telle qu'introduite dans la PEP 526, une annotation de variable enveloppée dans ClassVar indique qu'un attribut donné est destiné à être utilisé comme une variable de classe et ne doit pas être défini sur des instances de cette classe. Utilisation :

      class Starship:
          stats: ClassVar[dict[str, int]] = {} # class variable
          damage: int = 10                     # instance variable

  `ClassVar` n'accepte que les types et ne peut plus être dérivé.

  `ClassVar` n'est pas une classe en soi, et ne devrait pas être utilisée avec `isinstance()` ou `issubclass()`. `ClassVar` ne modifie pas le comportement d'exécution Python, mais il peut être utilisé par des vérificateurs tiers. Par exemple, un vérificateur de type peut marquer le code suivant comme une erreur :

      enterprise_d = Starship(3000)
      enterprise_d.stats = {} # Error, setting class variable on instance
      Starship.stats = {}     # This is OK

  Nouveau dans la version 3.5.3.

`typing.``Final`

  Construction de type particulière pour indiquer aux vérificateurs de type qu'un nom ne peut pas être réassigné ou remplacé dans une sous-classe. Par exemple :

      MAX_SIZE: Final = 9000
      MAX_SIZE += 1  # Error reported by type checker

      class Connection:
          TIMEOUT: Final[int] = 10

      class FastConnector(Connection):
          TIMEOUT = 1  # Error reported by type checker

  Ces propriétés ne sont pas vérifiées à l'exécution. Voir la PEP 591 pour plus de détails.

  Nouveau dans la version 3.8.

`typing.``Annotated`

  A type, introduced in PEP 593 (`Flexible function and variable annotations`), to decorate existing types with context-specific metadata (possibly multiple pieces of it, as `Annotated` is variadic). Specifically, a type `T` can be annotated with metadata `x` via the typehint `Annotated[T, x]`. This metadata can be used for either static analysis or at runtime. If a library (or tool) encounters a typehint `Annotated[T, x]` and has no special logic for metadata `x`, it should ignore it and simply treat the type as `T`. Unlike the `no_type_check` functionality that currently exists in the `typing` module which completely disables typechecking annotations on a function or a class, the `Annotated` type allows for both static typechecking of `T` (which can safely ignore `x`) together with runtime access to `x` within a specific application.

  Ultimately, the responsibility of how to interpret the annotations (if at all) is the responsibility of the tool or library encountering the `Annotated` type. A tool or library encountering an `Annotated` type can scan through the annotations to determine if they are of interest (e.g., using `isinstance()`).

  When a tool or a library does not support annotations or encounters an unknown annotation it should just ignore it and treat annotated type as the underlying type.

  It's up to the tool consuming the annotations to decide whether the client is allowed to have several annotations on one type and how to merge those annotations.

  Since the `Annotated` type allows you to put several annotations of the same (or different) type(s) on any node, the tools or libraries consuming those annotations are in charge of dealing with potential duplicates. For example, if you are doing value range analysis you might allow this:

      T1 = Annotated[int, ValueRange(-10, 5)]
      T2 = Annotated[T1, ValueRange(-20, 3)]

  Passing `include_extras=True` to `get_type_hints()` lets one access the extra annotations at runtime.

  The details of the syntax:

  - The first argument to `Annotated` must be a valid type

  - Multiple type annotations are supported (`Annotated` supports variadic arguments):

        Annotated[int, ValueRange(3, 10), ctype("char")]

  - `Annotated` must be called with at least two arguments ( `Annotated[int]` is not valid)

  - The order of the annotations is preserved and matters for equality checks:

        Annotated[int, ValueRange(3, 10), ctype("char")] != Annotated[
            int, ctype("char"), ValueRange(3, 10)
        ]

  - Nested `Annotated` types are flattened, with metadata ordered starting with the innermost annotation:

        Annotated[Annotated[int, ValueRange(3, 10)], ctype("char")] == Annotated[
            int, ValueRange(3, 10), ctype("char")
        ]

  - Duplicated annotations are not removed:

        Annotated[int, ValueRange(3, 10)] != Annotated[
            int, ValueRange(3, 10), ValueRange(3, 10)
        ]

  - `Annotated` can be used with nested and generic aliases:

        T = TypeVar('T')
        Vec = Annotated[list[tuple[T, T]], MaxLen(10)]
        V = Vec[int]

        V == Annotated[list[tuple[int, int]], MaxLen(10)]

  Nouveau dans la version 3.9.

`typing.``TypeGuard`

  Special typing form used to annotate the return type of a user-defined type guard function. `TypeGuard` only accepts a single type argument. At runtime, functions marked this way should return a boolean.

  `TypeGuard` aims to benefit type narrowing -- a technique used by static type checkers to determine a more precise type of an expression within a program's code flow. Usually type narrowing is done by analyzing conditional code flow and applying the narrowing to a block of code. The conditional expression here is sometimes referred to as a "type guard":

      def is_str(val: str | float):
          # "isinstance" type guard
          if isinstance(val, str):
              # Type of ``val`` is narrowed to ``str``
              ...
          else:
              # Else, type of ``val`` is narrowed to ``float``.
              ...

  Sometimes it would be convenient to use a user-defined boolean function as a type guard. Such a function should use `TypeGuard[...]` as its return type to alert static type checkers to this intention.

  Using `-> TypeGuard` tells the static type checker that for a given function:

  1. The return value is a boolean.

  2. If the return value is `True`, the type of its argument is the type inside `TypeGuard`.

  Par exemple :

      def is_str_list(val: List[object]) -> TypeGuard[List[str]]:
          '''Determines whether all objects in the list are strings'''
          return all(isinstance(x, str) for x in val)

      def func1(val: List[object]):
          if is_str_list(val):
              # Type of ``val`` is narrowed to ``List[str]``.
              print(" ".join(val))
          else:
              # Type of ``val`` remains as ``List[object]``.
              print("Not a list of strings!")

  If `is_str_list` is a class or instance method, then the type in `TypeGuard` maps to the type of the second parameter after `cls` or `self`.

  In short, the form `def foo(arg: TypeA) -> TypeGuard[TypeB]: ...`, means that if `foo(arg)` returns `True`, then `arg` narrows from `TypeA` to `TypeB`.

  Note

  `TypeB` need not be a narrower form of `TypeA` -- it can even be a wider form. The main reason is to allow for things like narrowing `List[object]` to `List[str]` even though the latter is not a subtype of the former, since `List` is invariant. The responsibility of writing type-safe type guards is left to the user.

  `TypeGuard` also works with type variables. See PEP 647 for more details.

  Nouveau dans la version 3.10.

#### Building generic types

These are not used in annotations. They are building blocks for creating generic types.

class `typing.``Generic`

  Classe de base abstraite pour les types génériques.

  Un type générique est généralement déclaré en héritant d'une instanciation de cette classe avec une ou plusieurs variables de type. Par exemple, un type de correspondance générique peut être défini comme suit :

      class Mapping(Generic[KT, VT]):
          def __getitem__(self, key: KT) -> VT:
              ...
              # Etc.

  Cette classe peut alors être utilisée comme suit :

      X = TypeVar('X')
      Y = TypeVar('Y')

      def lookup_name(mapping: Mapping[X, Y], key: X, default: Y) -> Y:
          try:
              return mapping[key]
          except KeyError:
              return default

class `typing.``TypeVar`

  Variables de type.

  Utilisation :

      T = TypeVar('T')  # Can be anything
      S = TypeVar('S', bound=str)  # Can be any subtype of str
      A = TypeVar('A', str, bytes)  # Must be exactly str or bytes

  Type variables exist primarily for the benefit of static type checkers. They serve as the parameters for generic types as well as for generic function definitions. See `Generic` for more information on generic types. Generic functions work as follows:

      def repeat(x: T, n: int) -> Sequence[T]:
          """Return a list containing n references to x."""
          return [x]*n

      def print_capitalized(x: S) -> S:
          """Print x capitalized, and return x."""
          print(x.capitalize())
          return x

      def concatenate(x: A, y: A) -> A:
          """Add two strings or bytes objects together."""
          return x + y

  Note that type variables can be bound, constrained, or neither, but cannot be both bound and constrained.

  Constrained type variables and bound type variables have different semantics in several important ways. Using a constrained type variable means that the `TypeVar` can only ever be solved as being exactly one of the constraints given:

      a = concatenate('one', 'two')  # Ok, variable 'a' has type 'str'
      b = concatenate(StringSubclass('one'), StringSubclass('two'))  # Inferred type of variable 'b' is 'str',
                                                                     # despite 'StringSubclass' being passed in
      c = concatenate('one', b'two')  # error: type variable 'A' can be either 'str' or 'bytes' in a function call, but not both

  Using a bound type variable, however, means that the `TypeVar` will be solved using the most specific type possible:

      print_capitalized('a string')  # Ok, output has type 'str'

      class StringSubclass(str):
          pass

      print_capitalized(StringSubclass('another string'))  # Ok, output has type 'StringSubclass'
      print_capitalized(45)  # error: int is not a subtype of str

  Type variables can be bound to concrete types, abstract types (ABCs or protocols), and even unions of types:

      U = TypeVar('U', bound=str|bytes)  # Can be any subtype of the union str|bytes
      V = TypeVar('V', bound=SupportsAbs)  # Can be anything with an __abs__ method

  Bound type variables are particularly useful for annotating `classmethods` that serve as alternative constructors. In the following example (by Raymond Hettinger), the type variable `C` is bound to the `Circle` class through the use of a forward reference. Using this type variable to annotate the `with_circumference` classmethod, rather than hardcoding the return type as `Circle`, means that a type checker can correctly infer the return type even if the method is called on a subclass:

      import math

      C = TypeVar('C', bound='Circle')

      class Circle:
          """An abstract circle"""

          def __init__(self, radius: float) -> None:
              self.radius = radius

          # Use a type variable to show that the return type
          # will always be an instance of whatever ``cls`` is
          @classmethod
          def with_circumference(cls: type[C], circumference: float) -> C:
              """Create a circle with the specified circumference"""
              radius = circumference / (math.pi * 2)
              return cls(radius)

      class Tire(Circle):
          """A specialised circle (made out of rubber)"""

          MATERIAL = 'rubber'

      c = Circle.with_circumference(3)  # Ok, variable 'c' has type 'Circle'
      t = Tire.with_circumference(4)  # Ok, variable 't' has type 'Tire' (not 'Circle')

  Au moment de l'exécution, `isinstance(x, T)` va lever `TypeError`. En général, `isinstance()` et `issubclass()` ne devraient pas être utilisés avec les types.

  Type variables may be marked covariant or contravariant by passing `covariant=True` or `contravariant=True`. See PEP 484 for more details. By default, type variables are invariant.

class `typing.``ParamSpec`(name, *, bound=None, covariant=False, contravariant=False)

  Parameter specification variable. A specialized version of `type variables`.

  Utilisation :

      P = ParamSpec('P')

  Parameter specification variables exist primarily for the benefit of static type checkers. They are used to forward the parameter types of one callable to another callable -- a pattern commonly found in higher order functions and decorators. They are only valid when used in `Concatenate`, or as the first argument to `Callable`, or as parameters for user-defined Generics. See `Generic` for more information on generic types.

  For example, to add basic logging to a function, one can create a decorator `add_logging` to log function calls. The parameter specification variable tells the type checker that the callable passed into the decorator and the new callable returned by it have inter-dependent type parameters:

      from collections.abc import Callable
      from typing import TypeVar, ParamSpec
      import logging

      T = TypeVar('T')
      P = ParamSpec('P')

      def add_logging(f: Callable[P, T]) -> Callable[P, T]:
          '''A type-safe decorator to add logging to a function.'''
          def inner(*args: P.args, **kwargs: P.kwargs) -> T:
              logging.info(f'{f.__name__} was called')
              return f(*args, **kwargs)
          return inner

      @add_logging
      def add_two(x: float, y: float) -> float:
          '''Add two numbers together.'''
          return x + y

  Without `ParamSpec`, the simplest way to annotate this previously was to use a `TypeVar` with bound `Callable[..., Any]`. However this causes two problems:

  1. The type checker can't type check the `inner` function because `*args` and `**kwargs` have to be typed `Any`.

  2. `cast()` may be required in the body of the `add_logging` decorator when returning the `inner` function, or the static type checker must be told to ignore the `return inner`.

  `args`
  `kwargs`

    Since `ParamSpec` captures both positional and keyword parameters, `P.args` and `P.kwargs` can be used to split a `ParamSpec` into its components. `P.args` represents the tuple of positional parameters in a given call and should only be used to annotate `*args`. `P.kwargs` represents the mapping of keyword parameters to their values in a given call, and should be only be used to annotate `**kwargs`. Both attributes require the annotated parameter to be in scope. At runtime, `P.args` and `P.kwargs` are instances respectively of `ParamSpecArgs` and `ParamSpecKwargs`.

  Parameter specification variables created with `covariant=True` or `contravariant=True` can be used to declare covariant or contravariant generic types. The `bound` argument is also accepted, similar to `TypeVar`. However the actual semantics of these keywords are yet to be decided.

  Nouveau dans la version 3.10.

  Note

  Only parameter specification variables defined in global scope can be pickled.

  Voir aussi

  - PEP 612 -- Parameter Specification Variables (the PEP which introduced `ParamSpec` and `Concatenate`).

  - `Callable` and `Concatenate`.

`typing.``ParamSpecArgs`

`typing.``ParamSpecKwargs`

  Arguments and keyword arguments attributes of a `ParamSpec`. The `P.args` attribute of a `ParamSpec` is an instance of `ParamSpecArgs`, and `P.kwargs` is an instance of `ParamSpecKwargs`. They are intended for runtime introspection and have no special meaning to static type checkers.

  Calling `get_origin()` on either of these objects will return the original `ParamSpec`:

      P = ParamSpec("P")
      get_origin(P.args)  # returns P
      get_origin(P.kwargs)  # returns P

  Nouveau dans la version 3.10.

`typing.``AnyStr`

  `AnyStr` is a `constrained type variable` defined as `AnyStr = TypeVar('AnyStr', str, bytes)`.

  Cela est destiné à être utilisé pour des fonctions qui peuvent accepter n'importe quel type de chaîne de caractères sans permettre à différents types de chaînes de caractères de se mélanger. Par exemple :

      def concat(a: AnyStr, b: AnyStr) -> AnyStr:
          return a + b

      concat(u"foo", u"bar")  # Ok, output has type 'unicode'
      concat(b"foo", b"bar")  # Ok, output has type 'bytes'
      concat(u"foo", b"bar")  # Error, cannot mix unicode and bytes

class `typing.``Protocol`(Generic)

  Classe de base pour les classes de protocole. Les classes de protocole sont définies comme suit :

      class Proto(Protocol):
          def meth(self) -> int:
              ...

  Ces classes sont principalement utilisées avec les vérificateurs statiques de type qui reconnaissent les sous-types structurels (typage canard statique), par exemple :

      class C:
          def meth(self) -> int:
              return 0

      def func(x: Proto) -> int:
          return x.meth()

      func(C())  # Passes static type check

  See PEP 544 for more details. Protocol classes decorated with `runtime_checkable()` (described later) act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures.

  Les classes de protocole peuvent être génériques, par exemple :

      class GenProto(Protocol[T]):
          def meth(self) -> T:
              ...

  Nouveau dans la version 3.8.

`@``typing.``runtime_checkable`

  Marquez une classe de protocole comme protocole d'exécution.

  Such a protocol can be used with `isinstance()` and `issubclass()`. This raises `TypeError` when applied to a non-protocol class. This allows a simple-minded structural check, very similar to "one trick ponies" in `collections.abc` such as `Iterable`. For example:

      @runtime_checkable
      class Closable(Protocol):
          def close(self): ...

      assert isinstance(open('/some/file'), Closable)

      @runtime_checkable
      class Named(Protocol):
          name: str

      import threading
      assert isinstance(threading.Thread(name='Bob'), Named)

  Note

  `runtime_checkable()` will check only the presence of the required methods or attributes, not their type signatures or types. For example, `ssl.SSLObject` is a class, therefore it passes an `issubclass()` check against `Callable`. However, the `ssl.SSLObject.__init__` method exists only to raise a `TypeError` with a more informative message, therefore making it impossible to call (instantiate) `ssl.SSLObject`.

  Note

  An `isinstance()` check against a runtime-checkable protocol can be surprisingly slow compared to an `isinstance()` check against a non-protocol class. Consider using alternative idioms such as `hasattr()` calls for structural checks in performance-sensitive code.

  Nouveau dans la version 3.8.

#### Other special directives

These are not used in annotations. They are building blocks for declaring types.

class `typing.``NamedTuple`

  Version typée de `collections.namedtuple()`.

  Utilisation :

      class Employee(NamedTuple):
          name: str
          id: int

  Ce qui est équivalent à :

      Employee = collections.namedtuple('Employee', ['name', 'id'])

  Pour assigner une valeur par défaut à un champ, vous pouvez lui donner dans le corps de classe :

      class Employee(NamedTuple):
          name: str
          id: int = 3

      employee = Employee('Guido')
      assert employee.id == 3

  Les champs avec une valeur par défaut doivent venir après tous les champs sans valeur par défaut.

  The resulting class has an extra attribute `__annotations__` giving a dict that maps the field names to the field types. (The field names are in the `_fields` attribute and the default values are in the `_field_defaults` attribute, both of which are part of the `namedtuple()` API.)

  Les sous-classes de `NamedTuple` peuvent aussi avoir des docstrings et des méthodes :

      class Employee(NamedTuple):
          """Represents an employee."""
          name: str
          id: int = 3

          def __repr__(self) -> str:
              return f'<Employee {self.name}, id={self.id}>'

  Utilisation rétrocompatible :

      Employee = NamedTuple('Employee', [('name', str), ('id', int)])

  Modifié dans la version 3.6: Ajout de la gestion de la syntaxe d'annotation variable de la PEP 526.

  Modifié dans la version 3.6.1: Ajout de la prise en charge des valeurs par défaut, des méthodes et des chaînes de caractères docstrings.

  Modifié dans la version 3.8: Les attributs `_field_types` et `__annotations__` sont maintenant des dictionnaires standards au lieu d'instances de `OrderedDict`.

  Modifié dans la version 3.9: rend l'attribut `_field_types` obsolète en faveur de l'attribut plus standard `__annotations__` qui a la même information.

class `typing.``NewType`(name, tp)

  A helper class to indicate a distinct type to a typechecker, see NewType. At runtime it returns an object that returns its argument when called. Usage:

      UserId = NewType('UserId', int)
      first_user = UserId(1)

  Nouveau dans la version 3.5.2.

  Modifié dans la version 3.10: `NewType` is now a class rather than a function.

class `typing.``TypedDict`(dict)

  Special construct to add type hints to a dictionary. At runtime it is a plain `dict`.

  `TypedDict` declares a dictionary type that expects all of its instances to have a certain set of keys, where each key is associated with a value of a consistent type. This expectation is not checked at runtime but is only enforced by type checkers. Usage:

      class Point2D(TypedDict):
          x: int
          y: int
          label: str

      a: Point2D = {'x': 1, 'y': 2, 'label': 'good'}  # OK
      b: Point2D = {'z': 3, 'label': 'bad'}           # Fails type check

      assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')

  To allow using this feature with older versions of Python that do not support PEP 526, `TypedDict` supports two additional equivalent syntactic forms:

      Point2D = TypedDict('Point2D', x=int, y=int, label=str)
      Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})

  The functional syntax should also be used when any of the keys are not valid identifiers, for example because they are keywords or contain hyphens. Example:

      # raises SyntaxError
      class Point2D(TypedDict):
          in: int  # 'in' is a keyword
          x-y: int  # name with hyphens

      # OK, functional syntax
      Point2D = TypedDict('Point2D', {'in': int, 'x-y': int})

  By default, all keys must be present in a `TypedDict`. It is possible to override this by specifying totality. Usage:

      class Point2D(TypedDict, total=False):
          x: int
          y: int

  This means that a `Point2D` `TypedDict` can have any of the keys omitted. A type checker is only expected to support a literal `False` or `True` as the value of the `total` argument. `True` is the default, and makes all items defined in the class body required.

  It is possible for a `TypedDict` type to inherit from one or more other `TypedDict` types using the class-based syntax. Usage:

      class Point3D(Point2D):
          z: int

  `Point3D` has three items: `x`, `y` and `z`. It is equivalent to this definition:

      class Point3D(TypedDict):
          x: int
          y: int
          z: int

  A `TypedDict` cannot inherit from a non-`TypedDict` class, notably including `Generic`. For example:

      class X(TypedDict):
          x: int

      class Y(TypedDict):
          y: int

      class Z(object): pass  # A non-TypedDict class

      class XY(X, Y): pass  # OK

      class XZ(X, Z): pass  # raises TypeError

      T = TypeVar('T')
      class XT(X, Generic[T]): pass  # raises TypeError

  A `TypedDict` can be introspected via annotations dicts (see Bonnes pratiques concernant les annotations for more information on annotations best practices), `__total__`, `__required_keys__`, and `__optional_keys__`.

  `__total__`

    `Point2D.__total__` gives the value of the `total` argument. Example:

        >>> from typing import TypedDict
        >>> class Point2D(TypedDict): pass
        >>> Point2D.__total__
        True
        >>> class Point2D(TypedDict, total=False): pass
        >>> Point2D.__total__
        False
        >>> class Point3D(Point2D): pass
        >>> Point3D.__total__
        True

  `__required_keys__`

    Nouveau dans la version 3.9.

  `__optional_keys__`

    `Point2D.__required_keys__` and `Point2D.__optional_keys__` return `frozenset` objects containing required and non-required keys, respectively. Currently the only way to declare both required and non-required keys in the same `TypedDict` is mixed inheritance, declaring a `TypedDict` with one value for the `total` argument and then inheriting it from another `TypedDict` with a different value for `total`. Usage:

        >>> class Point2D(TypedDict, total=False):
        ...     x: int
        ...     y: int
        ...
        >>> class Point3D(Point2D):
        ...     z: int
        ...
        >>> Point3D.__required_keys__ == frozenset({'z'})
        True
        >>> Point3D.__optional_keys__ == frozenset({'x', 'y'})
        True

    Nouveau dans la version 3.9.

  See PEP 589 for more examples and detailed rules of using `TypedDict`.

  Nouveau dans la version 3.8.

### Generic concrete collections

#### Corresponding to built-in types

class `typing.``Dict`(dict, MutableMapping[KT, VT])

  Une version générique de `dict`. Utile pour annoter les types de retour. Pour annoter les arguments, il est préférable d'utiliser un type de collection abstraite tel que `Mapping`.

  Ce type peut être utilisé comme suit :

      def count_words(text: str) -> Dict[str, int]:
          ...

  Obsolète depuis la version 3.9: `builtins.dict` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``List`(list, MutableSequence[T])

  Version générique de `list`. Utile pour annoter les types de retour. Pour annoter les arguments, il est préférable d'utiliser un type de collection abstraite tel que `Sequence` ou `Iterable`.

  Ce type peut être utilisé comme suit :

      T = TypeVar('T', int, float)

      def vec2(x: T, y: T) -> List[T]:
          return [x, y]

      def keep_positives(vector: Sequence[T]) -> List[T]:
          return [item for item in vector if item > 0]

  Obsolète depuis la version 3.9: `builtins.list` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Set`(set, MutableSet[T])

  Une version générique de `builtins.set`. Utile pour annoter les types de retour. Pour annoter les arguments, il est préférable d'utiliser un type de collection abstraite tel que `AbstractSet`.

  Obsolète depuis la version 3.9: `builtins.set` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``FrozenSet`(frozenset, AbstractSet[T_co])

  Une version générique de `builtins.frozenset`.

  Obsolète depuis la version 3.9: `builtins.frozenset` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

Note

`Tuple` is a special form.

#### Corresponding to types in `collections`

class `typing.``DefaultDict`(collections.defaultdict, MutableMapping[KT, VT])

  Une version générique de `collections.defaultdict`.

  Nouveau dans la version 3.5.2.

  Obsolète depuis la version 3.9: `collections.defaultdict` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``OrderedDict`(collections.OrderedDict, MutableMapping[KT, VT])

  Une version générique de `collections.OrderedDict`.

  Nouveau dans la version 3.7.2.

  Obsolète depuis la version 3.9: `collections.OrderedDict` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``ChainMap`(collections.ChainMap, MutableMapping[KT, VT])

  Une version générique de `collections.ChainMap`.

  Nouveau dans la version 3.5.4.

  Nouveau dans la version 3.6.1.

  Obsolète depuis la version 3.9: `collections.ChainMap` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Counter`(collections.Counter, Dict[T, int])

  Une version générique de `collections.Counter`.

  Nouveau dans la version 3.5.4.

  Nouveau dans la version 3.6.1.

  Obsolète depuis la version 3.9: `collections.Counter` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Deque`(deque, MutableSequence[T])

  Une version générique de `collections.deque`.

  Nouveau dans la version 3.5.4.

  Nouveau dans la version 3.6.1.

  Obsolète depuis la version 3.9: `collections.deque` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

#### Other concrete types

class `typing.``IO`
class `typing.``TextIO`
class `typing.``BinaryIO`

  Generic type `IO[AnyStr]` and its subclasses `TextIO(IO[str])` and `BinaryIO(IO[bytes])` represent the types of I/O streams such as returned by `open()`.

  Deprecated since version 3.8, will be removed in version 3.13: The `typing.io` namespace is deprecated and will be removed. These types should be directly imported from `typing` instead.

class `typing.``Pattern`
class `typing.``Match`

  These type aliases correspond to the return types from `re.compile()` and `re.match()`. These types (and the corresponding functions) are generic in `AnyStr` and can be made specific by writing `Pattern[str]`, `Pattern[bytes]`, `Match[str]`, or `Match[bytes]`.

  Deprecated since version 3.8, will be removed in version 3.13: The `typing.re` namespace is deprecated and will be removed. These types should be directly imported from `typing` instead.

  Obsolète depuis la version 3.9: Classes `Pattern` and `Match` from `re` now support `[]`. See PEP 585 and Generic Alias Type.

class `typing.``Text`

  `Text` est un alias pour `str`. Il est fourni pour obtenir une compatibilité ascendante du code Python 2 : en Python 2, `Text` est un alias pour `unicode`.

  Utilisez `Text` pour indiquer qu'une valeur doit contenir une chaîne Unicode d'une manière compatible avec Python 2 et Python 3 :

      def add_unicode_checkmark(text: Text) -> Text:
          return text + u' \u2713'

  Nouveau dans la version 3.5.2.

### Abstract Base Classes

#### Correspond aux collections au sein de `collections.abc`

class `typing.``AbstractSet`(Collection[T_co])

  Une version générique de `collections.abc.Set`.

  Obsolète depuis la version 3.9: `collections.abc.Set` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``ByteString`(Sequence[int])

  Une version générique de `collections.abc.ByteString`.

  This type represents the types `bytes`, `bytearray`, and `memoryview` of byte sequences.

  Comme abréviation pour ce type, `bytes` peut être utilisé pour annoter des arguments de n'importe quel type mentionné ci-dessus.

  Obsolète depuis la version 3.9: `collections.abc.ByteString` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Collection`(Sized, Iterable[T_co], Container[T_co])

  Une version générique de `collections.abc.Collection`

  Nouveau dans la version 3.6.0.

  Obsolète depuis la version 3.9: `collections.abc.Collection` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Container`(Generic[T_co])

  Une version générique de `collections.abc.Container`.

  Obsolète depuis la version 3.9: `collections.abc.Container` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``ItemsView`(MappingView, AbstractSet[tuple[KT_co, VT_co]])

  Une version générique de `collections.abc.ItemsView`.

  Obsolète depuis la version 3.9: `collections.abc.ItemsView` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``KeysView`(MappingView, AbstractSet[KT_co])

  Une version générique de `collections.abc.KeysView`.

  Obsolète depuis la version 3.9: `collections.abc.KeysView` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Mapping`(Collection[KT], Generic[KT, VT_co])

  Une version générique de `collections.abc.Mapping`. Ce type peut être utilisé comme suit :

      def get_position_in_index(word_list: Mapping[str, int], word: str) -> int:
          return word_list[word]

  Obsolète depuis la version 3.9: `collections.abc.Mapping` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``MappingView`(Sized)

  Une version générique de `collections.abc.MappingView`.

  Obsolète depuis la version 3.9: `collections.abc.MappingView` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``MutableMapping`(Mapping[KT, VT])

  Une version générique de `collections.abc.MutableMapping`.

  Obsolète depuis la version 3.9: `collections.abc.MutableMapping` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``MutableSequence`(Sequence[T])

  Une version générique de `collections.abc.MutableSequence`.

  Obsolète depuis la version 3.9: `collections.abc.MutableSequence` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``MutableSet`(AbstractSet[T])

  Une version générique de `collections.abc.MutableSet`.

  Obsolète depuis la version 3.9: `collections.abc.MutableSet` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Sequence`(Reversible[T_co], Collection[T_co])

  Une version générique de `collections.abc.Sequence`.

  Obsolète depuis la version 3.9: `collections.abc.Sequence` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``ValuesView`(MappingView, Collection[_VT_co])

  Une version générique de `collections.abc.ValuesView`.

  Obsolète depuis la version 3.9: `collections.abc.ValuesView` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

#### Correspond aux autres types au sein de `collections.abc`.

class `typing.``Iterable`(Generic[T_co])

  Une version générique de `collections.abc.Iterable`.

  Obsolète depuis la version 3.9: `collections.abc.Iterable` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Iterator`(Iterable[T_co])

  Une version générique de `collections.abc.Iterator`.

  Obsolète depuis la version 3.9: `collections.abc.Iterator` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Generator`(Iterator[T_co], Generic[T_co, T_contra, V_co])

  Un générateur peut être annoté par le type générique `Generator[YieldType, SendType, ReturnType]`. Par exemple :

      def echo_round() -> Generator[int, float, str]:
          sent = yield 0
          while sent >= 0:
              sent = yield round(sent)
          return 'Done'

  Notez que contrairement à beaucoup d'autres génériques dans le module typing, le `SendType` de `Generator` se comporte de manière contravariante, pas de manière covariante ou invariante.

  Si votre générateur ne donne que des valeurs, réglez les paramètres `SendType` et `ReturnType` sur `None` :

      def infinite_stream(start: int) -> Generator[int, None, None]:
          while True:
              yield start
              start += 1

  Alternativement, annotez votre générateur comme ayant un type de retour soit `Iterable[YieldType]` ou `Iterator[YieldType]` :

      def infinite_stream(start: int) -> Iterator[int]:
          while True:
              yield start
              start += 1

  Obsolète depuis la version 3.9: `collections.abc.Generator` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Hashable`

  An alias to `collections.abc.Hashable`.

class `typing.``Reversible`(Iterable[T_co])

  Une version générique de `collections.abc.Reversible`.

  Obsolète depuis la version 3.9: `collections.abc.Reversible` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Sized`

  An alias to `collections.abc.Sized`.

#### Programmation asynchrone

class `typing.``Coroutine`(Awaitable[V_co], Generic[T_co, T_contra, V_co])

  Une version générique de `collections.abc.Coroutine`. La variance et l'ordre des variables de type correspondent à ceux de la classe `Generator`, par exemple :

      from collections.abc import Coroutine
      c: Coroutine[list[str], str, int]  # Some coroutine defined elsewhere
      x = c.send('hi')                   # Inferred type of 'x' is list[str]
      async def bar() -> None:
          y = await c                    # Inferred type of 'y' is int

  Nouveau dans la version 3.5.3.

  Obsolète depuis la version 3.9: `collections.abc.Coroutine` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``AsyncGenerator`(AsyncIterator[T_co], Generic[T_co, T_contra])

  Un générateur asynchrone peut être annoté par le type générique `AsyncGenerator[YieldType, SendType]`. Par exemple :

      async def echo_round() -> AsyncGenerator[int, float]:
          sent = yield 0
          while sent >= 0.0:
              rounded = await round(sent)
              sent = yield rounded

  Contrairement aux générateurs normaux, les générateurs asynchrones ne peuvent pas renvoyer une valeur, il n'y a donc pas de paramètre de type `ReturnType`. Comme avec `Generator`, le `SendType` se comporte de manière contravariante.

  Si votre générateur ne donne que des valeurs, réglez le paramètre `SendType` sur `None` :

      async def infinite_stream(start: int) -> AsyncGenerator[int, None]:
          while True:
              yield start
              start = await increment(start)

  Alternativement, annotez votre générateur comme ayant un type de retour soit `AsyncIterable[YieldType]` ou `AsyncIterator[YieldType]` :

      async def infinite_stream(start: int) -> AsyncIterator[int]:
          while True:
              yield start
              start = await increment(start)

  Nouveau dans la version 3.6.1.

  Obsolète depuis la version 3.9: `collections.abc.AsyncGenerator` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``AsyncIterable`(Generic[T_co])

  Une version générique de `collections.abc.AsyncIterable`.

  Nouveau dans la version 3.5.2.

  Obsolète depuis la version 3.9: `collections.abc.AsyncIterable` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``AsyncIterator`(AsyncIterable[T_co])

  Une version générique de `collections.abc.AsyncIterator`.

  Nouveau dans la version 3.5.2.

  Obsolète depuis la version 3.9: `collections.abc.AsyncIterator` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``Awaitable`(Generic[T_co])

  Une version générique de `collections.abc.Awaitable`.

  Nouveau dans la version 3.5.2.

  Obsolète depuis la version 3.9: `collections.abc.Awaitable` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

#### Types associés aux gestionnaires de contexte

class `typing.``ContextManager`(Generic[T_co])

  Une version générique de `contextlib.AbstractContextManager`.

  Nouveau dans la version 3.5.4.

  Nouveau dans la version 3.6.0.

  Obsolète depuis la version 3.9: `contextlib.AbstractContextManager` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

class `typing.``AsyncContextManager`(Generic[T_co])

  Une version générique de `contextlib.AbstractAsyncContextManager`.

  Nouveau dans la version 3.5.4.

  Nouveau dans la version 3.6.2.

  Obsolète depuis la version 3.9: `contextlib.AbstractAsyncContextManager` now supports subscripting (`[]`). See PEP 585 and Generic Alias Type.

### Protocoles

Ces protocoles sont décorés par `runtime_checkable()`.

class `typing.``SupportsAbs`

  Une ABC avec une méthode abstraite `__abs__` qui est covariante dans son type de retour.

class `typing.``SupportsBytes`

  Une ABC avec une méthode abstraite `__bytes__`.

class `typing.``SupportsComplex`

  Une ABC avec une méthode abstraite `__complex__`.

class `typing.``SupportsFloat`

  Une ABC avec une méthode abstraite `__float__`.

class `typing.``SupportsIndex`

  Une ABC avec une méthode abstraite `__index__`.

  Nouveau dans la version 3.8.

class `typing.``SupportsInt`

  Une ABC avec une méthode abstraite `__int__`.

class `typing.``SupportsRound`

  Une ABC avec une méthode abstraite `__round__` qui est covariante dans son type de retour.

### Functions and decorators

`typing.``cast`(typ, val)

  Convertit une valeur en un type.

  Ceci renvoie la valeur inchangée. Pour le vérificateur de type, cela signifie que la valeur de retour a le type désigné mais, à l'exécution, intentionnellement, rien n'est vérifié (afin que cela soit aussi rapide que possible).

`@``typing.``overload`

  Le décorateur `@overload` permet de décrire des fonctions et des méthodes qui acceptent plusieurs combinaisons différentes de types d'arguments. Une série de définitions décorées avec `overload` doit être suivie d'une seule définition non décorée de `overload` (pour la même fonction/méthode). Les définitions décorées de `@overload` ne sont destinées qu'au vérificateur de type, puisqu'elles sont écrasées par la définition non décorée de `@overload` ; cette dernière, en revanche, est utilisée à l'exécution mais qu'il convient que le vérificateur de type l'ignore. Lors de l'exécution, l'appel direct d'une fonction décorée avec `@overload` lèvera `NotImplementedError`. Un exemple de surcharge qui donne un type plus précis que celui qui peut être exprimé à l'aide d'une variable union ou type :

      @overload
      def process(response: None) -> None:
          ...
      @overload
      def process(response: int) -> tuple[int, str]:
          ...
      @overload
      def process(response: bytes) -> str:
          ...
      def process(response):
          <actual implementation>

  See PEP 484 for more details and comparison with other typing semantics.

`@``typing.``final`

  Un décorateur pour indiquer aux vérificateurs de types que la méthode décorée ne peut pas être remplacée et que la classe décorée ne peut pas être sous-classée. Par exemple :

      class Base:
          @final
          def done(self) -> None:
              ...
      class Sub(Base):
          def done(self) -> None:  # Error reported by type checker
              ...

      @final
      class Leaf:
          ...
      class Other(Leaf):  # Error reported by type checker
          ...

  Ces propriétés ne sont pas vérifiées à l'exécution. Voir la PEP 591 pour plus de détails.

  Nouveau dans la version 3.8.

`@``typing.``no_type_check`

  Décorateur pour indiquer que les annotations ne sont pas des indications de type.

  Cela fonctionne en tant que classe ou fonction décoratrice. Avec une classe, elle s'applique récursivement à toutes les méthodes définies dans cette classe (mais pas aux méthodes définies dans ses superclasses ou sous-classes).

  Cela fait muter la ou les fonctions en place.

`@``typing.``no_type_check_decorator`

  Décorateur pour donner à un autre décorateur l'effet `no_type_check()`.

  Ceci enveloppe le décorateur avec quelque chose qui enveloppe la fonction décorée dans `no_type_check()`.

`@``typing.``type_check_only`

  Décorateur pour marquer une classe ou une fonction comme étant indisponible au moment de l'exécution.

  Ce décorateur n'est pas disponible à l'exécution. Il est principalement destiné à marquer les classes qui sont définies dans des fichiers séparés d'annotations de type (type stub file, en anglais) si une implémentation renvoie une instance d'une classe privée :

      @type_check_only
      class Response:  # private or not available at runtime
          code: int
          def get_header(self, name: str) -> str: ...

      def fetch_response() -> Response: ...

  Notez qu'il n'est pas recommandé de renvoyer les instances des classes privées. Il est généralement préférable de rendre ces classes publiques.

### Utilitaires d'introspection

`typing.``get_type_hints`(obj, globalns=None, localns=None, include_extras=False)

  renvoie un dictionnaire contenant des indications de type pour une fonction, une méthode, un module ou un objet de classe.

  C'est souvent équivalent à `obj.__annotations__`. De plus, les références directes encodées sous forme de chaîne littérales sont traitées en les évaluant dans les espaces de nommage `globals` et `locals`. Si nécessaire, `Optional[t]` est ajouté pour les annotations de fonction et de méthode si une valeur par défaut égale à `None` est définie. Pour une classe `C`, renvoie un dictionnaire construit en fusionnant toutes les `__annotations__` en parcourant `C.__mro__` en ordre inverse.

  La fonction remplace récursivement tous les `Annotated[T, ...]` avec `T`, sauf si la valeur de `include_extras` est définie à `True` (voir `Annotated` pour plus d'information). Par exemple :

      class Student(NamedTuple):
          name: Annotated[str, 'some marker']

      get_type_hints(Student) == {'name': str}
      get_type_hints(Student, include_extras=False) == {'name': str}
      get_type_hints(Student, include_extras=True) == {
          'name': Annotated[str, 'some marker']
      }

  Note

  `get_type_hints()` ne fonctionne pas avec les alias de type importés contenant des références postérieures. L'activation d'évaluation différée des annotations (PEP 563) permet de supprimer le besoin de références postérieures supplémentaires.

  Modifié dans la version 3.9: Ajout du paramètre `include_extras` comme énoncé dans la PEP 593.

`typing.``get_args`(tp)

`typing.``get_origin`(tp)

  Fournit une introspection de base pour les types génériques et les formes spéciales de typage.

  Pour un objet de typage de la forme `X[Y, Z, ....]`, ces fonctions renvoient `X` et `(Y, Z,...)`. Si `X` est un alias pour une classe native ou de `collections`, il est normalisé vers la classe originale. Si `X` est une union or un `Literal` contenu dans un autre type générique, l'ordre de `(Y, Z, ...)` peut différer de l'ordre des arguments originels `[Y, Z, ...]` à cause du cache de types.Pour les objets non gérés, renvoient `None` et `()` respectivement. Exemples :

      assert get_origin(Dict[str, int]) is dict
      assert get_args(Dict[int, str]) == (int, str)

      assert get_origin(Union[int, str]) is Union
      assert get_args(Union[int, str]) == (int, str)

  Nouveau dans la version 3.8.

`typing.``is_typeddict`(tp)

  Vérifier si un type est un `TypedDict`.

  Par exemple :

      class Film(TypedDict):
          title: str
          year: int

      is_typeddict(Film)  # => True
      is_typeddict(list | str)  # => False

  Nouveau dans la version 3.10.

class `typing.``ForwardRef`

  Une classe utilisée pour le typage interne de la représentation des références postérieures des chaînes de caractères. Par exemple, `List["SomeClass"]` est implicitement transformé en `List[ForwardRef("SomeClass")]`. Cette classe ne doit pas être instanciée par un utilisateur, mais peut être utilisée par des outils d'introspection.

  Note

  Les types PEP 585 tels que `list["SomeClass"]` ne seront pas implicitement transformés en `list[ForwardRef("SomeClass")]` et ne seront donc pas automatiquement résolus en `list[SomeClass]`.

  Nouveau dans la version 3.7.4.

### Constante

`typing.``TYPE_CHECKING`

  Constante spéciale qui vaut `True` pour les vérificateurs de type statiques tiers et `False` à l'exécution. Utilisation :

      if TYPE_CHECKING:
          import expensive_mod

      def fun(arg: 'expensive_mod.SomeType') -> None:
          local_var: expensive_mod.AnotherType = other_fun()

  The first type annotation must be enclosed in quotes, making it a "forward reference", to hide the `expensive_mod` reference from the interpreter runtime. Type annotations for local variables are not evaluated, so the second annotation does not need to be enclosed in quotes.

  Note

  Si `from __future__ import annotations` est utilisé, les annotations ne sont pas évaluées au moment de la définition de fonction. Elles sont alors stockées comme des chaînes de caractères dans `__annotations__`, ce qui rend inutile l'utilisation de guillemets autour de l'annotation (Voir PEP 563).

  Nouveau dans la version 3.5.2.