8000 [3.6] bpo-19903: IDLE: Calltips changed to use inspect.signature (GH-2822) by terryjreedy · Pull Request #3053 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

[3.6] bpo-19903: IDLE: Calltips changed to use inspect.signature (GH-2822) #3053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 10, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions Lib/idlelib/calltips.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ def get_entity(expression):
_INDENT = ' '*4 # for wrapped signatures
_first_param = re.compile(r'(?<=\()\w*\,?\s*')
_default_callable_argspec = "See source or doc"
_invalid_method = "invalid method signature"
_argument_positional = "\n['/' marks preceding arguments as positional-only]\n"


def get_argspec(ob):
Expand All @@ -134,25 +136,30 @@ def get_argspec(ob):
empty line or _MAX_LINES. For builtins, this typically includes
the arguments in addition to the return value.
'''
argspec = ""
argspec = default = ""
try:
ob_call = ob.__call__
except BaseException:
return argspec
if isinstance(ob, type):
fob = ob.__init__
elif isinstance(ob_call, types.MethodType):
fob = ob_call
else:
fob = ob
if isinstance(fob, (types.FunctionType, types.MethodType)):
argspec = inspect.formatargspec(*inspect.getfullargspec(fob))
if (isinstance(ob, (type, types.MethodType)) or
isinstance(ob_call, types.MethodType)):
argspec = _first_param.sub("", argspec)
return default

fob = ob_call if isinstance(ob_call, types.MethodType) else ob

try:
argspec = str(inspect.signature(fob))
except ValueError as err:
msg = str(err)
if msg.startswith(_invalid_method):
return _invalid_method

if '/' in argspec:
"""Using AC's positional argument should add the explain"""
argspec += _argument_positional
if isinstance(fob, type) and argspec == '()':
"""fob with no argument, use default callable argspec"""
argspec = _default_callable_argspec

lines = (textwrap.wrap(argspec, _MAX_COLS, subsequent_indent=_INDENT)
if len(argspec) > _MAX_COLS else [argspec] if argspec else [])
if len(argspec) > _MAX_COLS else [argspec] if argspec else [])

if isinstance(ob_call, types.MethodType):
doc = ob_call.__doc__
Expand All @@ -171,6 +178,7 @@ def get_argspec(ob):
argspec = _default_callable_argspec
return argspec


if __name__ == '__main__':
from unittest import main
main('idlelib.idle_test.test_calltips', verbosity=2)
44 changes: 35 additions & 9 deletions Lib/idlelib/idle_test/test_calltips.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,25 +46,37 @@ def test_builtins(self):

# Python class that inherits builtin methods
class List(list): "List() doc"

# Simulate builtin with no docstring for default tip test
class SB: __call__ = None

def gtest(obj, out):
self.assertEqual(signature(obj), out)

if List.__doc__ is not None:
gtest(List, List.__doc__)
gtest(List, List.__doc__) # This and append_doc changed in 3.7.
gtest(list.__new__,
'Create and return a new object. See help(type) for accurate signature.')
'(*args, **kwargs)\nCreate and return a new object.'
' See help(type) for accurate signature.')
gtest(list.__init__,
'(self, /, *args, **kwargs)' + ct._argument_positional + '\n' +
'Initialize self. See help(type(self)) for accurate signature.')
append_doc = "L.append(object) -> None -- append object to end" #see3.7

append_doc = "L.append(object) -> None -- append object to end"
gtest(list.append, append_doc)
gtest([].append, append_doc)
gtest(List.append, append_doc)

gtest(types.MethodType, "method(function, instance)")
gtest(SB(), default_tip)
import re
p = re.compile('')
gtest(re.sub, '''(pattern, repl, string, count=0, flags=0)\nReturn the string obtained by replacing the leftmost
non-overlapping occurrences of the pattern in string by the
replacement repl. repl can be either a string or a callable;
if a string, backslash escapes in it are processed. If it is
a callable, it's passed the match object and must return''')
gtest(p.sub, '''(repl, string, count=0)\nReturn the string obtained by replacing the leftmost non-overlapping occurrences o...''')

def test_signature_wrap(self):
if textwrap.TextWrapper.__doc__ is not None:
Expand Down Expand Up @@ -132,12 +144,20 @@ def test_starred_parameter(self):
# test that starred first parameter is *not* removed from argspec
class C:
def m1(*args): pass
def m2(**kwds): pass
c = C()
for meth, mtip in ((C.m1, '(*args)'), (c.m1, "(*args)"),
(C.m2, "(**kwds)"), (c.m2, "(**kwds)"),):
for meth, mtip in ((C.m1, '(*args)'), (c.m1, "(*args)"),):
self.assertEqual(signature(meth), mtip)

def test_invalid_method_signature(self):
class C:
def m2(**kwargs): pass
class Test:
def __call__(*, a): pass

mtip = ct._invalid_method
self.assertEqual(signature(C().m2), mtip)
self.assertEqual(signature(Test()), mtip)

def test_non_ascii_name(self):
# test that re works to delete a first parameter name that
# includes non-ascii chars, such as various forms of A.
Expand All @@ -156,17 +176,23 @@ def test_attribute_exception(self):
class NoCall:
def __getattr__(self, name):
raise BaseException
class Call(NoCall):
class CallA(NoCall):
def __call__(oui, a, b, c):
pass
class CallB(NoCall):
def __call__(self, ci):
pass
for meth, mtip in ((NoCall, default_tip), (Call, default_tip),
(NoCall(), ''), (Call(), '(ci)')):

for meth, mtip in ((NoCall, default_tip), (CallA, default_tip),
(NoCall(), ''), (CallA(), '(a, b, c)'),
(CallB(), '(ci)')):
self.assertEqual(signature(meth), mtip)

def test_non_callables(self):
for obj in (0, 0.0, '0', b'0', [], {}):
self.assertEqual(signature(obj), '')


class Get_entityTest(unittest.TestCase):
def test_bad_entity( 82F9 self):
self.assertIsNone(ct.get_entity('1/0'))
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
IDLE: Calltips use `inspect.signature` instead of `inspect.getfullargspec`.
This improves calltips for builtins converted to use Argument Clinic.
Patch by Louie Lu.
0