def get_info(self, info):
"""Get a formatted calltip and docstring from Rope"""
if self.project is None:
return default_info_response()
filename = info['filename']
source_code = info['source_code']
offset = info['position']
# Set python path into rope project
self.project.prefs.set('python_path', info['sys_path'])
if filename is not None:
if PY2:
filename = filename.encode('utf-8')
else:
# TODO: test if this is working without any further change in
# Python 3 with a user account containing unicode characters
pass
try:
resource = rope.base.libutils.path_to_resource(
self.project, filename)
except Exception as _error:
if DEBUG_EDITOR:
log_last_error(LOG_FILENAME, "path_to_resource: %r" % filename)
resource = None
try:
if DEBUG_EDITOR:
t0 = time.time()
cts = rope.contrib.codeassist.get_calltip(self.project,
source_code,
offset,
resource,
ignore_unknown=False,
remove_self=True,
maxfixes=3)
if DEBUG_EDITOR:
log_dt(LOG_FILENAME, "get_calltip", t0)
if cts is not None:
while '..' in cts:
cts = cts.replace('..', '.')
if '(.)' in cts:
cts = cts.replace('(.)', '(...)')
try:
doc_text = rope.contrib.codeassist.get_doc(self.project,
source_code,
offset,
resource,
maxfixes=3)
if DEBUG_EDITOR:
log_dt(LOG_FILENAME, "get_doc", t0)
except Exception as _error:
doc_text = ''
if DEBUG_EDITOR:
log_last_error(LOG_FILENAME, "get_doc")
return self.handle_info(cts, doc_text, source_code, offset)
except Exception as _error: #analysis:ignore
if DEBUG_EDITOR:
log_last_error(LOG_FILENAME, "get_calltip_text")
def test_no_docs_message(help_plugin, qtbot):
"""
Test that no docs message is shown when instrospection plugins
can't get any info.
"""
help_plugin.render_sphinx_doc(default_info_response())
qtbot.waitUntil(lambda: check_text(help_plugin._webpage,
"No documentation available"),
timeout=4000)
def test_no_docs_message(help_plugin, qtbot):
"""
Test that no docs message is shown when instrospection plugins
can't get any info.
"""
help_plugin.render_sphinx_doc(default_info_response())
qtbot.waitUntil(
lambda: check_text(help_plugin._webpage, "No documentation available"),
timeout=4000)
def test_no_further_docs_message(help_plugin, qtbot):
"""
Test that no further docs message is shown when instrospection
plugins can get partial info.
"""
info = default_info_response()
info['name'] = 'foo'
info['argspec'] = '(x, y)'
help_plugin.render_sphinx_doc(info)
qtbot.waitUntil(lambda: check_text(help_plugin._webpage,
"No further documentation available"),
timeout=3000)
def test_no_further_docs_message(help_plugin, qtbot):
"""
Test that no further docs message is shown when instrospection
plugins can get partial info.
"""
info = default_info_response()
info['name'] = 'foo'
info['argspec'] = '(x, y)'
help_plugin.render_sphinx_doc(info)
qtbot.waitUntil(lambda: check_text(help_plugin._webpage,
"No further documentation available"),
timeout=3000)
def get_info(self, info):
"""Get a formatted calltip and docstring from Rope"""
if self.project is None:
return default_info_response()
filename = info['filename']
source_code = info['source_code']
offset = info['position']
# Set python path into rope project
self.project.prefs.set('python_path', info['sys_path'])
if filename is not None:
if PY2:
filename = filename.encode('utf-8')
else:
# TODO: test if this is working without any further change in
# Python 3 with a user account containing unicode characters
pass
try:
resource = rope.base.libutils.path_to_resource(self.project,
filename)
except Exception as _error:
if DEBUG_EDITOR:
log_last_error(LOG_FILENAME, "path_to_resource: %r" % filename)
resource = None
try:
if DEBUG_EDITOR:
t0 = time.time()
cts = rope.contrib.codeassist.get_calltip(
self.project, source_code, offset, resource,
ignore_unknown=False, remove_self=True, maxfixes=3)
if DEBUG_EDITOR:
log_dt(LOG_FILENAME, "get_calltip", t0)
if cts is not None:
while '..' in cts:
cts = cts.replace('..', '.')
if '(.)' in cts:
cts = cts.replace('(.)', '(...)')
try:
doc_text = rope.contrib.codeassist.get_doc(self.project,
source_code, offset, resource, maxfixes=3)
if DEBUG_EDITOR:
log_dt(LOG_FILENAME, "get_doc", t0)
except Exception as _error:
doc_text = ''
if DEBUG_EDITOR:
log_last_error(LOG_FILENAME, "get_doc")
return self.handle_info(cts, doc_text, source_code, offset)
except Exception as _error: #analysis:ignore
if DEBUG_EDITOR:
log_last_error(LOG_FILENAME, "get_calltip_text")
def get_info(self, info):
"""Get a formatted calltip and docstring from Fallback"""
if info['docstring']:
if info['filename']:
filename = os.path.basename(info['filename'])
filename = os.path.splitext(filename)[0]
else:
filename = '<module>'
resp = dict(docstring=info['docstring'],
name=filename,
note='',
argspec='',
calltip=None)
return resp
else:
return default_info_response()
def get_info(self, info):
"""Get a formatted calltip and docstring from Fallback"""
if info['docstring']:
if info['filename']:
filename = os.path.basename(info['filename'])
filename = os.path.splitext(filename)[0]
else:
filename = '<module>'
resp = dict(docstring=info['docstring'],
name=filename,
note='',
argspec='',
calltip=None)
return resp
else:
return default_info_response()
def handle_info(self, cts, doc_text, source_code, offset):
obj_fullname = ''
calltip = ''
argspec = ''
note = ''
if cts:
cts = cts.replace('.__init__', '')
parpos = cts.find('(')
if parpos:
obj_fullname = cts[:parpos]
obj_name = obj_fullname.split('.')[-1]
cts = cts.replace(obj_fullname, obj_name)
calltip = cts
if ('()' in cts) or ('(...)' in cts):
# Either inspected object has no argument, or it's
# a builtin or an extension -- in this last case
# the following attempt may succeed:
calltip = getsignaturefromtext(doc_text, obj_name)
if not obj_fullname:
obj_fullname = sourcecode.get_primary_at(source_code, offset)
if obj_fullname and not obj_fullname.startswith('self.'):
# doc_text was generated by utils.dochelpers.getdoc
if type(doc_text) is dict:
obj_fullname = doc_text['name'] or obj_fullname
argspec = doc_text['argspec']
note = doc_text['note']
doc_text = doc_text['docstring']
elif calltip:
argspec_st = calltip.find('(')
argspec = calltip[argspec_st:]
module_end = obj_fullname.rfind('.')
module = obj_fullname[:module_end]
note = 'Present in %s module' % module
if not doc_text and not calltip:
return default_info_response()
return dict(name=obj_fullname,
argspec=argspec,
note=note,
docstring=doc_text,
calltip=calltip)
def handle_info(self, cts, doc_text, source_code, offset):
obj_fullname = ''
calltip = ''
argspec = ''
note = ''
if cts:
cts = cts.replace('.__init__', '')
parpos = cts.find('(')
if parpos:
obj_fullname = cts[:parpos]
obj_name = obj_fullname.split('.')[-1]
cts = cts.replace(obj_fullname, obj_name)
calltip = cts
if ('()' in cts) or ('(...)' in cts):
# Either inspected object has no argument, or it's
# a builtin or an extension -- in this last case
# the following attempt may succeed:
calltip = getsignaturefromtext(doc_text, obj_name)
if not obj_fullname:
obj_fullname = sourcecode.get_primary_at(source_code, offset)
if obj_fullname and not obj_fullname.startswith('self.'):
# doc_text was generated by utils.dochelpers.getdoc
if type(doc_text) is dict:
obj_fullname = doc_text['name'] or obj_fullname
argspec = doc_text['argspec']
note = doc_text['note']
doc_text = doc_text['docstring']
elif calltip:
argspec_st = calltip.find('(')
argspec = calltip[argspec_st:]
module_end = obj_fullname.rfind('.')
module = obj_fullname[:module_end]
note = 'Present in %s module' % module
if not doc_text and not calltip:
return default_info_response()
return dict(name=obj_fullname, argspec=argspec, note=note,
docstring=doc_text, calltip=calltip)
def get_info(self, info):
"""
Find the calltip and docs
Returns a dict like the following:
{'note': 'Function of numpy.core.numeric...',
'argspec': "(shape, dtype=None, order='C')'
'docstring': 'Return an array of given...'
'name': 'ones',
'calltip': 'ones(shape, dtype=None, order='C')'}
"""
call_def = self.get_jedi_object('goto_definitions', info)
for cd in call_def:
docstring = cd.docstring()
if docstring and not docstring.rstrip().endswith(')'):
call_def = cd
break
else:
try:
call_def = call_def[0]
docstring = call_def.docstring()
except IndexError:
return default_info_response()
name = call_def.name
if name is None:
return default_info_response()
if call_def.module_path:
mod_name = get_parent_until(call_def.module_path)
else:
mod_name = None
if not mod_name:
mod_name = call_def.module_name
if docstring.startswith(name + '('):
calltip = getsignaturefromtext(docstring, name)
argspec = calltip[calltip.find('('):]
docstring = docstring[docstring.find(')') + 3:]
elif docstring and '(' in docstring.splitlines()[0]:
calltip = docstring.splitlines()[0]
name = docstring.split('(')[0]
docstring = docstring[docstring.find(')') + 3:]
argspec = calltip[calltip.find('('):]
else:
calltip = name + '(...)'
argspec = '()'
if call_def.type == 'module':
note = 'Module %s' % mod_name
argspec = ''
calltip = name
elif call_def.type == 'class':
note = 'Class in %s module' % mod_name
elif docstring.startswith('%s(self' % name):
class_name = call_def.full_name.split('.')[-2]
note = 'Method of %s class in %s module' % (
class_name.capitalize(), mod_name)
else:
note = '%s in %s module' % (call_def.type.capitalize(), mod_name)
argspec = argspec.replace(' = ', '=')
calltip = calltip.replace(' = ', '=')
debug_print(call_def.name)
doc_info = dict(name=name,
argspec=argspec,
note=note,
docstring=docstring,
calltip=calltip)
return doc_info
def get_info(self, info):
"""
Find the calltip and docs
Returns a dict like the following:
{'note': 'Function of numpy.core.numeric...',
'argspec': "(shape, dtype=None, order='C')'
'docstring': 'Return an array of given...'
'name': 'ones',
'calltip': 'ones(shape, dtype=None, order='C')'}
"""
call_def = self.get_jedi_object('goto_definitions', info)
for cd in call_def:
# For compatibility with Jedi 0.11
try:
cd.doc = cd.docstring()
except AttributeError:
pass
if cd.doc and not cd.doc.rstrip().endswith(')'):
call_def = cd
break
else:
try:
call_def = call_def[0]
except IndexError:
return default_info_response()
name = call_def.name
if name is None:
return default_info_response()
if call_def.module_path:
mod_name = get_parent_until(call_def.module_path)
else:
mod_name = None
if not mod_name:
mod_name = call_def.module_name
if call_def.doc.startswith(name + '('):
calltip = getsignaturefromtext(call_def.doc, name)
argspec = calltip[calltip.find('('):]
docstring = call_def.doc[call_def.doc.find(')') + 3:]
elif call_def.doc and '(' in call_def.doc.splitlines()[0]:
calltip = call_def.doc.splitlines()[0]
name = call_def.doc.split('(')[0]
docstring = call_def.doc[call_def.doc.find(')') + 3:]
argspec = calltip[calltip.find('('):]
else:
calltip = name + '(...)'
argspec = '()'
docstring = call_def.doc
if call_def.type == 'module':
note = 'Module %s' % mod_name
argspec = ''
calltip = name
elif call_def.type == 'class':
note = 'Class in %s module' % mod_name
elif call_def.doc.startswith('%s(self' % name):
class_name = call_def.full_name.split('.')[-2]
note = 'Method of %s class in %s module' % (
class_name.capitalize(), mod_name)
else:
note = '%s in %s module' % (call_def.type.capitalize(),
mod_name)
argspec = argspec.replace(' = ', '=')
calltip = calltip.replace(' = ', '=')
debug_print(call_def.name)
doc_info = dict(name=name, argspec=argspec,
note=note, docstring=docstring, calltip=calltip)
return doc_info
