Issue #18010: Fix pydoc web server search to handle package exceptions

Implementation by Antoine Pitrou.

diff --git a/Lib/pydoc.py b/Lib/pydoc.py
index 0c7b60d98dd22582fd62308fa22ab0b7ddb646e0..f42299f7125390db589722b4b8353bc647bafa78 100755 (executable)
--- a/Lib/pydoc.py
+++ b/Lib/pydoc.py
@@ -2355,7 +2355,9 @@ def _url_handler(url, content_type="text/html"):
 
         with warnings.catch_warnings():
             warnings.filterwarnings('ignore') # ignore problems during import
-            ModuleScanner().run(callback, key)
+            def onerror(modname):
+                pass
+            ModuleScanner().run(callback, key, onerror=onerror)
 
         # format page
         def bltinlink(name):

diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py
index 0e990b62bebb3ea6ae0ddd9ed8b2d364633327cd..343dd21ddf53d3ae85a945801b5fa91c75ed6df5 100644 (file)
--- a/Lib/test/test_pydoc.py
+++ b/Lib/test/test_pydoc.py
@@ -403,6 +403,13 @@ class PydocBaseTest(unittest.TestCase):
         finally:
             pkgutil.walk_packages = walk_packages
 
+    def call_url_handler(self, url, expected_title):
+        text = pydoc._url_handler(url, "text/html")
+        result = get_html_title(text)
+        # Check the title to ensure an unexpected error page was not returned
+        self.assertEqual(result, expected_title, text)
+        return text
+
 
 class PydocDocTest(unittest.TestCase):
 
@@ -715,6 +722,29 @@ class PydocImportTest(PydocBaseTest):
         finally:
             os.chmod(pkgdir, current_mode)
 
+    def test_url_search_package_error(self):
+        # URL handler search should cope with packages that raise exceptions
+        pkgdir = os.path.join(TESTFN, "test_error_package")
+        os.mkdir(pkgdir)
+        init = os.path.join(pkgdir, "__init__.py")
+        with open(init, "wt", encoding="ascii") as f:
+            f.write("""raise ValueError("ouch")\n""")
+        with self.restrict_walk_packages(path=[TESTFN]):
+            # Package has to be importable for the error to have any effect
+            saved_paths = tuple(sys.path)
+            sys.path.insert(0, TESTFN)
+            try:
+                with self.assertRaisesRegex(ValueError, "ouch"):
+                    import test_error_package  # Sanity check
+
+                text = self.call_url_handler("search?key=test_error_package",
+                    "Pydoc: Search Results")
+                found = ('<a href="test_error_package.html">'
+                    'test_error_package</a>')
+                self.assertIn(found, text)
+            finally:
+                sys.path[:] = saved_paths
+
     @unittest.skip('causes undesireable side-effects (#20128)')
     def test_modules(self):
         # See Helper.listmodules().
@@ -891,16 +921,12 @@ class PydocUrlHandlerTest(PydocBaseTest):
 
         with self.restrict_walk_packages():
             for url, title in requests:
-                text = pydoc._url_handler(url, "text/html")
-                result = get_html_title(text)
-                self.assertEqual(result, title, text)
+                self.call_url_handler(url, title)
 
             path = string.__file__
             title = "Pydoc: getfile " + path
             url = "getfile?key=" + path
-            text = pydoc._url_handler(url, "text/html")
-            result = get_html_title(text)
-            self.assertEqual(result, title)
+            self.call_url_handler(url, title)
 
 
 class TestHelper(unittest.TestCase):

diff --git a/Misc/NEWS b/Misc/NEWS
index a7029a6bb750bcef13a7af504138e4d3e785245a..d47737051f1552df672b64791b196a925bb440bd 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -96,6 +96,9 @@ Core and Builtins
 Library
 -------
 
+- Issue #18010: Fix the pydoc web server's module search function to handle
+  exceptions from importing packages.
+
 - Issue #25510: fileinput.FileInput.readline() now returns b'' instead of ''
   at the end if the FileInput was opened with binary mode.
   Patch by Ryosuke Ito.