Skip to content

gh-102541: Fix Helper.help("mod") for non-existent mod #105934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jul 1, 2023
Merged

gh-102541: Fix Helper.help("mod") for non-existent mod #105934

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e6fb90b
gh-102541: Fix Helper.help when output is non default
Eclips4 Jun 20, 2023
c25776c
Add test
Eclips4 Jun 20, 2023
296c0ba
Rewrite test using the `with` keyword
Eclips4 Jun 20, 2023
c597019
Update Lib/pydoc.py
terryjreedy Jul 1, 2023
834ea6d
Merge branch 'main' into issue-102541
terryjreedy Jul 1, 2023
7b117ac
blurb
terryjreedy Jul 1, 2023
f4eb39d
Update pydoc.py
terryjreedy Jul 1, 2023
8868e95
Update pydoc.py
terryjreedy Jul 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion Lib/pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1790,7 +1790,10 @@ def doc(thing, title='Python Library Documentation: %s', forceload=0,
raise
print(exc)
else:
output.write(render_doc(thing, title, forceload, plaintext))
try:
output.write(render_doc(thing, title, forceload, plaintext))
except ImportError as exc:
output.write(str(exc))

def writedoc(thing, forceload=0):
"""Write HTML documentation to a file in the current directory."""
Expand Down
7 changes: 7 additions & 0 deletions Lib/test/test_pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,6 +631,13 @@ def test_builtin_on_metaclasses(self):
# 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
Expand Down