#17476: make allmethods actually return all methods.
This fixes a regression relative to Python2. (In 2, methods on a class were
unbound methods and matched the inspect queries being done, in 3 they are just
functions and so were missed).
This is an undocumented function that pydoc itself does not use, but
I found that numpy at least uses it in its documentation generator.
Original patch by Matt Bachmann.
diff --git a/Lib/pydoc.py b/Lib/pydoc.py
index 37616fb..fa02eda 100755
--- a/Lib/pydoc.py
+++ b/Lib/pydoc.py
@@ -137,7 +137,10 @@
return _re_stripid.sub(r'\1', text)
def _is_some_method(obj):
- return inspect.ismethod(obj) or inspect.ismethoddescriptor(obj)
+ return (inspect.isfunction(obj) or
+ inspect.ismethod(obj) or
+ inspect.isbuiltin(obj) or
+ inspect.ismethoddescriptor(obj))
def allmethods(cl):
methods = {}
diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py
index c7318ff..42a4089 100644
--- a/Lib/test/test_pydoc.py
+++ b/Lib/test/test_pydoc.py
@@ -389,6 +389,30 @@
synopsis = pydoc.synopsis(TESTFN, {})
self.assertEqual(synopsis, 'line 1: h\xe9')
+ def test_allmethods(self):
+ # issue 17476: allmethods was no longer returning unbound methods.
+ # This test is a bit fragile in the face of changes to object and type,
+ # but I can't think of a better way to do it without duplicating the
+ # logic of the function under test.
+
+ class TestClass(object):
+ def method_returning_true(self):
+ return True
+
+ # What we expect to get back: everything on object...
+ expected = dict(vars(object))
+ # ...plus our unbound method...
+ expected['method_returning_true'] = TestClass.method_returning_true
+ # ...but not the non-methods on object.
+ del expected['__doc__']
+ del expected['__class__']
+ # inspect resolves descriptors on type into methods, but vars doesn't,
+ # so we need to update __subclasshook__.
+ expected['__subclasshook__'] = TestClass.__subclasshook__
+
+ methods = pydoc.allmethods(TestClass)
+ self.assertDictEqual(methods, expected)
+
class PydocImportTest(unittest.TestCase):
diff --git a/Misc/NEWS b/Misc/NEWS
index af22318..5e36c42 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -233,6 +233,9 @@
Library
-------
+- Issue #17476: Fixed regression relative to Python2 in undocumented pydoc
+ 'allmethods'; it was missing unbound methods on the class.
+
- Issue #16389: Fixed a performance regression relative to Python 3.1 in the
caching of compiled regular expressions.