Lazily construct rope projects and resources (#298)

Author: gatesn

pyls/plugins/rope_completion.py

@@ -15,7 +15,7 @@ def pyls_settings():
 
 
 @hookimpl
-def pyls_completions(document, position):
+def pyls_completions(config, workspace, document, position):
     # Rope is a bit rubbish at completing module imports, so we'll return None
     word = document.word_at_position({
         # The -1 should really be trying to look at the previous word, but that might be quite expensive
@@ -26,9 +26,11 @@ def pyls_completions(document, position):
         return None
 
     offset = document.offset_at_position(position)
-    definitions = code_assist(
-        document._rope_project, document.source,
-        offset, document._rope, maxfixes=3)
+    rope_config = config.settings(document_path=document.path).get('rope', {})
+    rope_project = workspace._rope_project_builder(rope_config)
+    document_rope = document._rope_resource(rope_config)
+
+    definitions = code_assist(rope_project, document.source, offset, document_rope, maxfixes=3)
 
     definitions = sorted_proposals(definitions)
     new_definitions = []
@@ -42,7 +44,8 @@ def pyls_completions(document, position):
             'kind': _kind(d),
             'detail': '{0} {1}'.format(d.scope or "", d.name),
             'documentation': doc or "",
-            'sortText': _sort_text(d)})
+            'sortText': _sort_text(d)
+        })
     definitions = new_definitions
 
     return definitions or None

pyls/plugins/rope_rename.py

@@ -12,10 +12,13 @@
 
 
 @hookimpl
-def pyls_rename(workspace, document, position, new_name):
+def pyls_rename(config, workspace, document, position, new_name):
+    rope_config = config.settings(document_path=document.path).get('rope', {})
+    rope_project = workspace._rope_project_builder(rope_config)
+
     rename = Rename(
-        workspace._rope,
-        libutils.path_to_resource(workspace._rope, document.path),
+        rope_project,
+        libutils.path_to_resource(rope_project, document.path),
         document.offset_at_position(position)
     )
 

pyls/workspace.py

@@ -81,13 +81,16 @@ def __init__(self, root_uri, rpc_manager):
         self._root_path = uris.to_fs_path(self._root_uri)
         self._docs = {}
 
-        # Whilst incubating, keep private
-        self.__rope = Project(self._root_path)
-        self.__rope.prefs.set('extension_modules', self.PRELOADED_MODULES)
+        # Whilst incubating, keep rope private
+        self.__rope = None
+        self.__rope_config = None
 
-    @property
-    def _rope(self):
+    def _rope_project_builder(self, rope_config):
         # TODO: we could keep track of dirty files and validate only those
+        if self.__rope is None or self.__rope_config != rope_config:
+            rope_folder = rope_config.get('ropeFolder')
+            self.__rope = Project(self._root_path, ropefolder=rope_folder)
+            self.__rope.prefs.set('extension_modules', self.PRELOADED_MODULES)
         self.__rope.validate()
         return self.__rope
 
@@ -143,14 +146,15 @@ def source_roots(self, document_path):
     def _create_document(self, doc_uri, source=None, version=None):
         path = uris.to_fs_path(doc_uri)
         return Document(
-            doc_uri, source=source,
-            extra_sys_path=self.source_roots(path), rope=self._rope, version=version
+            doc_uri, source=source, version=version,
+            extra_sys_path=self.source_roots(path),
+            rope_project_builder=self._rope_project_builder,
         )
 
 
 class Document(object):
 
-    def __init__(self, uri, source=None, version=None, local=True, extra_sys_path=None, rope=None):
+    def __init__(self, uri, source=None, version=None, local=True, extra_sys_path=None, rope_project_builder=None):
         self.uri = uri
         self.version = version
         self.path = uris.to_fs_path(uri)
@@ -159,14 +163,13 @@ def __init__(self, uri, source=None, version=None, local=True, extra_sys_path=No
         self._local = local
         self._source = source
         self._extra_sys_path = extra_sys_path or []
-        self._rope_project = rope
+        self._rope_project_builder = rope_project_builder
 
     def __str__(self):
         return str(self.uri)
 
-    @property
-    def _rope(self):
-        return libutils.path_to_resource(self._rope_project, self.path)
+    def _rope_resource(self, rope_config):
+        return libutils.path_to_resource(self._rope_project_builder(rope_config), self.path)
 
     @property
     def lines(self):

test/plugins/test_completion.py

@@ -24,10 +24,10 @@ def _a_hello():
 """
 
 
-def test_rope_import_completion():
+def test_rope_import_completion(config, workspace):
     com_position = {'line': 0, 'character': 7}
     doc = Document(DOC_URI, DOC)
-    items = pyls_rope_completions(doc, com_position)
+    items = pyls_rope_completions(config, workspace, doc, com_position)
     assert items is None
 
 
@@ -44,13 +44,14 @@ def test_jedi_completion():
     pyls_jedi_completions(doc, {'line': 1, 'character': 1000})
 
 
-def test_rope_completion():
+def test_rope_completion(config, workspace):
     # Over 'i' in os.path.isabs(...)
     com_position = {'line': 1, 'character': 15}
     rope = Project(LOCATION)
     rope.prefs.set('extension_modules', get_preferred_submodules())
-    doc = Document(DOC_URI, DOC, rope=rope)
-    items = pyls_rope_completions(doc, com_position)
+    workspace.put_document(DOC_URI, source=DOC)
+    doc = workspace.get_document(DOC_URI)
+    items = pyls_rope_completions(config, workspace, doc, com_position)
 
     assert items
     assert items[0]['label'] == 'isabs'

vscode-client/package.json

@@ -145,6 +145,11 @@
                     "type": "boolean",
                     "default": true,
                     "description": "Enable or disable the plugin."
+                },
+                "pyls.rope.ropeFolder": {
+                    "type": "string",
+                    "default": ".ropeproject",
+                    "description": "The name of the folder in which rope stores project configurations and data.  Pass `null` for not using such a folder at all."
                 }
             }
         }