""" Tests the typing.Annotated special form. """ # Specification: https://typing.readthedocs.io/en/latest/spec/qualifiers.html#annotated # > The first argument to Annotated must be a valid type from dataclasses import InitVar, dataclass from typing import ( Annotated, Any, Callable, ClassVar, Final, Literal, NotRequired, Required, TypeAlias, TypeVar, TypedDict, Union, ) T = TypeVar("T") Good1: Annotated[Union[int, str], ""] Good2: Annotated[int | None, ""] Good3: Annotated[list[int], ""] Good4: Annotated[Any, ""] Good5: Annotated[tuple[int, ...] | list[int], ""] Good6: Annotated[Callable[..., int], ""] Good7: Annotated["int | str", ""] Good8: Annotated[list["int | str"], ""] Bad1: Annotated[[int, str], ""] # E: invalid type expression Bad2: Annotated[((int, str),), ""] # E: invalid type expression Bad3: Annotated[[int for i in range(1)], ""] # E: invalid type expression Bad4: Annotated[{"a": "b"}, ""] # E: invalid type expression Bad5: Annotated[(lambda: int)(), ""] # E: invalid type expression Bad6: Annotated[[int][0], ""] # E: invalid type expression Bad7: Annotated[int if 1 < 3 else str, ""] # E: invalid type expression Bad8: Annotated[var1, ""] # E: invalid type expression Bad9: Annotated[True, ""] # E: invalid type expression Bad10: Annotated[1, ""] # E: invalid type expression Bad11: Annotated[list or set, ""] # E: invalid type expression Bad12: Annotated[f"{'int'}", ""] # E: invalid type expression # > Multiple type annotations are supported (Annotated supports variadic arguments): Multi1: Annotated[int | str, 3, ""] Multi2: Annotated[int | str, 3, "", lambda x: x, max(1, 2)] # > Annotated must be called with at least two arguments ( Annotated[int] is not valid) Bad13: Annotated[int] # E: requires at least two arguments # > Annotated types can be nested Nested1: list[Annotated[dict[str, Annotated[str, ""]], ""]] Nested2: Annotated[list[Annotated[dict[str, Annotated[Literal[1, 2, 3], ""]], ""]], ""] # > Annotated is not type compatible with type or type[T] SmallInt: TypeAlias = Annotated[int, ""] not_type1: type[Any] = Annotated[int, ""] # E not_type2: type[Any] = SmallInt # E def func4(x: type[T]) -> T: return x() func4(Annotated[str, ""]) # E func4(SmallInt) # E # > An attempt to call Annotated (whether parameterized or not) should be # > treated as a type error by type checkers. Annotated() # E Annotated[int, ""]() # E SmallInt(1) # E class ClassA: a: ClassVar[Annotated[int, ""]] = 1 b: Annotated[ClassVar[int], ""] = 1 c: Final[Annotated[int, ""]] = 1 d: Annotated[Final[int], ""] = 1 @dataclass class ClassB: a: InitVar[Annotated[int, ""]] b: Annotated[InitVar[int], ""] class ClassC(TypedDict): a: Annotated[Required[int], ""] b: Required[Annotated[int, ""]] c: Annotated[NotRequired[int], ""] d: NotRequired[Annotated[int, ""]] TA1: TypeAlias = Annotated[int | str, ""] TA2 = Annotated[Literal[1, 2], ""] TA3 = Annotated[T, ""]