Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Alternative (simpler) repr for generics #296

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 8 commits into from
Oct 20, 2016
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
39 changes: 34 additions & 5 deletions python2/test_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -521,9 +521,9 @@ def test_init(self):

def test_repr(self):
self.assertEqual(repr(SimpleMapping),
__name__ + '.' + 'SimpleMapping<~XK, ~XV>')
__name__ + '.' + 'SimpleMapping')
self.assertEqual(repr(MySimpleMapping),
__name__ + '.' + 'MySimpleMapping<~XK, ~XV>')
__name__ + '.' + 'MySimpleMapping')

def test_chain_repr(self):
T = TypeVar('T')
Expand All @@ -547,7 +547,36 @@ class C(Generic[T]):
self.assertNotEqual(Z, Y[T])

self.assertTrue(str(Z).endswith(
'.C<~T>[typing.Tuple[~S, ~T]]<~S, ~T>[~T, int]<~T>[str]'))
'.C[typing.Tuple[str, int]]'))

def test_new_repr(self):
T = TypeVar('T')
U = TypeVar('U', covariant=True)
S = TypeVar('S')

self.assertEqual(repr(List), 'typing.List')
self.assertEqual(repr(List[T]), 'typing.List[~T]')
self.assertEqual(repr(List[U]), 'typing.List[+U]')
self.assertEqual(repr(List[S][T][int]), 'typing.List[int]')
self.assertEqual(repr(List[int]), 'typing.List[int]')

def test_new_repr_complex(self):
T = TypeVar('T')
TS = TypeVar('TS')

self.assertEqual(repr(typing.Mapping[T, TS][TS, T]), 'typing.Mapping[~TS, ~T]')
self.assertEqual(repr(List[Tuple[T, TS]][int, T]),
'typing.List[typing.Tuple[int, ~T]]')
self.assertEqual(repr(List[Tuple[T, T]][List[int]]),
'typing.List[typing.Tuple[typing.List[int], typing.List[int]]]')

def test_new_repr_bare(self):
T = TypeVar('T')
self.assertEqual(repr(Generic[T]), 'typing.Generic[~T]')
self.assertEqual(repr(typing._Protocol[T]), 'typing.Protocol[~T]')
class C(typing.Dict[Any, Any]): pass
# this line should just work
repr(C.__mro__)

def test_dict(self):
T = TypeVar('T')
Expand Down Expand Up @@ -635,12 +664,12 @@ class C(Generic[T]):
if not PY32:
self.assertEqual(C.__qualname__,
'GenericTests.test_repr_2.<locals>.C')
self.assertEqual(repr(C).split('.')[-1], 'C<~T>')
self.assertEqual(repr(C).split('.')[-1], 'C')
X = C[int]
self.assertEqual(X.__module__, __name__)
if not PY32:
self.assertEqual(X.__qualname__, 'C')
self.assertEqual(repr(X).split('.')[-1], 'C<~T>[int]')
self.assertEqual(repr(X).split('.')[-1], 'C[int]')

class Y(C[int]):
pass
Expand Down
78 changes: 57 additions & 21 deletions python2/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,8 @@ def __getitem__(self, parameter):
if not issubclass(parameter, self.type_var.__constraints__):
raise TypeError("%s is not a valid substitution for %s." %
(parameter, self.type_var))
if isinstance(parameter, TypeVar):
raise TypeError("%s cannot be re-parameterized." % self.type_var)
if isinstance(parameter, TypeVar) and parameter is not self.type_var:
raise TypeError("%s cannot be re-parameterized." % self)
return self.__class__(self.name, parameter,
self.impl_type, self.type_checker)

Expand Down Expand Up @@ -398,12 +398,15 @@ def _eval_type(self, globalns, localns):

def _get_type_vars(self, tvars):
if self.__type__:
_get_type_vars(self.__type__, tvars)
_get_type_vars([self.__type__], tvars)

def __repr__(self):
return self._subs_repr([], [])

def _subs_repr(self, tvars, args):
r = super(_ClassVar, self).__repr__()
if self.__type__ is not None:
r += '[{}]'.format(_type_repr(self.__type__))
r += '[{}]'.format(_replace_arg(self.__type__, tvars, args))
return r

def __hash__(self):
Expand Down Expand Up @@ -703,9 +706,12 @@ def _get_type_vars(self, tvars):
_get_type_vars(self.__union_params__, tvars)

def __repr__(self):
return self._subs_repr([], [])

def _subs_repr(self, tvars, args):
r = super(_Union, self).__repr__()
if self.__union_params__:
r += '[%s]' % (', '.join(_type_repr(t)
r += '[%s]' % (', '.join(_replace_arg(t, tvars, args)
for t in self.__union_params__))
return r

Expand Down Expand Up @@ -805,9 +811,12 @@ def _eval_type(self, globalns, localns):
return self.__class__(p, _root=True)

def __repr__(self):
return self._subs_repr([], [])

def _subs_repr(self, tvars, args):
r = super(_Tuple, self).__repr__()
if self.__tuple_params__ is not None:
params = [_type_repr(p) for p in self.__tuple_params__]
params = [_replace_arg(p, tvars, args) for p in self.__tuple_params__]
if self.__tuple_use_ellipsis__:
params.append('...')
if not params:
Expand Down Expand Up @@ -898,6 +907,8 @@ def __init__(self, args=None, result=None, _root=False):
def _get_type_vars(self, tvars):
if self.__args__ and self.__args__ is not Ellipsis:
_get_type_vars(self.__args__, tvars)
if self.__result__:
_get_type_vars([self.__result__], tvars)

def _eval_type(self, globalns, localns):
if self.__args__ is None and self.__result__ is None:
Expand All @@ -913,14 +924,17 @@ def _eval_type(self, globalns, localns):
return self.__class__(args=args, result=result, _root=True)

def __repr__(self):
return self._subs_repr([], [])

def _subs_repr(self, tvars, args):
r = super(_Callable, self).__repr__()
if self.__args__ is not None or self.__result__ is not None:
if self.__args__ is Ellipsis:
args_r = '...'
else:
args_r = '[%s]' % ', '.join(_type_repr(t)
args_r = '[%s]' % ', '.join(_replace_arg(t, tvars, args)
for t in self.__args__)
r += '[%s, %s]' % (args_r, _type_repr(self.__result__))
r += '[%s, %s]' % (args_r, _replace_arg(self.__result__, tvars, args))
return r

def __getitem__(self, parameters):
Expand Down Expand Up @@ -985,6 +999,16 @@ def _geqv(a, b):
return _gorg(a) is _gorg(b)


def _replace_arg(arg, tvars, args):
if hasattr(arg, '_subs_repr'):
return arg._subs_repr(tvars, args)
if isinstance(arg, TypeVar):
for i, tvar in enumerate(tvars):
if arg.__name__ == tvar.__name__:
return args[i]
return _type_repr(arg)


def _next_in_mro(cls):
"""Helper for Generic.__new__.

Expand Down Expand Up @@ -1115,17 +1139,29 @@ def _get_type_vars(self, tvars):
_get_type_vars(self.__parameters__, tvars)

def __repr__(self):
if self.__origin__ is not None:
r = repr(self.__origin__)
else:
r = super(GenericMeta, self).__repr__()
if self.__args__:
r += '[%s]' % (
', '.join(_type_repr(p) for p in self.__args__))
if self.__parameters__:
r += '<%s>' % (
', '.join(_type_repr(p) for p in self.__parameters__))
return r
if self.__origin__ is None:
return super(GenericMeta, self).__repr__()
return self._subs_repr([], [])

def _subs_repr(self, tvars, args):
assert len(tvars) == len(args)
# Construct the chain of __origin__'s.
current = self.__origin__
orig_chain = []
while current.__origin__ is not None:
orig_chain.append(current)
current = current.__origin__
# Replace type variables in __args__ if asked ...
str_args = []
for arg in self.__args__:
str_args.append(_replace_arg(arg, tvars, args))
# ... then continue replacing down the origin chain.
for cls in orig_chain:
new_str_args = []
for i, arg in enumerate(cls.__args__):
new_str_args.append(_replace_arg(arg, cls.__parameters__, str_args))
str_args = new_str_args
return super(GenericMeta, self).__repr__() + '[%s]' % ', '.join(str_args)

def __eq__(self, other):
if not isinstance(other, GenericMeta):
Expand Down Expand Up @@ -1158,11 +1194,11 @@ def __getitem__(self, params):
raise TypeError(
"Parameters to Generic[...] must all be unique")
tvars = params
args = None
args = params
elif self is _Protocol:
# _Protocol is internal, don't check anything.
tvars = params
args = None
args = params
elif self.__origin__ in (Generic, _Protocol):
# Can't subscript Generic[...] or _Protocol[...].
raise TypeError("Cannot subscript already-subscripted %s" %
Expand Down
39 changes: 34 additions & 5 deletions src/test_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -548,9 +548,9 @@ def test_init(self):

def test_repr(self):
self.assertEqual(repr(SimpleMapping),
__name__ + '.' + 'SimpleMapping<~XK, ~XV>')
__name__ + '.' + 'SimpleMapping')
self.assertEqual(repr(MySimpleMapping),
__name__ + '.' + 'MySimpleMapping<~XK, ~XV>')
__name__ + '.' + 'MySimpleMapping')

def test_chain_repr(self):
T = TypeVar('T')
Expand All @@ -574,7 +574,36 @@ class C(Generic[T]):
self.assertNotEqual(Z, Y[T])

self.assertTrue(str(Z).endswith(
'.C<~T>[typing.Tuple[~S, ~T]]<~S, ~T>[~T, int]<~T>[str]'))
'.C[typing.Tuple[str, int]]'))

def test_new_repr(self):
T = TypeVar('T')
U = TypeVar('U', covariant=True)
S = TypeVar('S')

self.assertEqual(repr(List), 'typing.List')
self.assertEqual(repr(List[T]), 'typing.List[~T]')
self.assertEqual(repr(List[U]), 'typing.List[+U]')
self.assertEqual(repr(List[S][T][int]), 'typing.List[int]')
self.assertEqual(repr(List[int]), 'typing.List[int]')

def test_new_repr_complex(self):
T = TypeVar('T')
TS = TypeVar('TS')

self.assertEqual(repr(typing.Mapping[T, TS][TS, T]), 'typing.Mapping[~TS, ~T]')
self.assertEqual(repr(List[Tuple[T, TS]][int, T]),
'typing.List[typing.Tuple[int, ~T]]')
self.assertEqual(repr(List[Tuple[T, T]][List[int]]),
'typing.List[typing.Tuple[typing.List[int], typing.List[int]]]')

def test_new_repr_bare(self):
T = TypeVar('T')
self.assertEqual(repr(Generic[T]), 'typing.Generic[~T]')
self.assertEqual(repr(typing._Protocol[T]), 'typing.Protocol[~T]')
class C(typing.Dict[Any, Any]): ...
# this line should just work
repr(C.__mro__)

def test_dict(self):
T = TypeVar('T')
Expand Down Expand Up @@ -662,12 +691,12 @@ class C(Generic[T]):
if not PY32:
self.assertEqual(C.__qualname__,
'GenericTests.test_repr_2.<locals>.C')
self.assertEqual(repr(C).split('.')[-1], 'C<~T>')
self.assertEqual(repr(C).split('.')[-1], 'C')
X = C[int]
self.assertEqual(X.__module__, __name__)
if not PY32:
self.assertEqual(X.__qualname__, 'C')
self.assertEqual(repr(X).split('.')[-1], 'C<~T>[int]')
self.assertEqual(repr(X).split('.')[-1], 'C[int]')

class Y(C[int]):
pass
Expand Down
Loading