Merge pull request #24 from jpneverwas/overrides

Add option to override command line

Author: Richardk2n

README.rst

@@ -33,6 +33,9 @@ Configuration
 ``strict`` (default is False) refers to the ``strict`` option of ``mypy``.
     This option often is too strict to be useful.
 
+``overrides`` (default is ``[True]``) specifies a list of alternate or supplemental command-line options.
+    This modifies the options passed to ``mypy`` or the mypy-specific ones passed to ``dmypy run``. When present, the special boolean member ``True`` is replaced with the command-line options that would've been passed had ``overrides`` not been specified. Later options take precedence, which allows for replacing or negating individual default options (see ``mypy.main:process_options`` and ``mypy --help | grep inverse``).
+
 Depending on your editor, the configuration (found in a file called pylsp-mypy.cfg in your workspace or a parent directory) should be roughly like this for a standard configuration:
 
 ::
@@ -54,6 +57,16 @@ With ``dmypy`` enabled your config should look like this:
         "strict": False
     }
 
+With ``overrides`` specified (for example to tell mypy to use a different python than the currently active venv), your config could look like this:
+
+::
+
+    {
+        "enabled": True,
+        "overrides": ["--python-executable", "/home/me/bin/python", True]
+    }
+
+
 Developing
 -------------
 

pylsp_mypy/plugin.py

@@ -98,6 +98,18 @@ def parse_line(line: str, document: Optional[Document] = None) -> Optional[Dict[
     return None
 
 
+def apply_overrides(args: List[str], overrides: List[Any]) -> List[str]:
+    """Replace or combine default command-line options with overrides."""
+    overrides_iterator = iter(overrides)
+    if True not in overrides_iterator:
+        return overrides
+    # If True is in the list, the if above leaves the iterator at the element after True,
+    # therefore, the list below only contains the elements after the True
+    rest = list(overrides_iterator)
+    # slice of the True and the rest, add the args, add the rest
+    return overrides[: -(len(rest) + 1)] + args + rest
+
+
 @hookimpl
 def pylsp_lint(
     config: Config, workspace: Workspace, document: Document, is_saved: bool
@@ -189,8 +201,11 @@ def pylsp_lint(
     if settings.get("strict", False):
         args.append("--strict")
 
+    overrides = settings.get("overrides", [True])
+
     if not dmypy:
         args.extend(["--incremental", "--follow-imports", "silent"])
+        args = apply_overrides(args, overrides)
 
         if shutil.which("mypy"):
             # mypy exists on path
@@ -212,10 +227,13 @@ def pylsp_lint(
         # If daemon is hung, kill will reset
         # If daemon is dead/absent, kill will no-op.
         # In either case, reset to fresh state
+
         if shutil.which("dmypy"):
             # dmypy exists on path
             # -> use mypy on path
-            completed_process = subprocess.run(["dmypy", *args], stderr=subprocess.PIPE)
+            completed_process = subprocess.run(
+                ["dmypy", *apply_overrides(args, overrides)], stderr=subprocess.PIPE
+            )
             _err = completed_process.stderr.decode()
             _status = completed_process.returncode
             if _status != 0:
@@ -234,7 +252,7 @@ def pylsp_lint(
                 mypy_api.run_dmypy(["kill"])
 
         # run to use existing daemon or restart if required
-        args = ["run", "--"] + args
+        args = ["run", "--"] + apply_overrides(args, overrides)
 
         if shutil.which("dmypy"):
             # dmypy exists on path

test/test_plugin.py

@@ -5,6 +5,7 @@
 from pylsp import uris
 from unittest.mock import Mock
 from pylsp_mypy import plugin
+import collections
 
 DOC_URI = __file__
 DOC_TYPE_ERR = """{}.append(3)
@@ -16,6 +17,13 @@
 TEST_LINE_WITHOUT_LINE = "test_plugin.py: " 'error: "Request" has no attribute "id"'
 
 
+@pytest.fixture
+def last_diagnostics_monkeypatch(monkeypatch):
+    # gets called before every test altering last_diagnostics in order to reset it
+    monkeypatch.setattr(plugin, "last_diagnostics", collections.defaultdict(list))
+    return monkeypatch
+
+
 @pytest.fixture
 def workspace(tmpdir):
     """Return a workspace."""
@@ -38,7 +46,7 @@ def test_settings():
     assert settings == {"plugins": {"pylsp_mypy": {}}}
 
 
-def test_plugin(workspace):
+def test_plugin(workspace, last_diagnostics_monkeypatch):
     config = FakeConfig()
     doc = Document(DOC_URI, workspace, DOC_TYPE_ERR)
     plugin.pylsp_settings(config)
@@ -85,7 +93,7 @@ def test_parse_line_with_context(monkeypatch, word, bounds, workspace):
     assert diag["range"]["end"] == {"line": 278, "character": bounds[1]}
 
 
-def test_multiple_workspaces(tmpdir):
+def test_multiple_workspaces(tmpdir, last_diagnostics_monkeypatch):
     DOC_SOURCE = """
 def foo():
     return
@@ -120,3 +128,85 @@ def foo():
     doc2 = Document(DOC_URI, ws2, DOC_SOURCE)
     diags = plugin.pylsp_lint(ws2._config, ws2, doc2, is_saved=False)
     assert len(diags) == 0
+
+
+def test_apply_overrides():
+    assert plugin.apply_overrides(["1", "2"], []) == []
+    assert plugin.apply_overrides(["1", "2"], ["a"]) == ["a"]
+    assert plugin.apply_overrides(["1", "2"], ["a", True]) == ["a", "1", "2"]
+    assert plugin.apply_overrides(["1", "2"], [True, "a"]) == ["1", "2", "a"]
+    assert plugin.apply_overrides(["1"], ["a", True, "b"]) == ["a", "1", "b"]
+
+
+def test_option_overrides(tmpdir, last_diagnostics_monkeypatch, workspace):
+    import sys
+    from textwrap import dedent
+    from stat import S_IRWXU
+
+    sentinel = tmpdir / "ran"
+
+    source = dedent(
+        """\
+        #!{}
+        import os, sys, pathlib
+        pathlib.Path({!r}).touch()
+        os.execv({!r}, sys.argv)
+        """
+    ).format(sys.executable, str(sentinel), sys.executable)
+
+    wrapper = tmpdir / "bin/wrapper"
+    wrapper.write(source, ensure=True)
+    wrapper.chmod(S_IRWXU)
+
+    overrides = ["--python-executable", wrapper.strpath, True]
+    last_diagnostics_monkeypatch.setattr(
+        FakeConfig,
+        "plugin_settings",
+        lambda _, p: {"overrides": overrides} if p == "pylsp_mypy" else {},
+    )
+
+    assert not sentinel.exists()
+
+    diags = plugin.pylsp_lint(
+        config=FakeConfig(),
+        workspace=workspace,
+        document=Document(DOC_URI, workspace, DOC_TYPE_ERR),
+        is_saved=False,
+    )
+    assert len(diags) == 1
+    assert sentinel.exists()
+
+
+def test_option_overrides_dmypy(last_diagnostics_monkeypatch, workspace):
+    overrides = ["--python-executable", "/tmp/fake", True]
+    last_diagnostics_monkeypatch.setattr(
+        FakeConfig,
+        "plugin_settings",
+        lambda _, p: {
+            "overrides": overrides,
+            "dmypy": True,
+            "live_mode": False,
+        }
+        if p == "pylsp_mypy"
+        else {},
+    )
+
+    m = Mock(wraps=lambda a, **_: Mock(returncode=0, **{"stdout.decode": lambda: ""}))
+    last_diagnostics_monkeypatch.setattr(plugin.subprocess, "run", m)
+
+    plugin.pylsp_lint(
+        config=FakeConfig(),
+        workspace=workspace,
+        document=Document(DOC_URI, workspace, DOC_TYPE_ERR),
+        is_saved=False,
+    )
+    expected = [
+        "dmypy",
+        "run",
+        "--",
+        "--python-executable",
+        "/tmp/fake",
+        "--show-column-numbers",
+        __file__,
+    ]
+    m.assert_called_with(expected, stderr=-1, stdout=-1)