diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2023-07-01 23:15:44 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-01 23:15:44 (GMT) |
commit | 9e335860188229a7985fe9a8b72ee62c684aa9eb (patch) | |
tree | 7584de0c1372d8da2a798431dff1d405bd218401 | |
parent | f5e29f424597a970d7cfde3402891259e0e4c1dd (diff) | |
download | cpython-9e335860188229a7985fe9a8b72ee62c684aa9eb.zip cpython-9e335860188229a7985fe9a8b72ee62c684aa9eb.tar.gz cpython-9e335860188229a7985fe9a8b72ee62c684aa9eb.tar.bz2 |
[3.11] gh-102541: Fix Helper.help("mod") for non-existent mod (GH-105934) (#106323)
gh-102541: Fix Helper.help("mod") for non-existent mod (GH-105934)
If the output arg to Helper() is a stream rather than the default None, which means 'page to stdout', the ImportError from pydoc.resolve is currently not caught in pydoc.doc. The same error is caught when output is None.
---------
(cherry picked from commit 0530f4f64629ff97f3feb7524da0833b9535e8b6)
Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
-rwxr-xr-x | Lib/pydoc.py | 6 | ||||
-rw-r--r-- | Lib/test/test_pydoc.py | 7 | ||||
-rw-r--r-- | Misc/NEWS.d/next/Library/2023-07-01-16-40-54.gh-issue-102541.C1ahtk.rst | 1 |
3 files changed, 13 insertions, 1 deletions
diff --git a/Lib/pydoc.py b/Lib/pydoc.py index 151c7e8..5e191bc 100755 --- a/Lib/pydoc.py +++ b/Lib/pydoc.py @@ -1788,7 +1788,11 @@ def doc(thing, title='Python Library Documentation: %s', forceload=0, raise print(exc) else: - output.write(render_doc(thing, title, forceload, plaintext)) + try: + s = render_doc(thing, title, forceload, plaintext) + except ImportError as exc: + s = str(exc) + output.write(s) def writedoc(thing, forceload=0): """Write HTML documentation to a file in the current directory.""" diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py index 89faf0d..71be6d5 100644 --- a/Lib/test/test_pydoc.py +++ b/Lib/test/test_pydoc.py @@ -631,6 +631,13 @@ class PydocDocTest(unittest.TestCase): # Testing that the subclasses section does not appear self.assertNotIn('Built-in subclasses', text) + def test_fail_help_output_redirect(self): + with StringIO() as buf: + helper = pydoc.Helper(output=buf) + helper.help("abd") + expected = missing_pattern % "abd" + self.assertEqual(expected, buf.getvalue().strip().replace('\n', os.linesep)) + @unittest.skipIf(hasattr(sys, 'gettrace') and sys.gettrace(), 'trace function introduces __locals__ unexpectedly') @requires_docstrings diff --git a/Misc/NEWS.d/next/Library/2023-07-01-16-40-54.gh-issue-102541.C1ahtk.rst b/Misc/NEWS.d/next/Library/2023-07-01-16-40-54.gh-issue-102541.C1ahtk.rst new file mode 100644 index 0000000..efaf5db --- /dev/null +++ b/Misc/NEWS.d/next/Library/2023-07-01-16-40-54.gh-issue-102541.C1ahtk.rst @@ -0,0 +1 @@ +Make pydoc.doc catch bad module ImportError when output stream is not None. |