Skip to content

bpo-46170: Improve the error message when subclassing NewType #30268

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 17 commits into from
Mar 8, 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
11 changes: 11 additions & 0 deletions Lib/test/test_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -4383,6 +4383,17 @@ def test_missing__name__(self):
)
exec(code, {})

def test_error_message_when_subclassing(self):
with self.assertRaisesRegex(
TypeError,
re.escape(
"Cannot subclass an instance of NewType. Perhaps you were looking for: "
"`ProUserId = NewType('ProUserId', UserId)`"
)
):
class ProUserId(UserId):
...


class NewTypePythonTests(NewTypeTests, BaseTestCase):
module = py_typing
Expand Down
15 changes: 15 additions & 0 deletions Lib/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -2633,6 +2633,21 @@ def __init__(self, name, tp):
if def_mod != 'typing':
self.__module__ = def_mod

def __mro_entries__(self, bases):
# We defined __mro_entries__ to get a better error message
# if a user attempts to subclass a NewType instance. bpo-46170
superclass_name = self.__name__

class Dummy:
def __init_subclass__(cls):
subclass_name = cls.__name__
raise TypeError(
f"Cannot subclass an instance of NewType. Perhaps you were looking for: "
f"`{subclass_name} = NewType({subclass_name!r}, {superclass_name})`"
)

return (Dummy,)

def __repr__(self):
return f'{self.__module__}.{self.__qualname__}'

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve the error message when you try to subclass an instance of :class:`typing.NewType`.