Editor's rope-based introspection features (code completion, calltips…

…, go to definition): new rope monkey-patch providing major performance improvements

rope_profiling/test.py

@@ -64,6 +64,10 @@ def get_calltip_from_pyobject(pyobject,
 def get_doc_from_pyobject(pyobject):
     return pydocextractor.get_doc(pyobject)
 
+
+from spyderlib import rope_patch
+rope_patch.apply()
+
 def other_features():
     project = rope.base.project.Project('src', **ROPE_PREFS)
     project.validate(project.root)

spyderlib/rope_patch.py

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright © 2011 Pierre Raybaut
+# Licensed under the terms of the MIT License
+# (see spyderlib/__init__.py for details)
+
+"""
+Patching rope for better performances
+See this thread:
+http://groups.google.com/group/rope-dev/browse_thread/thread/57de5731f202537a
+"""
+
+def apply():
+    """Monkey patching rope for better performances"""
+    import rope
+    if rope.VERSION not in ('0.9.3', '0.9.2'):
+        raise ImportError, "rope %s can't be patched" % rope.VERSION
+
+    # Patching pycore.PyCore, so that forced builtin modules (i.e. modules 
+    # that were declared as 'extension_modules' in rope preferences)
+    # will be indeed recognized as builtins by rope, as expected
+    from rope.base import pycore
+    class PatchedPyCore(pycore.PyCore):
+        def get_module(self, name, folder=None):
+            """Returns a `PyObject` if the module was found."""
+            # check if this is a builtin module
+            pymod = self._builtin_module(name)
+            if pymod is not None:
+                return pymod
+            module = self.find_module(name, folder)
+            if module is None:
+                raise pycore.ModuleNotFoundError(
+                                            'Module %s not found' % name)
+            return self.resource_to_pyobject(module)
+    pycore.PyCore = PatchedPyCore
+
+    # Patching BuiltinFunction for the calltip/doc functions to be 
+    # able to retrieve the function signatures with forced builtins
+    from rope.base import builtins, pyobjects
+    from spyderlib.utils.dochelpers import getargs
+    class PatchedBuiltinFunction(builtins.BuiltinFunction):
+        def __init__(self, returned=None, function=None, builtin=None,
+                     argnames=[], parent=None):
+            builtins._BuiltinElement.__init__(self, builtin, parent)
+            pyobjects.AbstractFunction.__init__(self)
+            self.argnames = argnames
+            if not argnames and builtin:
+                self.argnames = getargs(self.builtin)
+            if self.argnames is None:
+                self.argnames = []
+            self.returned = returned
+            self.function = function
+    builtins.BuiltinFunction = PatchedBuiltinFunction
+
+    # Patching BuiltinName for the go to definition feature to simply work 
+    # with forced builtins
+    from rope.base import libutils
+    import inspect
+    class PatchedBuiltinName(builtins.BuiltinName):
+        def _pycore(self):
+            p = self.pyobject
+            while p.parent is not None:
+                p = p.parent
+            if isinstance(p, builtins.BuiltinModule) and p.pycore is not None:
+                return p.pycore
+        def get_definition_location(self):
+            if not inspect.isbuiltin(self.pyobject):
+                _lines, lineno = inspect.getsourcelines(self.pyobject.builtin)
+                path = inspect.getfile(self.pyobject.builtin)
+                pycore = self._pycore()
+                if pycore and pycore.project:
+                    resource = libutils.path_to_resource(pycore.project, path)
+                    module = pyobjects.PyModule(pycore, None, resource)
+                    return (module, lineno)
+            return (None, None)
+    builtins.BuiltinName = PatchedBuiltinName

spyderlib/spyder.py

@@ -1368,6 +1368,14 @@ def exec_():
     from spyderlib.qt import QtGui
     QtGui.QApplication = FakeQApplication
 
+    #----Monkey patching rope
+    try:
+        from spyderlib import rope_patch
+        rope_patch.apply()
+    except ImportError:
+        # rope 0.9.2/0.9.3 is not installed
+        pass
+
     #----Monkey patching sys.exit
     def fake_sys_exit(arg=[]):
         pass

spyderlib/widgets/projectexplorer.py

@@ -39,23 +39,6 @@
 try:
     import rope.base.libutils
     import rope.contrib.codeassist
-    pydocextractor = rope.contrib.codeassist.PyDocExtractor()
-
-    def get_pyobject(project, source_code, offset, resource=None, maxfixes=1):
-        fixer = rope.contrib.codeassist.fixsyntax.FixSyntax(project.pycore,
-                                            source_code, resource, maxfixes)
-        pyname = fixer.pyname_at(offset)
-        if pyname is None:
-            return None
-        return pyname.get_object()
-
-    def get_calltip_from_pyobject(pyobject,
-                                  ignore_unknown=False, remove_self=False):
-        return pydocextractor.get_calltip(pyobject, ignore_unknown, remove_self)
-
-    def get_doc_from_pyobject(pyobject):
-        return pydocextractor.get_doc(pyobject)
-
 except ImportError:
     pass
 
@@ -270,17 +253,16 @@ def get_calltip_text(self, source_code, offset, filename):
         try:
             if DEBUG:
                 t0 = time.time()
-            pyobject = get_pyobject(self.rope_project, source_code, offset,
-                                    resource)
-            cts = get_calltip_from_pyobject(pyobject, ignore_unknown=True,
-                                            remove_self=True)
+            cts = rope.contrib.codeassist.get_calltip(
+                            self.rope_project, source_code, offset, resource)
             if DEBUG:
                 log_dt(LOG_FILENAME, "get_calltip", t0)
             if cts is not None:
                 while '..' in cts:
                     cts = cts.replace('..', '.')
                 try:
-                    doc_text = get_doc_from_pyobject(pyobject)
+                    doc_text = rope.contrib.codeassist.get_doc(
+                            self.rope_project, source_code, offset, resource)
                     if DEBUG:
                         log_dt(LOG_FILENAME, "get_doc", t0)
                 except Exception, _error: