#14638: pydoc now treats non-str __name__ as None instead of raising

Original patch by Peter Otten.

diff --git a/Lib/pydoc.py b/Lib/pydoc.py
index 674af6aacf1bf006185ca6e07f3604fabf94222d..68ba21f30fc51e95abfe327b0a4ac4fbab2b0a02 100755 (executable)
--- a/Lib/pydoc.py
+++ b/Lib/pydoc.py
@@ -1498,7 +1498,8 @@ def resolve(thing, forceload=0):
             raise ImportError, 'no Python documentation found for %r' % thing
         return object, thing
     else:
-        return thing, getattr(thing, '__name__', None)
+        name = getattr(thing, '__name__', None)
+        return thing, name if isinstance(name, str) else None
 
 def render_doc(thing, title='Python Library Documentation: %s', forceload=0):
     """Render text documentation, given an object or a path to an object."""

diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py
index 59cbffe6d242d67556ff174067ec9e04ca6d342d..d95e7069ce1a395b3f988c2bf0b3d9264f1e24ac 100644 (file)
--- a/Lib/test/test_pydoc.py
+++ b/Lib/test/test_pydoc.py
@@ -249,6 +249,17 @@ class PyDocDocTest(unittest.TestCase):
         result, doc_loc = get_pydoc_text(xml.etree)
         self.assertEqual(doc_loc, "", "MODULE DOCS incorrectly includes a link")
 
+    def test_non_str_name(self):
+        # issue14638
+        # Treat illegal (non-str) name like no name
+        class A:
+            __name__ = 42
+        class B:
+            pass
+        adoc = pydoc.render_doc(A())
+        bdoc = pydoc.render_doc(B())
+        self.assertEqual(adoc.replace("A", "B"), bdoc)
+
     def test_not_here(self):
         missing_module = "test.i_am_not_here"
         result = run_pydoc(missing_module)

diff --git a/Misc/NEWS b/Misc/NEWS
index eb0c9de2217f927b75adcfdd98730b063052aaa3..9f7cbdd0a5afa7258f6593ee380c384df2d550e2 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -50,6 +50,9 @@ Core and Builtins
 Library
 -------
 
+- Issue #14638: pydoc now treats non-string __name__ values as if they
+  were missing, instead of raising an error.
+
 - Issue #13684: Fix httplib tunnel issue of infinite loops for certain sites
   which send EOF without trailing \r\n.