diff options
author | Ethan Furman <ethan@stoneleaf.us> | 2024-02-28 23:17:49 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-02-28 23:17:49 (GMT) |
commit | 3ea78fd5bc93fc339ef743e6a5dfde35f04d972e (patch) | |
tree | d2721c6a87742242d2f4310fa584e16980d191fe | |
parent | 4d1d35b906010c6db15f54443a9701c20af1db2d (diff) | |
download | cpython-3ea78fd5bc93fc339ef743e6a5dfde35f04d972e.zip cpython-3ea78fd5bc93fc339ef743e6a5dfde35f04d972e.tar.gz cpython-3ea78fd5bc93fc339ef743e6a5dfde35f04d972e.tar.bz2 |
gh-115821: [Enum] better error message for calling super().__new__() (GH-116063)
docs now state to not call super().__new__
if super().__new__ is called, a better error message is now used
-rw-r--r-- | Doc/library/enum.rst | 3 | ||||
-rw-r--r-- | Lib/enum.py | 5 | ||||
-rw-r--r-- | Lib/test/test_enum.py | 13 | ||||
-rw-r--r-- | Misc/NEWS.d/next/Library/2024-02-28-12-14-31.gh-issue-115821.YO2vKA.rst | 2 |
4 files changed, 22 insertions, 1 deletions
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index 30d80ce..6e7de00 100644 --- a/Doc/library/enum.rst +++ b/Doc/library/enum.rst @@ -400,6 +400,9 @@ Data Types results in the call ``int('1a', 16)`` and a value of ``17`` for the member. + ..note:: When writing a custom ``__new__``, do not use ``super().__new__`` -- + call the appropriate ``__new__`` instead. + .. method:: Enum.__repr__(self) Returns the string used for *repr()* calls. By default, returns the diff --git a/Lib/enum.py b/Lib/enum.py index d10b996..22963cc 100644 --- a/Lib/enum.py +++ b/Lib/enum.py @@ -547,7 +547,10 @@ class EnumType(type): classdict['_inverted_'] = None try: exc = None + classdict['_%s__in_progress' % cls] = True enum_class = super().__new__(metacls, cls, bases, classdict, **kwds) + classdict['_%s__in_progress' % cls] = False + delattr(enum_class, '_%s__in_progress' % cls) except Exception as e: # since 3.12 the line "Error calling __set_name__ on '_proto_member' instance ..." # is tacked on to the error instead of raising a RuntimeError @@ -1155,6 +1158,8 @@ class Enum(metaclass=EnumType): # still not found -- verify that members exist, in-case somebody got here mistakenly # (such as via super when trying to override __new__) if not cls._member_map_: + if getattr(cls, '_%s__in_progress' % cls.__name__, False): + raise TypeError('do not use `super().__new__; call the appropriate __new__ directly') from None raise TypeError("%r has no members defined" % cls) # # still not found -- try _missing_ hook diff --git a/Lib/test/test_enum.py b/Lib/test/test_enum.py index cf3e042..27f8bba 100644 --- a/Lib/test/test_enum.py +++ b/Lib/test/test_enum.py @@ -447,7 +447,7 @@ class _EnumTests: def test_bad_new_super(self): with self.assertRaisesRegex( TypeError, - 'has no members defined', + 'do not use .super...__new__;', ): class BadSuper(self.enum_type): def __new__(cls, value): @@ -3409,6 +3409,17 @@ class TestSpecial(unittest.TestCase): self.assertIs(Types(2), Types.NetList) self.assertIs(Types('nl'), Types.NetList) + def test_no_members(self): + with self.assertRaisesRegex( + TypeError, + 'has no members', + ): + Enum(7) + with self.assertRaisesRegex( + TypeError, + 'has no members', + ): + Flag(7) class TestOrder(unittest.TestCase): "test usage of the `_order_` attribute" diff --git a/Misc/NEWS.d/next/Library/2024-02-28-12-14-31.gh-issue-115821.YO2vKA.rst b/Misc/NEWS.d/next/Library/2024-02-28-12-14-31.gh-issue-115821.YO2vKA.rst new file mode 100644 index 0000000..7512a09 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2024-02-28-12-14-31.gh-issue-115821.YO2vKA.rst @@ -0,0 +1,2 @@ +[Enum] Improve error message when calling super().__new__() in custom +__new__. |