dmypy status-file closes #47

Author: Richardk2n

README.rst

@@ -36,6 +36,9 @@ Configuration
 ``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``).
 
+``dmypy_status_file`` (Default is ``.dmypy.json``) specifies which status file dmypy should use.
+    This modifies the ``--status-file`` option passed to ``dmypy`` given ``dmypy`` is active.
+
 This project supports the use of ``pyproject.toml`` for configuration. It is in fact the preferred way. Using that your configuration could look like this:
 
 ::
@@ -76,6 +79,17 @@ With ``overrides`` specified (for example to tell mypy to use a different python
         "overrides": ["--python-executable", "/home/me/bin/python", True]
     }
 
+With ``dmypy_status_file`` your config could look like this:
+
+::
+
+    {
+        "enabled": True,
+        "live_mode": False,
+        "dmypy": True,
+        "strict": False,
+        "dmypy_status_file": ".custom_dmypy_status_file.json"
+    }
 
 Developing
 -------------

pylsp_mypy/plugin.py

@@ -44,7 +44,7 @@
 # Windows started opening opening a cmd-like window for every subprocess call
 # This flag prevents that.
 # This flag is new in python 3.7
-# THis flag only exists on Windows
+# This flag only exists on Windows
 windows_flag: Dict[str, int] = (
     {"creationflags": subprocess.CREATE_NO_WINDOW} if os.name == "nt" else {}  # type: ignore
 )
@@ -175,6 +175,9 @@ def pylsp_lint(
         log.warning("live_mode is not supported with dmypy, disabling")
         live_mode = False
 
+    if dmypy:
+        dmypy_status_file = settings.get("dmypy_status_file", ".dmypy.json")
+
     args = ["--show-column-numbers"]
 
     global tmpFile
@@ -237,9 +240,11 @@ def pylsp_lint(
 
         if shutil.which("dmypy"):
             # dmypy exists on path
-            # -> use mypy on path
+            # -> use dmypy on path
             completed_process = subprocess.run(
-                ["dmypy", "status"], stderr=subprocess.PIPE, **windows_flag
+                ["dmypy", "--status-file", dmypy_status_file, "status"],
+                stderr=subprocess.PIPE,
+                **windows_flag,
             )
             errors = completed_process.stderr.decode()
             exit_status = completed_process.returncode
@@ -249,22 +254,25 @@ def pylsp_lint(
                     exit_status,
                     errors.strip(),
                 )
-                subprocess.run(["dmypy", "restart"], **windows_flag)
+                subprocess.run(
+                    ["dmypy", "--status-file", dmypy_status_file, "restart"], **windows_flag
+                )
         else:
             # dmypy does not exist on path, but must exist in the env pylsp-mypy is installed in
             # -> use dmypy via api
-            _, errors, exit_status = mypy_api.run_dmypy(["status"])
+            _, errors, exit_status = mypy_api.run_dmypy(
+                ["--status-file", dmypy_status_file, "status"]
+            )
             if exit_status != 0:
                 log.info(
                     "restarting dmypy from status: %s message: %s via api",
                     exit_status,
                     errors.strip(),
                 )
-                mypy_api.run_dmypy(["restart"])
+                mypy_api.run_dmypy(["--status-file", dmypy_status_file, "restart"])
 
         # run to use existing daemon or restart if required
-        args = ["run", "--"] + apply_overrides(args, overrides)
-
+        args = ["--status-file", dmypy_status_file, "run", "--"] + apply_overrides(args, overrides)
         if shutil.which("dmypy"):
             # dmypy exists on path
             # -> use mypy on path

test/test_plugin.py

@@ -214,6 +214,8 @@ def test_option_overrides_dmypy(last_diagnostics_monkeypatch, workspace):
     )
     expected = [
         "dmypy",
+        "--status-file",
+        ".dmypy.json",
         "run",
         "--",
         "--python-executable",
@@ -222,3 +224,32 @@ def test_option_overrides_dmypy(last_diagnostics_monkeypatch, workspace):
         document.path,
     ]
     m.assert_called_with(expected, stderr=-1, stdout=-1, **windows_flag)
+
+
+def test_dmypy_status_file(tmpdir, last_diagnostics_monkeypatch, workspace):
+    statusFile = tmpdir / ".custom_dmypy_status_file.json"
+
+    last_diagnostics_monkeypatch.setattr(
+        FakeConfig,
+        "plugin_settings",
+        lambda _, p: {
+            "dmypy": True,
+            "live_mode": False,
+            "dmypy_status_file": str(statusFile),
+        }
+        if p == "pylsp_mypy"
+        else {},
+    )
+
+    document = Document(DOC_URI, workspace, DOC_TYPE_ERR)
+
+    assert not statusFile.exists()
+
+    diags = plugin.pylsp_lint(
+        config=FakeConfig(),
+        workspace=workspace,
+        document=document,
+        is_saved=False,
+    )
+
+    assert statusFile.exists()