From e64e51bfa78cd8ec046e187a3214cd9d477fc65c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Fri, 29 Jul 2011 17:03:55 +0200 Subject: =?UTF-8?q?Make=20=E2=80=9Cpydoc=20somebuiltin.somemethod=E2=80=9D?= =?UTF-8?q?=20work=20(#8887)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Lib/pydoc.py | 13 +++++++------ Lib/test/test_pydoc.py | 18 ++++++++++++++++++ Misc/NEWS | 3 +++ 3 files changed, 28 insertions(+), 6 deletions(-) diff --git a/Lib/pydoc.py b/Lib/pydoc.py index 34b2f51..8e2e47b 100755 --- a/Lib/pydoc.py +++ b/Lib/pydoc.py @@ -1482,13 +1482,14 @@ def locate(path, forceload=0): else: break if module: object = module - for part in parts[n:]: - try: object = getattr(object, part) - except AttributeError: return None - return object else: - if hasattr(builtins, path): - return getattr(builtins, path) + object = builtins + for part in parts[n:]: + try: + object = getattr(object, part) + except AttributeError: + return None + return object # --------------------------------------- interactive interpreter interface diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py index 2a21a7e..72f5882 100644 --- a/Lib/test/test_pydoc.py +++ b/Lib/test/test_pydoc.py @@ -1,5 +1,6 @@ import os import sys +import builtins import difflib import inspect import pydoc @@ -419,6 +420,23 @@ class TestDescriptions(unittest.TestCase): expected = 'C in module %s object' % __name__ self.assertIn(expected, pydoc.render_doc(c)) + def test_builtin(self): + for name in ('str', 'str.translate', 'builtins.str', + 'builtins.str.translate'): + # test low-level function + self.assertIsNotNone(pydoc.locate(name)) + # test high-level function + try: + pydoc.render_doc(name) + except ImportError: + self.fail('finding the doc of {!r} failed'.format(o)) + + for name in ('notbuiltins', 'strrr', 'strr.translate', + 'str.trrrranslate', 'builtins.strrr', + 'builtins.str.trrranslate'): + self.assertIsNone(pydoc.locate(name)) + self.assertRaises(ImportError, pydoc.render_doc, name) + @unittest.skipUnless(threading, 'Threading required for this test.') class PydocServerTest(unittest.TestCase): diff --git a/Misc/NEWS b/Misc/NEWS index 022c90d..1021df7 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -41,6 +41,9 @@ Core and Builtins Library ------- +- Issue #8887: "pydoc somebuiltin.somemethod" (or help('somebuiltin.somemethod') + in Python code) now finds the doc of the method. + - Issue #12603: Fix pydoc.synopsis() on files with non-negative st_mtime. - Issue #12514: Use try/finally to assure the timeit module restores garbage -- cgit v0.12