Skip to content

bpo-43224: Add tests for TypeVarTuple substitution in Annotated #31846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions Lib/test/test_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -5873,6 +5873,77 @@ def test_subst(self):
with self.assertRaises(TypeError):
LI[None]

def test_typevar_subst(self):
dec = "a decoration"
Ts = TypeVarTuple('Ts')
T = TypeVar('T')
T1 = TypeVar('T1')
T2 = TypeVar('T2')

A = Annotated[Tuple[Unpack[Ts]], dec]
self.assertEqual(A[int], Annotated[Tuple[int], dec])
self.assertEqual(A[str, int], Annotated[Tuple[str, int], dec])
with self.assertRaises(TypeError):
Annotated[Unpack[Ts], dec]

B = Annotated[Tuple[T, Unpack[Ts]], dec]
self.assertEqual(B[int], Annotated[Tuple[int], dec])
self.assertEqual(B[int, str], Annotated[Tuple[int, str], dec])
self.assertEqual(
B[int, str, float],
Annotated[Tuple[int, str, float], dec]
)
with self.assertRaises(TypeError):
B[()]

C = Annotated[Tuple[Unpack[Ts], T], dec]
self.assertEqual(C[int], Annotated[Tuple[int], dec])
self.assertEqual(C[int, str], Annotated[Tuple[int, str], dec])
self.assertEqual(
C[int, str, float],
Annotated[Tuple[int, str, float], dec]
)
with self.assertRaises(TypeError):
C[()]

D = Annotated[Tuple[T1, Unpack[Ts], T2], dec]
self.assertEqual(D[int, str], Annotated[Tuple[int, str], dec])
self.assertEqual(
D[int, str, float],
Annotated[Tuple[int, str, float], dec]
)
self.assertEqual(
D[int, str, bool, float],
Annotated[Tuple[int, str, bool, float], dec]
)
with self.assertRaises(TypeError):
D[int]

# Now let's try creating an alias from an alias.

Ts2 = TypeVarTuple('Ts2')
T3 = TypeVar('T3')
T4 = TypeVar('T4')

E = D[T3, Unpack[Ts2], T4]
self.assertEqual(
E,
Annotated[Tuple[T3, Unpack[Ts2], T4], dec]
)
self.assertEqual(
E[int, str], Annotated[Tuple[int, str], dec]
)
self.assertEqual(
E[int, str, float],
Annotated[Tuple[int, str, float], dec]
)
self.assertEqual(
E[int, str, bool, float],
Annotated[Tuple[int, str, bool, float], dec]
)
with self.assertRaises(TypeError):
E[int]

def test_annotated_in_other_types(self):
X = List[Annotated[T, 5]]
self.assertEqual(X[int], List[Annotated[int, 5]])
Expand Down
14 changes: 14 additions & 0 deletions Lib/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -2080,6 +2080,17 @@ class Annotated:

OptimizedList = Annotated[List[T], runtime.Optimize()]
OptimizedList[int] == Annotated[List[int], runtime.Optimize()]

- Annotated cannot be used with an unpacked TypeVarTuple::

Annotated[*Ts, Ann1] # NOT valid

This would be equivalent to

Annotated[T1, T2, T3, ..., Ann1]

where T1, T2 etc. are TypeVars, which would be invalid, because
only one type should be passed to Annotated.
"""

__slots__ = ()
Expand All @@ -2093,6 +2104,9 @@ def __class_getitem__(cls, params):
raise TypeError("Annotated[...] should be used "
"with at least two arguments (a type and an "
"annotation).")
if _is_unpacked_typevartuple(params[0]):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need to explicitly disallow this at runtime.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, but then how should we handle situations like this?

A = Annotated[Unpack[Ts], "foo"]
B = A[int, str]

Annotated[int, str, "foo"] wouldn't be valid. We could do some kind of automatic tuple wrapping, Annotated[tuple[int, str], "foo", but that would be inconsistent with how we handle TypeVarTuple substitution elsewhere.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, and sorry for not responding to this earlier.

raise TypeError("Annotated[...] should not be used with an "
"unpacked TypeVarTuple")
msg = "Annotated[t, ...]: t must be a type."
origin = _type_check(params[0], msg, allow_special_forms=True)
metadata = tuple(params[1:])
Expand Down