mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-23 02:04:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

bpo-37755: Use configured output in pydoc instead of pager (GH-15105)

Browse source 
If the Helper() class was initialized with an output, the topics, keywords
and symbols help still use the pager instead of the output.
Change the behavior so  the output is used if available while keeping the
previous behavior if no output was configured.
This commit is contained in:
Enrico Tröger 2024-06-08 11:19:13 +02:00 • committed by GitHub
parent 95f4db88d5
commit 2080425154
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 116 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Lib/pydoc.py
View file

@ -2034,7 +2034,7 @@ has the same effect as typing a particular string at the help> prompt.
elif request in self.symbols: self.showsymbol(request)
elif request in ['True', 'False', 'None']:
# special case these keywords since they are objects too
doc(eval(request), 'Help on %s:', is_cli=is_cli)
doc(eval(request), 'Help on %s:', output=self._output, is_cli=is_cli)
elif request in self.keywords: self.showtopic(request)
elif request in self.topics: self.showtopic(request)
elif request: doc(request, 'Help on %s:', output=self._output, is_cli=is_cli)
@ -2127,7 +2127,11 @@ module "pydoc_data.topics" could not be found.
text = 'Related help topics: ' + ', '.join(xrefs.split()) + '\n'
wrapped_text = textwrap.wrap(text, 72)
doc += '\n%s\n' % '\n'.join(wrapped_text)
pager(doc, f'Help on {topic!s}')
if self._output is None:
pager(doc, f'Help on {topic!s}')
else:
self.output.write(doc)
def _gettopic(self, topic, more_xrefs=''):
"""Return unbuffered tuple of (topic, xrefs).