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.
This module provides runtime support for type hints. The most fundamental
support consists of the types Any
, Union
, Callable
,
TypeVar
, and Generic
. For a specification, please see
PEP 484. For a simplified introduction to type hints, see 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.
Pour un résumé des fonctionnalités obsolètes et leur planification d'obsolescence, consultez les Etapes d'Obsolescence des Fonctionnalités Majeures.
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 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 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 604: Permettre l'écriture de types union tels que
- PEP 612: Variables de Spécification de Paramètre
Ajout de
ParamSpec
et deConcatenate
- PEP 646: Génériques Variadiques
Ajout de
TypeVarTuple
- PEP 655: Marquer les items individuels TypedDict comme nécessaires ou potentiellement manquants
Ajout de
Required
et deNotRequired
- PEP 675: Type String Littéral Arbitraire
Ajout de
LiteralString
- PEP 681: Transformateurs de Classes de Données
Ajout du décorateur
@dataclass_transform
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 annotation de type est un cas particulier et est remplacé par type(None)
.
Type aliases may be marked with TypeAlias
to make it explicit that
the statement is a type alias declaration, not a normal variable assignment:
from typing import TypeAlias
Vector: TypeAlias = list[float]
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 types statiques 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 types statiques 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 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 mères 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 mère 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]):
...
When inheriting from generic classes, some type parameters could be fixed:
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]
User-defined generic type aliases are also supported. Examples:
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 types statiques 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 types 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 mères 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).
Module contents¶
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
no sooner than 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.
Modifié dans la version 3.11:
Any
can now be used as a base class. This can be useful for avoiding type checker errors with classes that can duck type anywhere or are highly dynamic.
- typing.AnyStr¶
AnyStr
is a constrained type variable defined asAnyStr = 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
- typing.LiteralString¶
Special type that includes only literal strings. A string literal is compatible with
LiteralString
, as is anotherLiteralString
, but an object typed as juststr
is not. A string created by composingLiteralString
-typed objects is also acceptable as aLiteralString
.Example:
def run_query(sql: LiteralString) -> ... ... def caller(arbitrary_string: str, literal_string: LiteralString) -> None: run_query("SELECT * FROM students") # ok run_query(literal_string) # ok run_query("SELECT * FROM " + literal_string) # ok run_query(arbitrary_string) # type checker error run_query( # type checker error f"SELECT * FROM students WHERE name = {arbitrary_string}" )
This is useful for sensitive APIs where arbitrary user-generated strings could generate problems. For example, the two cases above that generate type checker errors could be vulnerable to an SQL injection attack.
See PEP 675 for more details.
Nouveau dans la version 3.11.
- typing.Never¶
The bottom type, a type that has no members.
This can be used to define a function that should never be called, or a function that never returns:
from typing import Never def never_call_me(arg: Never) -> None: pass def int_or_str(arg: int | str) -> None: never_call_me(arg) # type checker error match arg: case int(): print("It's an int") case str(): print("It's a str") case _: never_call_me(arg) # ok, arg is of type Never
Nouveau dans la version 3.11: On older Python versions,
NoReturn
may be used to express the same concept.Never
was added to make the intended meaning more explicit.
- 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')
NoReturn
can also be used as a bottom type, a type that has no values. Starting in Python 3.11, theNever
type should be used for this concept instead. Type checkers should treat the two equivalently.Nouveau dans la version 3.5.4.
Nouveau dans la version 3.6.2.
- typing.Self¶
Special type to represent the current enclosed class. For example:
from typing import Self class Foo: def return_self(self) -> Self: ... return self
This annotation is semantically equivalent to the following, albeit in a more succinct fashion:
from typing import TypeVar Self = TypeVar("Self", bound="Foo") class Foo: def return_self(self: Self) -> Self: ... return self
In general if something currently follows the pattern of:
class Foo: def return_self(self) -> "Foo": ... return self
You should use
Self
as calls toSubclassOfFoo.return_self
would haveFoo
as the return type and notSubclassOfFoo
.Other common use cases include:
classmethod
s that are used as alternative constructors and return instances of thecls
parameter.Annotating an
__enter__()
method which returns self.
See PEP 673 for more details.
Nouveau dans la version 3.11.
- 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 commeTuple[()]
.Exemple :
Tuple[T1, T2]
est une paire correspondant aux variables de typeT1
etT2
.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-upletTuple
est équivalent àTuple[Any, ....]
et, à son tour, àtuple
.Obsolète depuis la version 3.9:
builtins.tuple
now supports subscripting ([]
). See PEP 585 and Type Alias générique.
- typing.Union¶
Union type;
Union[X, Y]
is equivalent toX | Y
and means either X or Y.To define a union, use e.g.
Union[int, str]
or the shorthandint | 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 toX | None
(orUnion[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 deOptional
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 renvoyantReturnType
. Un simpleCallable
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érateurConcatenate
peut être utilisé. Ils prennent la formeCallable[ParamSpecVariable, ReturnType]
etCallable[Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable], ReturnType]
respectivement.Obsolète depuis la version 3.9:
collections.abc.Callable
now supports subscripting ([]
). See PEP 585 and Type Alias générique.Modifié dans la version 3.10:
Callable
prend désormais en chargeParamSpec
etConcatenate
. Voir PEP 612 pour plus de détails.Voir aussi
The documentation for
ParamSpec
andConcatenate
provide examples of usage withCallable
.
- typing.Concatenate¶
Used with
Callable
andParamSpec
to type annotate a higher order callable which adds, removes, or transforms parameters of another callable. Usage is in the formConcatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable]
.Concatenate
is currently only valid when used as the first argument to aCallable
. The last parameter toConcatenate
must be aParamSpec
or ellipsis (...
).For example, to annotate a decorator
with_lock
which provides athreading.Lock
to the decorated function,Concatenate
can be used to indicate thatwith_lock
expects a callable which takes in aLock
as the first argument, and returns a callable with a different type signature. In this case, theParamSpec
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.
- class typing.Type(Generic[CT_co])¶
Une variable annotée de
C
peut accepter une valeur de typeC
. En revanche, une variable annotée avecType[C]
peut accepter des valeurs qui sont elles-mêmes des classes — plus précisément, elle accepte l'objet class deC
. 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 deC
doivent implémenter la même signature de constructeur et les signatures de méthode de classe queC
. Le vérificateur de types 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 mère 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 Type Alias générique.
- 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 pourLiteral[...]
, 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.
- 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 avecisinstance()
ouissubclass()
.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 types 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.Required¶
- typing.NotRequired¶
Special typing constructs that mark individual keys of a
TypedDict
as either required or non-required respectively.See
TypedDict
and PEP 655 for more details.Nouveau dans la version 3.11.
- 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, asAnnotated
is variadic). Specifically, a typeT
can be annotated with metadatax
via the typehintAnnotated[T, x]
. This metadata can be used for either static analysis or at runtime. If a library (or tool) encounters a typehintAnnotated[T, x]
and has no special logic for metadatax
, it should ignore it and simply treat the type asT
. Unlike theno_type_check
functionality that currently exists in thetyping
module which completely disables typechecking annotations on a function or a class, theAnnotated
type allows for both static typechecking ofT
(which can safely ignorex
) together with runtime access tox
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 anAnnotated
type can scan through the annotations to determine if they are of interest (e.g., usingisinstance()
).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
toget_type_hints()
lets one access the extra annotations at runtime.The details of the syntax:
The first argument to
Annotated
must be a valid typeMultiple 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:The return value is a boolean.
If the return value is
True
, the type of its argument is the type insideTypeGuard
.
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 inTypeGuard
maps to the type of the second parameter aftercls
orself
.In short, the form
def foo(arg: TypeA) -> TypeGuard[TypeB]: ...
, means that iffoo(arg)
returnsTrue
, thenarg
narrows fromTypeA
toTypeB
.Note
TypeB
need not be a narrower form ofTypeA
-- it can even be a wider form. The main reason is to allow for things like narrowinglist[object]
tolist[str]
even though the latter is not a subtype of the former, sincelist
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.
- typing.Unpack¶
A typing operator that conceptually marks an object as having been unpacked. For example, using the unpack operator
*
on atype variable tuple
is equivalent to usingUnpack
to mark the type variable tuple as having been unpacked:Ts = TypeVarTuple('Ts') tup: tuple[*Ts] # Effectively does: tup: tuple[Unpack[Ts]]
In fact,
Unpack
can be used interchangeably with*
in the context oftyping.TypeVarTuple
andbuiltins.tuple
types. You might seeUnpack
being used explicitly in older versions of Python, where*
couldn't be used in certain places:# In older versions of Python, TypeVarTuple and Unpack # are located in the `typing_extensions` backports package. from typing_extensions import TypeVarTuple, Unpack Ts = TypeVarTuple('Ts') tup: tuple[*Ts] # Syntax error on Python <= 3.10! tup: tuple[Unpack[Ts]] # Semantically equivalent, and backwards-compatible
Nouveau dans la version 3.11.
Building generic types¶
The following objects are not used directly in annotations. Instead, 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(name, *constraints, bound=None, covariant=False, contravariant=False)¶
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 and type alias 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.
Created type variables may be explicitly marked covariant or contravariant by passing
covariant=True
orcontravariant=True
. By default, type variables are invariant. See PEP 484 and PEP 695 for more details.Bound type variables and constrained type variables have different semantics in several important ways. Using a bound type variable means that the
TypeVar
will be solved using the most specific type possible:x = print_capitalized('a string') reveal_type(x) # revealed type is str class StringSubclass(str): pass y = print_capitalized(StringSubclass('another string')) reveal_type(y) # revealed type is StringSubclass z = 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
Using a constrained type variable, however, means that the
TypeVar
can only ever be solved as being exactly one of the constraints given:a = concatenate('one', 'two') reveal_type(a) # revealed type is str b = concatenate(StringSubclass('one'), StringSubclass('two')) reveal_type(b) # revealed type 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
At runtime,
isinstance(x, T)
will raiseTypeError
.- __name__¶
The name of the type variable.
- __covariant__¶
Whether the type var has been marked as covariant.
- __contravariant__¶
Whether the type var has been marked as contravariant.
- __bound__¶
The bound of the type variable, if any.
- __constraints__¶
A tuple containing the constraints of the type variable, if any.
- class typing.TypeVarTuple(name)¶
Type variable tuple. A specialized form of
type variable
that enables variadic generics.Utilisation :
T = TypeVar("T") Ts = TypeVarTuple("Ts") def move_first_element_to_last(tup: tuple[T, *Ts]) -> tuple[*Ts, T]: return (*tup[1:], tup[0])
A normal type variable enables parameterization with a single type. A type variable tuple, in contrast, allows parameterization with an arbitrary number of types by acting like an arbitrary number of type variables wrapped in a tuple. For example:
# T is bound to int, Ts is bound to () # Return value is (1,), which has type tuple[int] move_first_element_to_last(tup=(1,)) # T is bound to int, Ts is bound to (str,) # Return value is ('spam', 1), which has type tuple[str, int] move_first_element_to_last(tup=(1, 'spam')) # T is bound to int, Ts is bound to (str, float) # Return value is ('spam', 3.0, 1), which has type tuple[str, float, int] move_first_element_to_last(tup=(1, 'spam', 3.0)) # This fails to type check (and fails at runtime) # because tuple[()] is not compatible with tuple[T, *Ts] # (at least one element is required) move_first_element_to_last(tup=())
Note the use of the unpacking operator
*
intuple[T, *Ts]
. Conceptually, you can think ofTs
as a tuple of type variables(T1, T2, ...)
.tuple[T, *Ts]
would then becometuple[T, *(T1, T2, ...)]
, which is equivalent totuple[T, T1, T2, ...]
. (Note that in older versions of Python, you might see this written usingUnpack
instead, asUnpack[Ts]
.)Type variable tuples must always be unpacked. This helps distinguish type variable tuples from normal type variables:
x: Ts # Not valid x: tuple[Ts] # Not valid x: tuple[*Ts] # The correct way to do it
Type variable tuples can be used in the same contexts as normal type variables. For example, in class definitions, arguments, and return types:
Shape = TypeVarTuple("Shape") class Array(Generic[*Shape]): def __getitem__(self, key: tuple[*Shape]) -> float: ... def __abs__(self) -> "Array[*Shape]": ... def get_shape(self) -> tuple[*Shape]: ...
Type variable tuples can be happily combined with normal type variables:
DType = TypeVar('DType') class Array(Generic[DType, *Shape]): # This is fine pass class Array2(Generic[*Shape, DType]): # This would also be fine pass float_array_1d: Array[float, Height] = Array() # Totally fine int_array_2d: Array[int, Height, Width] = Array() # Yup, fine too
However, note that at most one type variable tuple may appear in a single list of type arguments or type parameters:
x: tuple[*Ts, *Ts] # Not valid class Array(Generic[*Shape, *Shape]): # Not valid pass
Finally, an unpacked type variable tuple can be used as the type annotation of
*args
:def call_soon( callback: Callable[[*Ts], None], *args: *Ts ) -> None: ... callback(*args)
In contrast to non-unpacked annotations of
*args
- e.g.*args: int
, which would specify that all arguments areint
-*args: *Ts
enables reference to the types of the individual arguments in*args
. Here, this allows us to ensure the types of the*args
passed tocall_soon
match the types of the (positional) arguments ofcallback
.See PEP 646 for more details on type variable tuples.
- __name__¶
The name of the type variable tuple.
Nouveau dans la version 3.11.
- 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 toCallable
, or as parameters for user-defined Generics. SeeGeneric
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 aTypeVar
with boundCallable[..., Any]
. However this causes two problems:The type checker can't type check the
inner
function because*args
and**kwargs
have to be typedAny
.cast()
may be required in the body of theadd_logging
decorator when returning theinner
function, or the static type checker must be told to ignore thereturn inner
.
- args¶
- kwargs¶
Since
ParamSpec
captures both positional and keyword parameters,P.args
andP.kwargs
can be used to split aParamSpec
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
andP.kwargs
are instances respectively ofParamSpecArgs
andParamSpecKwargs
.
- __name__¶
The name of the parameter specification.
Parameter specification variables created with
covariant=True
orcontravariant=True
can be used to declare covariant or contravariant generic types. Thebound
argument is also accepted, similar toTypeVar
. 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
andConcatenate
).Callable
andConcatenate
.
- typing.ParamSpecArgs¶
- typing.ParamSpecKwargs¶
Arguments and keyword arguments attributes of a
ParamSpec
. TheP.args
attribute of aParamSpec
is an instance ofParamSpecArgs
, andP.kwargs
is an instance ofParamSpecKwargs
. 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 originalParamSpec
:P = ParamSpec("P") get_origin(P.args) # returns P get_origin(P.kwargs) # returns P
Nouveau dans la version 3.10.
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 thenamedtuple()
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}>'
NamedTuple
subclasses can be generic:class Group(NamedTuple, Generic[T]): key: T group: list[T]
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 deOrderedDict
.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.Modifié dans la version 3.11: Added support for generic namedtuples.
- 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)
- __module__¶
The module in which the new type is defined.
- __name__¶
The name of the new type.
- __supertype__¶
The type that the new type is based on.
Nouveau dans la version 3.5.2.
Modifié dans la version 3.10:
NewType
is now a class rather than a function.
- 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 :
T = TypeVar("T") 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()
andissubclass()
. This raisesTypeError
when applied to a non-protocol class. This allows a simple-minded structural check, very similar to "one trick ponies" incollections.abc
such asIterable
. 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 anissubclass()
check againstCallable
. However, thessl.SSLObject.__init__
method exists only to raise aTypeError
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 anisinstance()
check against a non-protocol class. Consider using alternative idioms such ashasattr()
calls for structural checks in performance-sensitive code.Nouveau dans la version 3.8.
- 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:Using a literal
dict
as the second argument:Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})
Using keyword arguments:
Point2D = TypedDict('Point2D', x=int, y=int, label=str)
Obsolète depuis la version 3.11, sera supprimé dans la version 3.13: The keyword-argument syntax is deprecated in 3.11 and will be removed in 3.13. It may also be unsupported by static type checkers.
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 mark individual keys as non-required usingNotRequired
:class Point2D(TypedDict): x: int y: int label: NotRequired[str] # Alternative syntax Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': NotRequired[str]})
This means that a
Point2D
TypedDict
can have thelabel
key omitted.It is also possible to mark all keys as non-required by default by specifying a totality of
False
:class Point2D(TypedDict, total=False): x: int y: int # Alternative syntax Point2D = TypedDict('Point2D', {'x': int, 'y': int}, total=False)
This means that a
Point2D
TypedDict
can have any of the keys omitted. A type checker is only expected to support a literalFalse
orTrue
as the value of thetotal
argument.True
is the default, and makes all items defined in the class body required.Individual keys of a
total=False
TypedDict
can be marked as required usingRequired
:class Point2D(TypedDict, total=False): x: Required[int] y: Required[int] label: str # Alternative syntax Point2D = TypedDict('Point2D', { 'x': Required[int], 'y': Required[int], 'label': str }, total=False)
It is possible for a
TypedDict
type to inherit from one or more otherTypedDict
types using the class-based syntax. Usage:class Point3D(Point2D): z: int
Point3D
has three items:x
,y
andz
. It is equivalent to this definition:class Point3D(TypedDict): x: int y: int z: int
A
TypedDict
cannot inherit from a non-TypedDict
class, except forGeneric
. 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 generic:class Group(TypedDict, Generic[T]): key: T group: list[T]
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 thetotal
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__
andPoint2D.__optional_keys__
returnfrozenset
objects containing required and non-required keys, respectively.Keys marked with
Required
will always appear in__required_keys__
and keys marked withNotRequired
will always appear in__optional_keys__
.For backwards compatibility with Python 3.10 and below, it is also possible to use inheritance to declare both required and non-required keys in the same
TypedDict
. This is done by declaring aTypedDict
with one value for thetotal
argument and then inheriting from it in anotherTypedDict
with a different value fortotal
:>>> 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.
Modifié dans la version 3.11: Added support for marking individual keys as
Required
orNotRequired
. See PEP 655.Modifié dans la version 3.11: Added support for generic
TypedDict
s.
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 queMapping
.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 Type Alias générique.
- 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 queSequence
ouIterable
.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 Type Alias générique.
- 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 queAbstractSet
.Obsolète depuis la version 3.9:
builtins.set
now supports subscripting ([]
). See PEP 585 and Type Alias générique.
- 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 Type Alias générique.
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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
Other concrete types¶
- class typing.IO¶
- class typing.TextIO¶
- class typing.BinaryIO¶
Generic type
IO[AnyStr]
and its subclassesTextIO(IO[str])
andBinaryIO(IO[bytes])
represent the types of I/O streams such as returned byopen()
.Obsolète depuis la version 3.8, sera supprimé dans la version 3.13: The
typing.io
namespace is deprecated and will be removed. These types should be directly imported fromtyping
instead.
- class typing.Pattern¶
- class typing.Match¶
These type aliases correspond to the return types from
re.compile()
andre.match()
. These types (and the corresponding functions) are generic inAnyStr
and can be made specific by writingPattern[str]
,Pattern[bytes]
,Match[str]
, orMatch[bytes]
.Obsolète depuis la version 3.8, sera supprimé dans la version 3.13: The
typing.re
namespace is deprecated and will be removed. These types should be directly imported fromtyping
instead.Obsolète depuis la version 3.9: Classes
Pattern
andMatch
fromre
now support[]
. See PEP 585 and Type Alias générique.
- class typing.Text¶
Text
est un alias pourstr
. Il est fourni pour obtenir une compatibilité ascendante du code Python 2 : en Python 2,Text
est un alias pourunicode
.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.
Obsolète depuis la version 3.11: Python 2 is no longer supported, and most type checkers also no longer support type checking Python 2 code. Removal of the alias is not currently planned, but users are encouraged to use
str
instead ofText
.
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 Type Alias générique.
- class typing.ByteString(Sequence[int])¶
This type represents the types
bytes
,bytearray
, andmemoryview
of byte sequences.Obsolète depuis la version 3.9, sera supprimé dans la version 3.14: Prefer
typing_extensions.Buffer
, or a union likebytes | bytearray | memoryview
.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
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 Type Alias générique.
- 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 Type Alias générique.
- 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
deGenerator
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
etReturnType
surNone
: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]
ouIterator[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 Type Alias générique.
- 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 Type Alias générique.
- 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 classeGenerator
, 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 Type Alias générique.
- 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 avecGenerator
, leSendType
se comporte de manière contravariante.Si votre générateur ne donne que des valeurs, réglez le paramètre
SendType
surNone
: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]
ouAsyncIterator[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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
- 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 Type Alias générique.
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 Type Alias générique.
- 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 Type Alias générique.
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 types, 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.assert_type(val, typ, /)¶
Vérifie que val est bien du type typ.
At runtime this does nothing: it returns the first argument unchanged with no checks or side effects, no matter the actual type of the argument.
When a static type checker encounters a call to
assert_type()
, it emits an error if the value is not of the specified type:def greet(name: str) -> None: assert_type(name, str) # OK, inferred type of `name` is `str` assert_type(name, int) # type checker error
Cette fonction permet de s'assurer de la compréhension du vérificateur de type d'un script par rapport aux intentions du développeur :
def complex_function(arg: object): # Do some complex type-narrowing logic, # after which we hope the inferred type will be `int` ... # Test whether the type checker correctly understands our function assert_type(arg, int)
Nouveau dans la version 3.11.
- typing.assert_never(arg, /)¶
Demande une confirmation de la part du vérificateur statique de type qu'une ligne de code est inaccessible.
Example:
def int_or_str(arg: int | str) -> None: match arg: case int(): print("It's an int") case str(): print("It's a str") case _ as unreachable: assert_never(unreachable)
Les annotations permettent ici au vérificateur de types de déduire que le dernier cas ne sera jamais exécuté car les seuls cas possibles (qu'
arg
soit unint
ou unstr
) sont couverts dans les cas précédents. Une erreur est levée si un appel àassert_never()
est atteignable. Par exemple, si l'annotation de type d'arg
estint | str | float
, une erreur sera levée indiquant qu'unreachable
est de typefloat
. Lors d'un appel àassert_never
, afin de passer la vérification de type avec succès, le type déduit de l'argument doit être de typeNever
.Une erreur est levé si la fonction est appelé lors de l'exécution.
Voir aussi
Unreachable Code and Exhaustiveness Checking pour plus détails sur la vérification exhaustive statique de type.
Nouveau dans la version 3.11.
- typing.reveal_type(obj, /)¶
Révèle le type statique déduit d'une expression.
Lorsqu'un vérificateur de types rencontre un appel à cette fonction, il va diagnostiquer le type de l'argument. Par exemple :
x: int = 1 reveal_type(x) # Revealed type is "builtins.int"
Cela est utile afin de comprendre comment le vérificateur de types va traiter un bout de code précis.
La fonction renvoie l'argument inchangé. Ce qui permet de l'utiliser au sein d'une expression :
x = reveal_type(1) # Revealed type is "builtins.int"
La plupart des vérificateurs de type supportent
reveal_type()
, même dans le cas ou le nom du type n'est pas importé depuistyping
. Cependant, l'import depuistyping
permet d'éviter les erreurs d'exécution et devient plus compréhensible.Lors de l'exécution, cette fonction affiche le type de son argument dans stderr et le renvoie inchangé :
x = reveal_type(1) # prints "Runtime type is int" print(x) # prints "1"
Nouveau dans la version 3.11.
- @typing.dataclass_transform¶
dataclass_transform
permet de décorer une classe, une métaclasse ou une fonction décoratrice. L'utilisation de@dataclass_transform()
avertit le vérificateur de types statiques que l'objet décoré effectue de la "magie" consistant à transformer une classe, lui appliquant un comportement du type dedataclasses.dataclass()
.Exemple d'utilisation avec une fonction décoratrice :
T = TypeVar("T") @dataclass_transform() def create_model(cls: type[T]) -> type[T]: ... return cls @create_model class CustomerModel: id: int name: str
Avec une classe de base :
@dataclass_transform() class ModelBase: ... class CustomerModel(ModelBase): id: int name: str
Avec une métaclasse :
@dataclass_transform() class ModelMeta(type): ... class ModelBase(metaclass=ModelMeta): ... class CustomerModel(ModelBase): id: int name: str
Les classes
CustomerModel
définis ci-dessus sont traitées par les vérificateurs de type de la même que les classes créées avec@dataclasses.dataclass
. Par exemple, les vérificateurs de type déduisent que ces classes possèdent une méthode__init__
acceptantid
etname
comme arguments.Les arguments booléens suivants sont acceptés,les vérificateurs de type supposent qu'ils ont le même effet qu'ils auraient eu sur le décorateur
@dataclasses.dataclass
:init
,eq
,order
,unsafe_hash
,frozen
,match_args
,kw_only
, etslots
. Il est possible d'évaluer statiquement les valeurs de ces arguments (True
orFalse
).Les arguments du décorateur
dataclass_transform
permettent de personnaliser le comportement par défaut de la classe, métaclasse ou fonction décorée :eq_default
indique la valeur du paramètreeq
(True
ouFalse
) si ce ne n'est pas précisé lors de l'appel.order_default
indique la valeur du paramètreorder
(True
ouFalse
) si ce n'est pas précisé lors de l'appel.kw_only_default
indique la valeur du paramètrekw_only_default
(True
ouFalse
) si ce ne n'est pas précisé lors de l'appel.field_specifiers
spécifie une liste statique des classes ou fonctions prises en charge pour la description des champs, similaire àdataclasses.field()
.D'autres arguments sont acceptés afin d'autoriser de futurs possibles extensions.
Les arguments optionnels suivants pour la spécifications des champs sont reconnus :
init
indique si le champ doit être inclut au sein de la méthode__init__
. VautTrue
par défaut.default
indique la valeur par défaut du champ.default_factory
fournit une fonction de rappel renvoyant la valeur par défaut du champ. Si les argumentsdefault
etdefault_factory
ne sont pas renseignés, le champ n'a pas de valeur pas défaut et il faudra en fournir une lors de l'instanciation de la classe.factory
est un alias pourdefault_factory
.kw_only
indique si le champ est uniquement par mot-clé. Si l'argument n'est pas renseigné, la valeur du paramètrekw_only
de l'objet décoré avecdataclass_transform
est utilisé. Ou si cette valeur n'est pas renseigné non plus, la valeur dekw_only_default
dedataclass_transform
est utilisé.alias
indique un nom alternatif pour le champ. Cet alias est utilisé dans le méthode__init__
synthétisée.
Lors de l'exécution, les arguments de ce décorateur sont enregistrés au sein de l'attribut
__dataclass_transform__
de l'objet décoré. Il n'y pas d'autre effet à l'exécution.See PEP 681 for more details.
Nouveau dans la version 3.11.
- @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 avecoverload
doit être suivie d'une seule définition non décorée deoverload
(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 types l'ignore. Lors de l'exécution, l'appel direct d'une fonction décorée avec@overload
lèveraNotImplementedError
. 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.
Modifié dans la version 3.11: Les fonctions surchargées peuvent maintenant être inspectées durant l'exécution via
get_overloads()
.
- typing.get_overloads(func)¶
Renvoie la séquence des définitions des fonctions décorées comme
@overload
associées à func. func est l'objet de la fonction implémenté de base. Par exemple, en reprenant le définition deprocess
dans la documentation pour@overload
,get_overloads(process)
renvoie une séquence composée de trois objets de fonction associés aux trois fonctions surchargées définies. En cas d'appel àget_overloads()
sur une fonction non surchargés, une séquence vide est retournée.get_overloads()
peut être utilisé afin d'inspecter une fonction surchargée durant l'exécution.Nouveau dans la version 3.11.
- typing.clear_overloads()¶
Suppression de toutes les surcharges enregistrées au sein du registre interne. Cela peut être utilisé afin de récupérer la mémoire utilisé par le registre.
Nouveau dans la version 3.11.
- @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.
Modifié dans la version 3.11: Le décorateur met l'attribut
__final__
àTrue
de l'objet décoré. Cela permet d'utiliser une vérification commeif getattr(obj, "__final__", False)
durant l'exécution afin de vérifier si un objetobj
est décoré commefinal
. Dans le cas où l'objet décoré ne supporte pas la modification d'attributs, le décorateur retournera l'objet de base sans lever d'exception.
- @typing.no_type_check¶
Décorateur pour indiquer que les annotations ne sont pas des indications de type.
This works as class or function decorator. With a class, it applies recursively to all methods and classes defined in that class (but not to methods defined in its superclasses or subclasses).
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 annotations 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 postérieures encodées sous forme de chaîne de caractères sont évaluées dans les espaces de nommageglobals
etlocals
. Pour une classeC
, elle renvoie un dictionnaire construit en fusionnant toutes les__annotations__
en parcourantC.__mro__
en ordre inverse.La fonction remplace récursivement tous les
Annotated[T, ...]
avecT
, sauf si la valeur deinclude_extras
est définie àTrue
(voirAnnotated
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.Modifié dans la version 3.11: Avant,
Optional[t]
était ajouté pour les annotations de fonctions et de méthodes dans le cas où une valeur par défaut était égal àNone
. Maintenant, les annotations sont renvoyées inchangées.
- typing.get_origin(tp)¶
Get the unsubscripted version of a type: for a typing object of the form
X[Y, Z, ...]
returnX
. IfX
is a generic alias for a builtin orcollections
class, it gets normalized to the original class. IfX
is an instance ofParamSpecArgs
orParamSpecKwargs
, return the underlyingParamSpec
. ReturnNone
for unsupported objects. Examples:assert get_origin(str) is None assert get_origin(Dict[str, int]) is dict assert get_origin(Union[int, str]) is Union P = ParamSpec('P') assert get_origin(P.args) is P assert get_origin(P.kwargs) is P
Nouveau dans la version 3.8.
- typing.get_args(tp)¶
Get type arguments with all substitutions performed: for a typing object of the form
X[Y, Z, ...]
return(Y, Z, ...)
. IfX
is a union orLiteral
contained in another generic type, the order of(Y, Z, ...)
may be different from the order of the original arguments[Y, Z, ...]
due to type caching. Return()
for unsupported objects. Examples:assert get_args(int) == () assert get_args(Dict[int, str]) == (int, str) 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é enList[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 enlist[ForwardRef("SomeClass")]
et ne seront donc pas automatiquement résolus enlist[SomeClass]
.Nouveau dans la version 3.7.4.
Constante¶
- typing.TYPE_CHECKING¶
Constante spéciale qui vaut
True
pour les vérificateurs de types statique tiers etFalse
à 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.
Étapes d'Obsolescence des Fonctionnalités Majeures¶
Certaines fonctionnalités dans typing
sont obsolètes et peuvent être supprimées dans une future version de Python. Le tableau suivant résume les principales dépréciations. Celui-ci peut changer et toutes les dépréciations ne sont pas listées.
Fonctionnalité |
Obsolète en |
Suppression prévue |
PEP/issue |
---|---|---|---|
sous-modules |
3.8 |
3.13 |
|
Versions de typage des collections standards |
3.9 |
Non défini |
|
|
3.9 |
3.14 |
|
|
3.11 |
Non défini |