]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-41789: honor object overrides in Enum classes (GH-22250)
authorEthan Furman <ethan@stoneleaf.us>
Tue, 15 Sep 2020 23:28:25 +0000 (16:28 -0700)
committerGitHub <noreply@github.com>
Tue, 15 Sep 2020 23:28:25 +0000 (16:28 -0700)
EnumMeta double-checks that `__repr__`, `__str__`, `__format__`, and `__reduce_ex__` are not the same as `object`'s, and replaces them if they are -- even if that replacement was intentionally done in the Enum being constructed.  This patch fixes that.

Automerge-Triggered-By: @ethanfurman
Lib/enum.py
Lib/test/test_enum.py
Misc/NEWS.d/next/Library/2020-09-14-19-27-46.bpo-41789.pI_uZQ.rst [new file with mode: 0644]

index 5e0088ee89fee3b2aa0f25e82bad3398b86f2c3b..e72d306267461842a1250189655983677b4b3264 100644 (file)
@@ -250,7 +250,11 @@ class EnumMeta(type):
 
         # double check that repr and friends are not the mixin's or various
         # things break (such as pickle)
+        # however, if the method is defined in the Enum itself, don't replace
+        # it
         for name in ('__repr__', '__str__', '__format__', '__reduce_ex__'):
+            if name in classdict:
+                continue
             class_method = getattr(enum_class, name)
             obj_method = getattr(member_type, name, None)
             enum_method = getattr(first_enum, name, None)
index a909c108833fc08670ccc53a13ec2235935ad6d7..865edf1d9cfc67beecafb873800813f7e55f65cb 100644 (file)
@@ -560,6 +560,14 @@ class TestEnum(unittest.TestCase):
         self.assertFormatIsValue('{:>20}', Directional.WEST)
         self.assertFormatIsValue('{:<20}', Directional.WEST)
 
+    def test_object_str_override(self):
+        class Colors(Enum):
+            RED, GREEN, BLUE = 1, 2, 3
+            def __repr__(self):
+                return "test.%s" % (self._name_, )
+            __str__ = object.__str__
+        self.assertEqual(str(Colors.RED), 'test.RED')
+
     def test_enum_str_override(self):
         class MyStrEnum(Enum):
             def __str__(self):
@@ -602,7 +610,6 @@ class TestEnum(unittest.TestCase):
             class Huh(MyStr, MyInt, Enum):
                 One = 1
 
-
     def test_hash(self):
         Season = self.Season
         dates = {}
diff --git a/Misc/NEWS.d/next/Library/2020-09-14-19-27-46.bpo-41789.pI_uZQ.rst b/Misc/NEWS.d/next/Library/2020-09-14-19-27-46.bpo-41789.pI_uZQ.rst
new file mode 100644 (file)
index 0000000..5ce7a3c
--- /dev/null
@@ -0,0 +1,2 @@
+Honor `object` overrides in `Enum` class creation (specifically, `__str__`,
+`__repr__`, `__format__`, and `__reduce_ex__`).