From e7a72a194d769a6a92a3ea4d70e7429df646452f Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Sun, 26 Jan 2014 19:55:07 -0500 Subject: Issue #20338: Increase allowed tip width slightly and wrap long signagure lines. Original patch by Serhiy Storchaka. --- Lib/idlelib/CallTips.py | 22 +++++++++++++++------- Lib/idlelib/idle_test/test_calltips.py | 13 +++++++++++++ 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/Lib/idlelib/CallTips.py b/Lib/idlelib/CallTips.py index 7197cf5..5b4a04b 100644 --- a/Lib/idlelib/CallTips.py +++ b/Lib/idlelib/CallTips.py @@ -5,14 +5,15 @@ parameter and docstring information when you type an opening parenthesis, and which disappear when you type a closing parenthesis. """ +import __main__ import re import sys +import textwrap import types from idlelib import CallTipWindow from idlelib.HyperParser import HyperParser -import __main__ class CallTips: @@ -131,8 +132,9 @@ def _find_constructor(class_ob): return None # The following are used in get_arg_text -_MAX_COLS = 79 +_MAX_COLS = 85 _MAX_LINES = 5 # enough for bytes +_INDENT = ' '*4 # for wrapped signatures def get_arg_text(ob): '''Return a string describing the signature of a callable object, or ''. @@ -147,11 +149,15 @@ def get_arg_text(ob): try: ob_call = ob.__call__ except BaseException: - return argspec + if type(ob) is types.ClassType: # old-style + ob_call = ob + else: + return argspec arg_offset = 0 if type(ob) in (types.ClassType, types.TypeType): - # Look for the highest __init__ in the class chain. + # Look for the first __init__ in the class chain with .im_func. + # Slot wrappers (builtins, classes defined in funcs) do not. fob = _find_constructor(ob) if fob is None: fob = lambda: None @@ -183,14 +189,16 @@ def get_arg_text(ob): items.append("**kwds") argspec = ", ".join(items) argspec = "(%s)" % re.sub("(?", argspec) - # See if we can use the docstring + + lines = (textwrap.wrap(argspec, _MAX_COLS, subsequent_indent=_INDENT) + if len(argspec) > _MAX_COLS else [argspec] if argspec else []) + if isinstance(ob_call, types.MethodType): doc = ob_call.__doc__ else: doc = getattr(ob, "__doc__", "") if doc: - lines = [argspec] if argspec else [] - for line in doc.split('\n', 5)[:_MAX_LINES]: + for line in doc.split('\n', _MAX_LINES)[:_MAX_LINES]: line = line.strip() if not line: break diff --git a/Lib/idlelib/idle_test/test_calltips.py b/Lib/idlelib/idle_test/test_calltips.py index 338f2c6..9ee3042 100644 --- a/Lib/idlelib/idle_test/test_calltips.py +++ b/Lib/idlelib/idle_test/test_calltips.py @@ -1,6 +1,7 @@ import unittest import idlelib.CallTips as ct CTi = ct.CallTips() # needed for get_entity test in 2.7 +import textwrap import types default_tip = '' @@ -66,6 +67,18 @@ class Get_signatureTest(unittest.TestCase): gtest(types.MethodType, '()\ninstancemethod(function, instance, class)') gtest(SB(), default_tip) + def test_signature_wrap(self): + # This is also a test of an old-style class + self.assertEqual(signature(textwrap.TextWrapper), '''\ +(width=70, initial_indent='', subsequent_indent='', expand_tabs=True, + replace_whitespace=True, fix_sentence_endings=False, break_long_words=True, + drop_whitespace=True, break_on_hyphens=True)''') + + def test_docline_truncation(self): + def f(): pass + f.__doc__ = 'a'*300 + self.assertEqual(signature(f), '()\n' + 'a' * (ct._MAX_COLS-3) + '...') + def test_multiline_docstring(self): # Test fewer lines than max. self.assertEqual(signature(list), -- cgit v0.12