8000 Alternative (simpler) repr for generics by ilevkivskyi · Pull Request #296 · python/typing · GitHub
[go: up one dir, main page]

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 1 commit
Commits
File filter

Filter by extension

Filter by extension

8000
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add _subs_repr to other types; fix minor bugs
  • Loading branch information
ilevkivskyi committed Oct 16, 2016
commit 232f80ad41efbbaba9ccb546d85ec58a83beab1a
8 changes: 4 additions & 4 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 Down Expand Up @@ -554,7 +554,7 @@ def test_new_repr(self):
U = TypeVar('U', covariant=True)
S = TypeVar('S')

self.assertEqual(repr(List), 'typing.List[~T]')
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]')
Expand Down Expand Up @@ -664,7 +664,7 @@ 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:
Expand Down
78 changes: 51 additions & 27 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__()< 10000 /span>
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,29 +1139,29 @@ def _get_type_vars(self, tvars):
_get_type_vars(self.__parameters__, tvars)

def __repr__(self):
return super(GenericMeta, self).__repr__() + self._arg_repr()

def _arg_repr(self):
par_repr = '[%s]' % (', '.join(map(_type_repr, self.__parameters__)))
if self.__origin__ in [Generic, _Protocol]:
return par_repr
if self.__origin__ is None:
if not self.__parameters__:
return ''
return par_repr
return super(GenericMeta, self).__repr__()
return self._subs_repr([], [])

current = self
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__
r = '[%s]' % (', '.join(map(_type_repr, orig_chain[-1].__origin__.__parameters__)))
for tp in reversed(orig_chain):
for i in range(len(tp.__args__)): # replace free parameters with args
par = stdlib_re.escape(_type_repr(tp.__origin__.__parameters__[i]))
r = stdlib_re.sub(par + '(?=[,\]])', '{%r}' % i, r)
r = r.format(*map(_type_repr, tp.__args__))
return r
# 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 @@ -1170,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
8 changes: 4 additions & 4 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 Down Expand Up @@ -581,7 +581,7 @@ def test_new_repr(self):
U = TypeVar('U', covariant=True)
S = TypeVar('S')

self.assertEqual(repr(List), 'typing.List[~T]')
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]')
Expand Down Expand Up @@ -691,7 +691,7 @@ 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:
Expand Down
67 changes: 39 additions & 28 deletions src/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,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 @@ -622,9 +622,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().__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 @@ -706,9 +709,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().__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 @@ -791,6 +797,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 @@ -806,14 +814,17 @@ def _eval_type(self, globalns, localns):
return self.__class__(args, result, _root=True)

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

def _subs_repr(self, tvars, args):
r = super().__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 @@ -878,6 +889,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 @@ -1005,6 +1026,11 @@ def _get_type_vars(self, tvars):
if self.__origin__ and self.__parameters__:
_get_type_vars(self.__parameters__, tvars)

def __repr__(self):
if self.__origin__ is None:
return super().__repr__()
return self._subs_repr([], [])

def _subs_repr(self, tvars, args):
assert len(tvars) == len(args)
# Construct the chain of __origin__'s.
Expand All @@ -1025,14 +1051,6 @@ def _subs_repr(self, tvars, args):
str_args = new_str_args
return super().__repr__() + '[%s]' % ', '.join(str_args)

def __repr__(self):
r = super().__repr__()
if self.__origin__ is None:
return r
if self.__origin__ in [Generic, _Protocol]:
return r + '[%s]' % ', '.join(map(_type_repr, self.__parameters__))
return self._subs_repr([], []) # Not necessary to replace anything

def __eq__(self, other):
if not isinstance(other, GenericMeta):
return NotImplemented
Expand Down Expand Up @@ -1064,11 +1082,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 Expand Up @@ -1102,16 +1120,6 @@ def __instancecheck__(self, instance):
return issubclass(instance.__class__, self)


def _replace_arg(arg, tvars, args):
if isinstance(arg, GenericMeta):
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)


# Prevent checks for Generic to crash when defining Generic.
Generic = None

Expand Down Expand Up @@ -1188,12 +1196,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().__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
0