Issue #20654: Fixed pydoc for enums with zero value. Patch by Vajrasky Kok.

serhiy-storchaka · serhiy-storchaka · commit 056eb0271949 · 2014-02-19T23:05:12.000+02:00
diff --git a/Lib/pydoc.py b/Lib/pydoc.py
@@ -1244,9 +1244,12 @@ def spilldata(msg, attrs, predicate):
                         doc = getdoc(value)
                     else:
                         doc = None
-                    push(self.docother(
-                        getattr(object, name, None) or homecls.__dict__[name],
-                        name, mod, maxlen=70, doc=doc) + '\n')
+                    try:
+                        obj = getattr(object, name)
+                    except AttributeError:
+                        obj = homecls.__dict__[name]
+                    push(self.docother(obj, name, mod, maxlen=70, doc=doc) +
+                         '\n')
             return attrs
 
         attrs = [(name, kind, cls, value)
diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py
@@ -386,6 +386,16 @@ def test_text_doc(self):
             print_diffs(expected_text, result)
             self.fail("outputs are not equal, see diff above")
 
+    def test_text_enum_member_with_value_zero(self):
+        # Test issue #20654 to ensure enum member with value 0 can be
+        # displayed. It used to throw KeyError: 'zero'.
+        import enum
+        class BinaryInteger(enum.IntEnum):
+            zero = 0
+            one = 1
+        doc = pydoc.render_doc(BinaryInteger)
+        self.assertIn('<BinaryInteger.zero: 0>', doc)
+
     def test_issue8225(self):
         # Test issue8225 to ensure no doc link appears for xml.etree
         result, doc_loc = get_pydoc_text(xml.etree)
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -28,6 +28,8 @@ Core and Builtins
 Library
 -------
 
+- Issue #20654: Fixed pydoc for enums with zero value.  Patch by Vajrasky Kok.
+
 - Issue #20635: Fixed grid_columnconfigure() and grid_rowconfigure() methods of
   Tkinter widgets to work in wantobjects=True mode.
 
