Skip to content

[3.11] gh-108682: [Enum] raise TypeError if super().__new__ called in custom __new__ (GH-108704) #108739

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 1 commit into from
Sep 8, 2023
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
23 changes: 22 additions & 1 deletion Doc/howto/enum.rst
Original file line number Diff line number Diff line change
Expand Up @@ -422,10 +422,17 @@ enumeration, with the exception of special methods (:meth:`__str__`,
:meth:`__add__`, etc.), descriptors (methods are also descriptors), and
variable names listed in :attr:`_ignore_`.

Note: if your enumeration defines :meth:`__new__` and/or :meth:`__init__` then
Note: if your enumeration defines :meth:`__new__` and/or :meth:`__init__`,
any value(s) given to the enum member will be passed into those methods.
See `Planet`_ for an example.

.. note::

The :meth:`__new__` method, if defined, is used during creation of the Enum
members; it is then replaced by Enum's :meth:`__new__` which is used after
class creation for lookup of existing members. See :ref:`new-vs-init` for
more details.


Restricted Enum subclassing
---------------------------
Expand Down Expand Up @@ -860,6 +867,8 @@ Some rules:
:meth:`__str__` method has been reset to their data types'
:meth:`__str__` method.

.. _new-vs-init:

When to use :meth:`__new__` vs. :meth:`__init__`
------------------------------------------------

Expand Down Expand Up @@ -892,6 +901,11 @@ want one of them to be the value::
>>> print(Coordinate(3))
Coordinate.VY

.. warning::

*Do not* call ``super().__new__()``, as the lookup-only ``__new__`` is the one
that is found; instead, use the data type directly.


Finer Points
^^^^^^^^^^^^
Expand Down Expand Up @@ -1316,6 +1330,13 @@ to handle any extra arguments::
members; it is then replaced by Enum's :meth:`__new__` which is used after
class creation for lookup of existing members.

.. warning::

*Do not* call ``super().__new__()``, as the lookup-only ``__new__`` is the one
that is found; instead, use the data type directly -- e.g.::

obj = int.__new__(cls, value)


OrderedEnum
^^^^^^^^^^^
Expand Down
7 changes: 7 additions & 0 deletions Lib/enum.py
Original file line number Diff line number Diff line change
Expand Up @@ -863,6 +863,8 @@ def _create_(cls, class_name, names, *, module=None, qualname=None, type=None, s
value = first_enum._generate_next_value_(name, start, count, last_values[:])
last_values.append(value)
names.append((name, value))
if names is None:
names = ()

# Here, names is either an iterable of (name, value) or a mapping.
for item in names:
Expand Down Expand Up @@ -1107,6 +1109,11 @@ def __new__(cls, value):
for member in cls._member_map_.values():
if member._value_ == value:
return member
# 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_:
raise TypeError("%r has no members defined" % cls)
#
# still not found -- try _missing_ hook
try:
exc = None
Expand Down
11 changes: 11 additions & 0 deletions Lib/test/test_enum.py
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,17 @@ def spam(cls):
with self.assertRaises(AttributeError):
del Season.SPRING.name

def test_bad_new_super(self):
with self.assertRaisesRegex(
TypeError,
'has no members defined',
):
class BadSuper(self.enum_type):
def __new__(cls, value):
obj = super().__new__(cls, value)
return obj
failed = 1

def test_basics(self):
TE = self.MainEnum
if self.is_flag:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Enum: raise :exc:`TypeError` if ``super().__new__()`` is called from a
custom ``__new__``.