Skip to content

bpo-44490: Improve typing module compatibility with types.Union #27048

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 10 commits into from
Jul 17, 2021
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
2 changes: 2 additions & 0 deletions Lib/test/ann_module.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,5 @@ def dec(func):
def wrapper(*args, **kwargs):
return func(*args, **kwargs)
return wrapper

u: int | float
2 changes: 1 addition & 1 deletion Lib/test/test_grammar.py
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@ class CC(metaclass=CMeta):
def test_var_annot_module_semantics(self):
self.assertEqual(test.__annotations__, {})
self.assertEqual(ann_module.__annotations__,
{1: 2, 'x': int, 'y': str, 'f': typing.Tuple[int, int]})
{1: 2, 'x': int, 'y': str, 'f': typing.Tuple[int, int], 'u': int | float})
self.assertEqual(ann_module.M.__annotations__,
{'123': 123, 'o': type})
self.assertEqual(ann_module2.__annotations__, {})
Expand Down
22 changes: 21 additions & 1 deletion Lib/test/test_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,8 @@ def test_repr(self):
self.assertEqual(repr(u), 'typing.Union[typing.List[int], int]')
u = Union[list[int], dict[str, float]]
self.assertEqual(repr(u), 'typing.Union[list[int], dict[str, float]]')
u = Union[int | float]
self.assertEqual(repr(u), 'typing.Union[int, float]')

def test_cannot_subclass(self):
with self.assertRaises(TypeError):
Expand Down Expand Up @@ -1449,6 +1451,8 @@ def test_basics(self):
with self.assertRaises(TypeError):
issubclass(SM1, SimpleMapping)
self.assertIsInstance(SM1(), SimpleMapping)
T = TypeVar("T")
self.assertEqual(List[list[T] | float].__parameters__, (T,))

def test_generic_errors(self):
T = TypeVar('T')
Expand Down Expand Up @@ -1785,6 +1789,7 @@ def test_extended_generic_rules_repr(self):
def test_generic_forward_ref(self):
def foobar(x: List[List['CC']]): ...
def foobar2(x: list[list[ForwardRef('CC')]]): ...
def foobar3(x: list[ForwardRef('CC | int')] | int): ...
class CC: ...
self.assertEqual(
get_type_hints(foobar, globals(), locals()),
Expand All @@ -1794,6 +1799,10 @@ class CC: ...
get_type_hints(foobar2, globals(), locals()),
{'x': list[list[CC]]}
)
self.assertEqual(
get_type_hints(foobar3, globals(), locals()),
{'x': list[CC | int] | int}
)

T = TypeVar('T')
AT = Tuple[T, ...]
Expand Down Expand Up @@ -2467,6 +2476,12 @@ def foo(a: Union['T']):
self.assertEqual(get_type_hints(foo, globals(), locals()),
{'a': Union[T]})

def foo(a: tuple[ForwardRef('T')] | int):
pass

self.assertEqual(get_type_hints(foo, globals(), locals()),
{'a': tuple[T] | int})

def test_tuple_forward(self):

def foo(a: Tuple['T']):
Expand Down Expand Up @@ -2848,7 +2863,7 @@ def test_get_type_hints_from_various_objects(self):
gth(None)

def test_get_type_hints_modules(self):
ann_module_type_hints = {1: 2, 'f': Tuple[int, int], 'x': int, 'y': str}
ann_module_type_hints = {1: 2, 'f': Tuple[int, int], 'x': int, 'y': str, 'u': int | float}
self.assertEqual(gth(ann_module), ann_module_type_hints)
self.assertEqual(gth(ann_module2), {})
self.assertEqual(gth(ann_module3), {})
Expand Down Expand Up @@ -4390,6 +4405,9 @@ def test_no_paramspec_in__parameters__(self):
self.assertNotIn(P, list[P].__parameters__)
self.assertIn(T, tuple[T, P].__parameters__)

self.assertNotIn(P, (list[P] | int).__parameters__)
self.assertIn(T, (tuple[T, P] | int).__parameters__)

def test_paramspec_in_nested_generics(self):
# Although ParamSpec should not be found in __parameters__ of most
# generics, they probably should be found when nested in
Expand All @@ -4399,8 +4417,10 @@ def test_paramspec_in_nested_generics(self):
C1 = Callable[P, T]
G1 = List[C1]
G2 = list[C1]
G3 = list[C1] | int
self.assertEqual(G1.__parameters__, (P, T))
self.assertEqual(G2.__parameters__, (P, T))
self.assertEqual(G3.__parameters__, (P, T))


class ConcatenateTests(BaseTestCase):
Expand Down
18 changes: 13 additions & 5 deletions Lib/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ def _type_repr(obj):
return repr(obj)


def _collect_type_vars(types, typevar_types=None):
def _collect_type_vars(types_, typevar_types=None):
"""Collect all type variable contained
in types in order of first appearance (lexicographic order). For example::

Expand All @@ -205,10 +205,10 @@ def _collect_type_vars(types, typevar_types=None):
if typevar_types is None:
typevar_types = TypeVar
tvars = []
for t in types:
for t in types_:
if isinstance(t, typevar_types) and t not in tvars:
tvars.append(t)
if isinstance(t, (_GenericAlias, GenericAlias)):
if isinstance(t, (_GenericAlias, GenericAlias, types.Union)):
tvars.extend([t for t in t.__parameters__ if t not in tvars])
return tuple(tvars)

Expand Down Expand Up @@ -315,12 +315,14 @@ def _eval_type(t, globalns, localns, recursive_guard=frozenset()):
"""
if isinstance(t, ForwardRef):
return t._evaluate(globalns, localns, recursive_guard)
if isinstance(t, (_GenericAlias, GenericAlias)):
if isinstance(t, (_GenericAlias, GenericAlias, types.Union)):
ev_args = tuple(_eval_type(a, globalns, localns, recursive_guard) for a in t.__args__)
if ev_args == t.__args__:
return t
if isinstance(t, GenericAlias):
return GenericAlias(t.__origin__, ev_args)
if isinstance(t, types.Union):
return functools.reduce(operator.or_, ev_args)
else:
return t.copy_with(ev_args)
return t
Expand Down Expand Up @@ -1009,7 +1011,7 @@ def __getitem__(self, params):
for arg in self.__args__:
if isinstance(arg, self._typevar_types):
arg = subst[arg]
elif isinstance(arg, (_GenericAlias, GenericAlias)):
elif isinstance(arg, (_GenericAlias, GenericAlias, types.Union)):
subparams = arg.__parameters__
if subparams:
subargs = tuple(subst[x] for x in subparams)
Expand Down Expand Up @@ -1775,6 +1777,12 @@ def _strip_annotations(t):
if stripped_args == t.__args__:
return t
return GenericAlias(t.__origin__, stripped_args)
if isinstance(t, types.Union):
stripped_args = tuple(_strip_annotations(a) for a in t.__args__)
if stripped_args == t.__args__:
return t
return functools.reduce(operator.or_, stripped_args)

return t


Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:mod:`typing` now searches for type parameters in ``types.Union`` objects.
``get_type_hints`` will also properly resolve annotations with nested
``types.Union`` objects. Patch provided by Yurii Karabas.