Issue #21548: Fix pydoc.synopsis() and pydoc.apropos() on modules with empty
docstrings.
Initial patch by Yuyang Guo.
diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py
index c11c06b..5bb97e2 100644
--- a/Lib/test/test_pydoc.py
+++ b/Lib/test/test_pydoc.py
@@ -3,6 +3,7 @@
import difflib
import __builtin__
import re
+import py_compile
import pydoc
import contextlib
import inspect
@@ -382,6 +383,34 @@
self.assertEqual(stripid("<type 'exceptions.Exception'>"),
"<type 'exceptions.Exception'>")
+ def test_synopsis(self):
+ with test.test_support.temp_cwd() as test_dir:
+ init_path = os.path.join(test_dir, 'dt.py')
+ with open(init_path, 'w') as fobj:
+ fobj.write('''\
+"""
+my doc
+
+second line
+"""
+foo = 1
+''')
+ py_compile.compile(init_path)
+ synopsis = pydoc.synopsis(init_path, {})
+ self.assertEqual(synopsis, 'my doc')
+
+ def test_synopsis_sourceless_empty_doc(self):
+ with test.test_support.temp_cwd() as test_dir:
+ init_path = os.path.join(test_dir, 'foomod42.py')
+ cached_path = os.path.join(test_dir, 'foomod42.pyc')
+ with open(init_path, 'w') as fobj:
+ fobj.write("foo = 1")
+ py_compile.compile(init_path)
+ synopsis = pydoc.synopsis(init_path, {})
+ self.assertIsNone(synopsis)
+ synopsis_cached = pydoc.synopsis(cached_path, {})
+ self.assertIsNone(synopsis_cached)
+
class PydocImportTest(PydocBaseTest):