Introduce pyls.sourceRoots configuration

Before this commit, in order to specify source root(s) other than the
workspace root, 'setup.py' or 'pyproject.toml' should be created, even
if such file is not actually needed.

In order to explicitly specify source root(s) in the workspace, this
commit introduces pyls.sourceRoots configuration, and makes
Workspace.source_roots() return its value if configured.

Path in pyls.sourceRoots is ignored, if it refers outside of the
workspace.

This configuration is also useful in the case that the workspace
consists of multiple (independent) services and a library shared by
them, for example. In such case, N + 1 source roots are listed in
pyls.sourceRoots configuration.

Author: flying-foozy

pyls/config/pyls_conf.py

@@ -8,6 +8,7 @@
 PROJECT_CONFIGS = ['setup.cfg', 'tox.ini']
 
 OPTIONS = [
+    ('source-roots', 'sourceRoots', list),
 ]
 
 

pyls/workspace.py

@@ -95,8 +95,38 @@ def publish_diagnostics(self, doc_uri, diagnostics):
     def show_message(self, message, msg_type=lsp.MessageType.Info):
         self._endpoint.notify(self.M_SHOW_MESSAGE, params={'type': msg_type, 'message': message})
 
+    def normalize_config_paths(self, config_key, inside_only=True):
+        """Return normalized paths specified in pyls configuration"""
+        raw_paths = self._config and self._config.settings().get(config_key)
+        if not raw_paths:
+            return []
+
+        inside_prefix = self._root_path + os.path.sep
+        paths = []
+
+        for raw_path in raw_paths:
+            full_path = os.path.normpath(os.path.join(self._root_path, raw_path))
+            if (not inside_only or
+                    # in "inside_only=True" case, path must (1) not be
+                    # absolute (= be relative to root of workspace),
+                    # (2) not have drive letter (on Windows), and (3)
+                    # be inside workspace
+                    (not os.path.isabs(raw_path) and
+                     not os.path.splitdrive(raw_path)[0] and
+                     full_path.startswith(inside_prefix))):
+                paths.append(full_path)
+            else:
+                log.warning("Ignoring path '%s' in pyls.%s", raw_path, config_key)
+
+        return paths
+
     def source_roots(self, document_path):
         """Return the source roots for the given document."""
+        source_roots = self.normalize_config_paths('sourceRoots')
+        if source_roots:
+            # Use specified sourceRoots without traversing upper directories
+            return source_roots
+
         files = _utils.find_parents(self._root_path, document_path, ['setup.py', 'pyproject.toml']) or []
         return list(set((os.path.dirname(project_file) for project_file in files))) or [self._root_path]
 

test/test_workspace.py

@@ -5,13 +5,16 @@
 import pytest
 
 from pyls import uris
+from pyls.python_ls import PythonLanguageServer
 
 PY2 = sys.version_info.major == 2
 
 if PY2:
     import pathlib2 as pathlib
+    from StringIO import StringIO
 else:
     import pathlib
+    from io import StringIO
 
 
 DOC_URI = uris.from_fs_path(__file__)
@@ -119,3 +122,50 @@ def test_multiple_workspaces(tmpdir, pyls):
     pyls.m_workspace__did_change_workspace_folders(
         added=[], removed=[added_workspaces[0]])
     assert workspace1_uri not in pyls.workspaces
+
+
+@pytest.mark.parametrize('metafile', ['setup.cfg', 'tox.ini', None])
+def test_source_roots_config(tmpdir, metafile):
+    root_path = str(tmpdir)
+
+    invalid_roots = ['/invalid/root', '../baz']
+    source_roots = ['service/foo', 'service/bar'] + invalid_roots
+
+    if metafile:
+        # configured by metafile at pyls startup
+        with open(os.path.join(root_path, metafile), 'w+') as f:
+            f.write('[pyls]\nsource-roots=\n    %s\n' %
+                    ',\n    '.join(source_roots))
+
+    pyls = PythonLanguageServer(StringIO, StringIO)
+    pyls.m_initialize(
+        processId=1,
+        rootUri=uris.from_fs_path(root_path),
+        initializationOptions={}
+    )
+
+    if not metafile:
+        # configured by client via LSP after pyls startup
+        pyls.m_workspace__did_change_configuration({
+            'pyls': {'sourceRoots': source_roots},
+        })
+
+    # put new document under ROOT/service/foo
+    prefix = os.path.join(root_path, source_roots[0])
+    test_uri = uris.from_fs_path(os.path.join(prefix, 'hello/test.py'))
+    pyls.workspace.put_document(test_uri, 'assert True')
+    test_doc = pyls.workspace.get_document(test_uri)
+
+    # apply os.path.normcase() on paths below, because case-sensitive
+    # comparison on Windows causes unintentional failure for case
+    # instability around drive letter
+
+    sys_path = [os.path.normcase(p) for p in test_doc.sys_path()]
+    for raw_path in source_roots:
+        full_path = os.path.normcase(os.path.join(root_path, raw_path))
+        norm_path = os.path.normpath(full_path)
+        if raw_path in invalid_roots:
+            assert norm_path not in sys_path
+            assert full_path not in sys_path  # check for safety
+        else:
+            assert norm_path in sys_path

vscode-client/package.json

@@ -35,6 +35,15 @@
                     },
                     "uniqueItems": true
                 },
+                "pyls.sourceRoots": {
+                    "type": "array",
+                    "default": [],
+                    "description": "List of source roots in the working space.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "uniqueItems": true
+                },
                 "pyls.plugins.jedi.extra_paths": {
                     "type": "array",
                     "default": [],