summaryrefslogtreecommitdiffstats
path: root/Lib
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2015-02-28 22:42:54 (GMT)
committerSerhiy Storchaka <storchaka@gmail.com>2015-02-28 22:42:54 (GMT)
commit1c205518a35939ef555c74d0e2f8954a5e1828e1 (patch)
tree382366737c04762fa5b6c20414c86177d3acec3e /Lib
parente92951f8da5747f5fd00c7388d9fd8e811422cb3 (diff)
downloadcpython-1c205518a35939ef555c74d0e2f8954a5e1828e1.zip
cpython-1c205518a35939ef555c74d0e2f8954a5e1828e1.tar.gz
cpython-1c205518a35939ef555c74d0e2f8954a5e1828e1.tar.bz2
Issue #19980: Improved help() for non-recognized strings. help('') now
shows the help on str. help('help') now shows the help on help(). Original patch by Mark Lawrence.
Diffstat (limited to 'Lib')
-rwxr-xr-xLib/pydoc.py14
-rw-r--r--Lib/test/test_pydoc.py5
2 files changed, 14 insertions, 5 deletions
diff --git a/Lib/pydoc.py b/Lib/pydoc.py
index b762389..c92b324 100755
--- a/Lib/pydoc.py
+++ b/Lib/pydoc.py
@@ -1577,7 +1577,10 @@ def resolve(thing, forceload=0):
if isinstance(thing, str):
object = locate(thing, forceload)
if not object:
- raise ImportError('no Python documentation found for %r' % thing)
+ raise ImportError('''\
+No Python documentation found for %r.
+Use help() to get the interactive help utility.
+Use help(str) for help on the str class.''' % thing)
return object, thing
else:
name = getattr(thing, '__name__', None)
@@ -1848,7 +1851,10 @@ has the same effect as typing a particular string at the help> prompt.
break
request = replace(request, '"', '', "'", '').strip()
if request.lower() in ('q', 'quit'): break
- self.help(request)
+ if request == 'help':
+ self.intro()
+ else:
+ self.help(request)
def getline(self, prompt):
"""Read one line, using input() when appropriate."""
@@ -1862,8 +1868,7 @@ has the same effect as typing a particular string at the help> prompt.
def help(self, request):
if type(request) is type(''):
request = request.strip()
- if request == 'help': self.intro()
- elif request == 'keywords': self.listkeywords()
+ if request == 'keywords': self.listkeywords()
elif request == 'symbols': self.listsymbols()
elif request == 'topics': self.listtopics()
elif request == 'modules': self.listmodules()
@@ -1876,6 +1881,7 @@ has the same effect as typing a particular string at the help> prompt.
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)
+ else: doc(str, 'Help on %s:', output=self._output)
elif isinstance(request, Helper): self()
else: doc(request, 'Help on %s:', output=self._output)
self.output.write('\n')
diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py
index e9fed0a..edfdb66 100644
--- a/Lib/test/test_pydoc.py
+++ b/Lib/test/test_pydoc.py
@@ -256,7 +256,10 @@ expected_html_data_docstrings = tuple(s.replace(' ', '&nbsp;')
for s in expected_data_docstrings)
# output pattern for missing module
-missing_pattern = "no Python documentation found for '%s'"
+missing_pattern = '''\
+No Python documentation found for %r.
+Use help() to get the interactive help utility.
+Use help(str) for help on the str class.'''.replace('\n', os.linesep)
# output pattern for module with bad imports
badimport_pattern = "problem in %s - ImportError: No module named %r"