Read plugins.jedi.extra_paths configuration also from files

Before this commit, plugins.jedi.extra_paths can be configured only
via Language Server Protocol didChangeConfiguration method.

This is inconvenient, if:

  - it is difficult to issue LSP didChangeConfiguration method with
    per-workspace configuration

  - such configuration should be persisted inside workspace

This commit reads plugins.jedi.extra_paths configuration also from
project-level configuration "setup.cfg" and "tox.ini".

Author: flying-foozy

pyls/config/pyls_conf.py

@@ -10,11 +10,15 @@
 
 OPTIONS = [
     ('source_roots', 'source_roots', list),
+
+    # inter-plugins configurations
+    ('plugins.jedi.extra_paths', 'plugins.jedi.extra_paths', list),
 ]
 
 # list of (config_path, inside_only) tuples for path normalization
 NORMALIZED_CONFIGS = [
     ('source_roots', True),
+    ('plugins.jedi.extra_paths', False),
 ]
 
 

test/test_workspace.py

@@ -250,3 +250,62 @@ def test_pyls_config_readin(tmpdir, metafile):
     for raw_path in source_roots:
         full_path = os.path.normcase(os.path.join(root_path, raw_path))
         assert os.path.normpath(full_path) in sys_path
+
+
+@pytest.mark.parametrize('metafile', [
+    'setup.cfg',
+    'tox.ini',
+    'service/foo/setup.cfg',
+    'service/foo/tox.ini',
+    None,
+])
+def test_jedi_extra_paths_config(tmpdir, metafile):
+    """Examine that plugins.jedi.extra_paths config is intentionaly read in.
+
+    This test also examines below for entries in plugins.jedi.extra_paths:
+
+    * relative path is:
+      - treated as relative to config file location, and
+      - normalized into absolute one
+    """
+    root_path = str(tmpdir)
+
+    extra_paths = ['extra/foo', 'extra/bar', '/absolute/root', '../baz']
+    doc_root = 'service/foo'
+
+    if metafile:
+        dirname = os.path.dirname(metafile)
+        if dirname:
+            os.makedirs(os.path.join(root_path, dirname))
+
+        # configured by metafile at pyls startup
+        with open(os.path.join(root_path, metafile), 'w+') as f:
+            f.write('[pyls]\nplugins.jedi.extra_paths=\n    %s\n' %
+                    ',\n    '.join(_make_paths_dir_relative(extra_paths, dirname)))
+
+    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': {'plugins': {'jedi': {'extra_paths': extra_paths}}},
+        })
+
+    # put new document under ROOT/service/foo
+    test_uri = uris.from_fs_path(os.path.join(root_path, doc_root, '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 extra_paths:
+        full_path = os.path.normcase(os.path.join(root_path, raw_path))
+        assert os.path.normpath(full_path) in sys_path