220 lines
7.6 KiB
Python
220 lines
7.6 KiB
Python
"""CallTips.py - An IDLE Extension to Jog Your Memory
|
|
|
|
Call Tips are floating windows which display function, class, and method
|
|
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
|
|
|
|
|
|
class CallTips:
|
|
|
|
menudefs = [
|
|
('edit', [
|
|
("Show call tip", "<<force-open-calltip>>"),
|
|
])
|
|
]
|
|
|
|
def __init__(self, editwin=None):
|
|
if editwin is None: # subprocess and test
|
|
self.editwin = None
|
|
return
|
|
self.editwin = editwin
|
|
self.text = editwin.text
|
|
self.calltip = None
|
|
self._make_calltip_window = self._make_tk_calltip_window
|
|
|
|
def close(self):
|
|
self._make_calltip_window = None
|
|
|
|
def _make_tk_calltip_window(self):
|
|
# See __init__ for usage
|
|
return CallTipWindow.CallTip(self.text)
|
|
|
|
def _remove_calltip_window(self, event=None):
|
|
if self.calltip:
|
|
self.calltip.hidetip()
|
|
self.calltip = None
|
|
|
|
def force_open_calltip_event(self, event):
|
|
"""Happens when the user really wants to open a CallTip, even if a
|
|
function call is needed.
|
|
"""
|
|
self.open_calltip(True)
|
|
|
|
def try_open_calltip_event(self, event):
|
|
"""Happens when it would be nice to open a CallTip, but not really
|
|
necessary, for example after an opening bracket, so function calls
|
|
won't be made.
|
|
"""
|
|
self.open_calltip(False)
|
|
|
|
def refresh_calltip_event(self, event):
|
|
"""If there is already a calltip window, check if it is still needed,
|
|
and if so, reload it.
|
|
"""
|
|
if self.calltip and self.calltip.is_active():
|
|
self.open_calltip(False)
|
|
|
|
def open_calltip(self, evalfuncs):
|
|
self._remove_calltip_window()
|
|
|
|
hp = HyperParser(self.editwin, "insert")
|
|
sur_paren = hp.get_surrounding_brackets('(')
|
|
if not sur_paren:
|
|
return
|
|
hp.set_index(sur_paren[0])
|
|
expression = hp.get_expression()
|
|
if not expression or (not evalfuncs and expression.find('(') != -1):
|
|
return
|
|
arg_text = self.fetch_tip(expression)
|
|
if not arg_text:
|
|
return
|
|
self.calltip = self._make_calltip_window()
|
|
self.calltip.showtip(arg_text, sur_paren[0], sur_paren[1])
|
|
|
|
def fetch_tip(self, expression):
|
|
"""Return the argument list and docstring of a function or class
|
|
|
|
If there is a Python subprocess, get the calltip there. Otherwise,
|
|
either fetch_tip() is running in the subprocess itself or it was called
|
|
in an IDLE EditorWindow before any script had been run.
|
|
|
|
The subprocess environment is that of the most recently run script. If
|
|
two unrelated modules are being edited some calltips in the current
|
|
module may be inoperative if the module was not the last to run.
|
|
|
|
To find methods, fetch_tip must be fed a fully qualified name.
|
|
|
|
"""
|
|
try:
|
|
rpcclt = self.editwin.flist.pyshell.interp.rpcclt
|
|
except AttributeError:
|
|
rpcclt = None
|
|
if rpcclt:
|
|
return rpcclt.remotecall("exec", "get_the_calltip",
|
|
(expression,), {})
|
|
else:
|
|
entity = self.get_entity(expression)
|
|
return get_arg_text(entity)
|
|
|
|
def get_entity(self, expression):
|
|
"""Return the object corresponding to expression evaluated
|
|
in a namespace spanning sys.modules and __main.dict__.
|
|
"""
|
|
if expression:
|
|
namespace = sys.modules.copy()
|
|
namespace.update(__main__.__dict__)
|
|
try:
|
|
return eval(expression, namespace)
|
|
except BaseException:
|
|
# An uncaught exception closes idle, and eval can raise any
|
|
# exception, especially if user classes are involved.
|
|
return None
|
|
|
|
def _find_constructor(class_ob):
|
|
# Given a class object, return a function object used for the
|
|
# constructor (ie, __init__() ) or None if we can't find one.
|
|
try:
|
|
return class_ob.__init__.im_func
|
|
except AttributeError:
|
|
for base in class_ob.__bases__:
|
|
rc = _find_constructor(base)
|
|
if rc is not None: return rc
|
|
return None
|
|
|
|
# The following are used in get_arg_text
|
|
_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 ''.
|
|
|
|
For Python-coded functions and methods, the first line is introspected.
|
|
Delete 'self' parameter for classes (.__init__) and bound methods.
|
|
The next lines are the first lines of the doc string up to the first
|
|
empty line or _MAX_LINES. For builtins, this typically includes
|
|
the arguments in addition to the return value.
|
|
'''
|
|
argspec = ""
|
|
try:
|
|
ob_call = ob.__call__
|
|
except BaseException:
|
|
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 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
|
|
else:
|
|
arg_offset = 1
|
|
elif type(ob) == types.MethodType:
|
|
# bit of a hack for methods - turn it into a function
|
|
# and drop the "self" param for bound methods
|
|
fob = ob.im_func
|
|
if ob.im_self is not None:
|
|
arg_offset = 1
|
|
elif type(ob_call) == types.MethodType:
|
|
# a callable class instance
|
|
fob = ob_call.im_func
|
|
arg_offset = 1
|
|
else:
|
|
fob = ob
|
|
# Try to build one for Python defined functions
|
|
if type(fob) in [types.FunctionType, types.LambdaType]:
|
|
argcount = fob.func_code.co_argcount
|
|
real_args = fob.func_code.co_varnames[arg_offset:argcount]
|
|
defaults = fob.func_defaults or []
|
|
defaults = list(map(lambda name: "=%s" % repr(name), defaults))
|
|
defaults = [""] * (len(real_args) - len(defaults)) + defaults
|
|
items = map(lambda arg, dflt: arg + dflt, real_args, defaults)
|
|
for flag, pre, name in ((0x4, '*', 'args'), (0x8, '**', 'kwargs')):
|
|
if fob.func_code.co_flags & flag:
|
|
pre_name = pre + name
|
|
if name not in real_args:
|
|
items.append(pre_name)
|
|
else:
|
|
i = 1
|
|
while ((name+'%s') % i) in real_args:
|
|
i += 1
|
|
items.append((pre_name+'%s') % i)
|
|
argspec = ", ".join(items)
|
|
argspec = "(%s)" % re.sub("(?<!\d)\.\d+", "<tuple>", argspec)
|
|
|
|
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:
|
|
for line in doc.split('\n', _MAX_LINES)[:_MAX_LINES]:
|
|
line = line.strip()
|
|
if not line:
|
|
break
|
|
if len(line) > _MAX_COLS:
|
|
line = line[: _MAX_COLS - 3] + '...'
|
|
lines.append(line)
|
|
argspec = '\n'.join(lines)
|
|
return argspec
|
|
|
|
if __name__ == '__main__':
|
|
from unittest import main
|
|
main('idlelib.idle_test.test_calltips', verbosity=2)
|