mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-13 14:25:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 14

gh-107782: Pydoc: fall back to __text_signature__ if inspect.signature() fails (GH-107786)

Browse source 
It allows to show signatures which are not representable in Python,
e.g. for getattr and dict.pop.
This commit is contained in:
Serhiy Storchaka 2023-08-11 20:51:36 +03:00 • committed by GitHub
parent 5f7d4ecf30
commit a39f0a3506
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 94 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

54
Lib/test/test_pydoc.py
View file

@ -1230,6 +1230,60 @@ class TestDescriptions(unittest.TestCase):
self.assertEqual(self._get_summary_line(dict.__class_getitem__),
"__class_getitem__(object, /) method of builtins.type instance")
def test_module_level_callable_unrepresentable_default(self):
self.assertEqual(self._get_summary_line(getattr),
"getattr(object, name, default=<unrepresentable>, /)")
def test_builtin_staticmethod_unrepresentable_default(self):
self.assertEqual(self._get_summary_line(str.maketrans),
"maketrans(x, y=<unrepresentable>, z=<unrepresentable>, /)")
def test_unbound_builtin_method_unrepresentable_default(self):
self.assertEqual(self._get_summary_line(dict.pop),
"pop(self, key, default=<unrepresentable>, /)")
def test_bound_builtin_method_unrepresentable_default(self):
self.assertEqual(self._get_summary_line({}.pop),
"pop(key, default=<unrepresentable>, /) "
"method of builtins.dict instance")
def test_overridden_text_signature(self):
class C:
def meth(*args, **kwargs):
pass
@classmethod
def cmeth(*args, **kwargs):
pass
@staticmethod
def smeth(*args, **kwargs):
pass
for text_signature, unbound, bound in [
("($slf)", "(slf, /)", "()"),
("($slf, /)", "(slf, /)", "()"),
("($slf, /, arg)", "(slf, /, arg)", "(arg)"),
("($slf, /, arg=<x>)", "(slf, /, arg=<x>)", "(arg=<x>)"),
("($slf, arg, /)", "(slf, arg, /)", "(arg, /)"),
("($slf, arg=<x>, /)", "(slf, arg=<x>, /)", "(arg=<x>, /)"),
("(/, slf, arg)", "(/, slf, arg)", "(/, slf, arg)"),
("(/, slf, arg=<x>)", "(/, slf, arg=<x>)", "(/, slf, arg=<x>)"),
("(slf, /, arg)", "(slf, /, arg)", "(arg)"),
("(slf, /, arg=<x>)", "(slf, /, arg=<x>)", "(arg=<x>)"),
("(slf, arg, /)", "(slf, arg, /)", "(arg, /)"),
("(slf, arg=<x>, /)", "(slf, arg=<x>, /)", "(arg=<x>, /)"),
]:
with self.subTest(text_signature):
C.meth.__text_signature__ = text_signature
self.assertEqual(self._get_summary_line(C.meth),
"meth" + unbound)
self.assertEqual(self._get_summary_line(C().meth),
"meth" + bound + " method of test.test_pydoc.C instance")
C.cmeth.__func__.__text_signature__ = text_signature
self.assertEqual(self._get_summary_line(C.cmeth),
"cmeth" + bound + " method of builtins.type instance")
C.smeth.__text_signature__ = text_signature
self.assertEqual(self._get_summary_line(C.smeth),
"smeth" + unbound)
@requires_docstrings
def test_staticmethod(self):
class X: