bpo-44490: Improve typing module compatibility with types.Union (GH-27048) (#27222)

(cherry picked from commit bf89ff96e6)

Co-authored-by: Yurii Karabas <1998uriyyo@gmail.com>
This commit is contained in:
Ken Jin 2021-07-19 22:22:59 +08:00 committed by GitHub
parent 37bdd2221c
commit a272164959
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 40 additions and 7 deletions

View file

@ -58,3 +58,5 @@ def dec(func):
def wrapper(*args, **kwargs): def wrapper(*args, **kwargs):
return func(*args, **kwargs) return func(*args, **kwargs)
return wrapper return wrapper
u: int | float

View file

@ -473,7 +473,7 @@ class GrammarTests(unittest.TestCase):
def test_var_annot_module_semantics(self): def test_var_annot_module_semantics(self):
self.assertEqual(test.__annotations__, {}) self.assertEqual(test.__annotations__, {})
self.assertEqual(ann_module.__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__, self.assertEqual(ann_module.M.__annotations__,
{'123': 123, 'o': type}) {'123': 123, 'o': type})
self.assertEqual(ann_module2.__annotations__, {}) self.assertEqual(ann_module2.__annotations__, {})

View file

@ -315,6 +315,8 @@ class UnionTests(BaseTestCase):
self.assertEqual(repr(u), 'typing.Union[typing.List[int], int]') self.assertEqual(repr(u), 'typing.Union[typing.List[int], int]')
u = Union[list[int], dict[str, float]] u = Union[list[int], dict[str, float]]
self.assertEqual(repr(u), 'typing.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): def test_cannot_subclass(self):
with self.assertRaises(TypeError): with self.assertRaises(TypeError):
@ -1449,6 +1451,8 @@ class GenericTests(BaseTestCase):
with self.assertRaises(TypeError): with self.assertRaises(TypeError):
issubclass(SM1, SimpleMapping) issubclass(SM1, SimpleMapping)
self.assertIsInstance(SM1(), SimpleMapping) self.assertIsInstance(SM1(), SimpleMapping)
T = TypeVar("T")
self.assertEqual(List[list[T] | float].__parameters__, (T,))
def test_generic_errors(self): def test_generic_errors(self):
T = TypeVar('T') T = TypeVar('T')
@ -1785,6 +1789,7 @@ class GenericTests(BaseTestCase):
def test_generic_forward_ref(self): def test_generic_forward_ref(self):
def foobar(x: List[List['CC']]): ... def foobar(x: List[List['CC']]): ...
def foobar2(x: list[list[ForwardRef('CC')]]): ... def foobar2(x: list[list[ForwardRef('CC')]]): ...
def foobar3(x: list[ForwardRef('CC | int')] | int): ...
class CC: ... class CC: ...
self.assertEqual( self.assertEqual(
get_type_hints(foobar, globals(), locals()), get_type_hints(foobar, globals(), locals()),
@ -1794,6 +1799,10 @@ class GenericTests(BaseTestCase):
get_type_hints(foobar2, globals(), locals()), get_type_hints(foobar2, globals(), locals()),
{'x': list[list[CC]]} {'x': list[list[CC]]}
) )
self.assertEqual(
get_type_hints(foobar3, globals(), locals()),
{'x': list[CC | int] | int}
)
T = TypeVar('T') T = TypeVar('T')
AT = Tuple[T, ...] AT = Tuple[T, ...]
@ -2467,6 +2476,12 @@ class ForwardRefTests(BaseTestCase):
self.assertEqual(get_type_hints(foo, globals(), locals()), self.assertEqual(get_type_hints(foo, globals(), locals()),
{'a': Union[T]}) {'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 test_tuple_forward(self):
def foo(a: Tuple['T']): def foo(a: Tuple['T']):
@ -2851,7 +2866,7 @@ class GetTypeHintTests(BaseTestCase):
gth(None) gth(None)
def test_get_type_hints_modules(self): 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_module), ann_module_type_hints)
self.assertEqual(gth(ann_module2), {}) self.assertEqual(gth(ann_module2), {})
self.assertEqual(gth(ann_module3), {}) self.assertEqual(gth(ann_module3), {})
@ -4393,6 +4408,9 @@ class ParamSpecTests(BaseTestCase):
self.assertNotIn(P, list[P].__parameters__) self.assertNotIn(P, list[P].__parameters__)
self.assertIn(T, tuple[T, 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): def test_paramspec_in_nested_generics(self):
# Although ParamSpec should not be found in __parameters__ of most # Although ParamSpec should not be found in __parameters__ of most
# generics, they probably should be found when nested in # generics, they probably should be found when nested in
@ -4402,8 +4420,10 @@ class ParamSpecTests(BaseTestCase):
C1 = Callable[P, T] C1 = Callable[P, T]
G1 = List[C1] G1 = List[C1]
G2 = list[C1] G2 = list[C1]
G3 = list[C1] | int
self.assertEqual(G1.__parameters__, (P, T)) self.assertEqual(G1.__parameters__, (P, T))
self.assertEqual(G2.__parameters__, (P, T)) self.assertEqual(G2.__parameters__, (P, T))
self.assertEqual(G3.__parameters__, (P, T))
class ConcatenateTests(BaseTestCase): class ConcatenateTests(BaseTestCase):

View file

@ -195,7 +195,7 @@ def _type_repr(obj):
return 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 """Collect all type variable contained
in types in order of first appearance (lexicographic order). For example:: in types in order of first appearance (lexicographic order). For example::
@ -204,10 +204,10 @@ def _collect_type_vars(types, typevar_types=None):
if typevar_types is None: if typevar_types is None:
typevar_types = TypeVar typevar_types = TypeVar
tvars = [] tvars = []
for t in types: for t in types_:
if isinstance(t, typevar_types) and t not in tvars: if isinstance(t, typevar_types) and t not in tvars:
tvars.append(t) 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]) tvars.extend([t for t in t.__parameters__ if t not in tvars])
return tuple(tvars) return tuple(tvars)
@ -314,12 +314,14 @@ def _eval_type(t, globalns, localns, recursive_guard=frozenset()):
""" """
if isinstance(t, ForwardRef): if isinstance(t, ForwardRef):
return t._evaluate(globalns, localns, recursive_guard) 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__) ev_args = tuple(_eval_type(a, globalns, localns, recursive_guard) for a in t.__args__)
if ev_args == t.__args__: if ev_args == t.__args__:
return t return t
if isinstance(t, GenericAlias): if isinstance(t, GenericAlias):
return GenericAlias(t.__origin__, ev_args) return GenericAlias(t.__origin__, ev_args)
if isinstance(t, types.Union):
return functools.reduce(operator.or_, ev_args)
else: else:
return t.copy_with(ev_args) return t.copy_with(ev_args)
return t return t
@ -1013,7 +1015,7 @@ class _GenericAlias(_BaseGenericAlias, _root=True):
for arg in self.__args__: for arg in self.__args__:
if isinstance(arg, self._typevar_types): if isinstance(arg, self._typevar_types):
arg = subst[arg] arg = subst[arg]
elif isinstance(arg, (_GenericAlias, GenericAlias)): elif isinstance(arg, (_GenericAlias, GenericAlias, types.Union)):
subparams = arg.__parameters__ subparams = arg.__parameters__
if subparams: if subparams:
subargs = tuple(subst[x] for x in subparams) subargs = tuple(subst[x] for x in subparams)
@ -1779,6 +1781,12 @@ def _strip_annotations(t):
if stripped_args == t.__args__: if stripped_args == t.__args__:
return t return t
return GenericAlias(t.__origin__, stripped_args) 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 return t

View file

@ -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.