Fix #2

Set ruff config to empty dict if pyproject.toml is present

Author: jhossbach

pylsp_ruff/ruff_lint.py

@@ -1,22 +1,12 @@
 import json
 import logging
-import sys
 from pathlib import PurePath
 from subprocess import PIPE, Popen, SubprocessError
 
 from pylsp import hookimpl, lsp
 from pylsp._utils import find_parents
 from pylsp.workspace import Document, Workspace
 
-# Use built-in tomllib for python>=3.11
-if sys.version_info >= (3, 11):
-    try:
-        import tomllib
-    except ImportError:
-        import tomli as tomllib
-else:
-    import tomli as tomllib
-
 log = logging.getLogger(__name__)
 
 UNNECESSITY_CODES = {
@@ -187,6 +177,8 @@ def build_args(document: Document, options: dict) -> list:
     args = ["--quiet"]
     # Use the json formatting for easier evaluation
     args.extend(["--format=json"])
+    # Do not attempt to fix -> returns file instead of diagnostics
+    args.extend(["--no-fix"])
 
     # Convert per-file-ignores dict to right format
     per_file_ignores = options.pop("per-file-ignores")
@@ -230,36 +222,38 @@ def load_config(workspace: Workspace, document: Document) -> dict:
     config = workspace._config
     _settings = config.plugin_settings("ruff", document_path=document.path)
 
-    # Default values are given by ruff
-    settings = {
-        "config": _settings.get("config", None),
-        "exclude": _settings.get("exclude", None),
-        "executable": _settings.get("executable", "ruff"),
-        "ignore": _settings.get("ignore", None),
-        "line-length": _settings.get("lineLength", None),
-        "per-file-ignores": _settings.get("perFileIgnores", None),
-        "select": _settings.get("select", None),
-    }
-
     pyproject_file = find_parents(
         workspace.root_path, document.path, ["pyproject.toml"]
     )
 
-    # Load config from pyproject file if it exists
+    # Check if pyproject is present, ignore user settings if toml exists
     if pyproject_file:
-        try:
-            log.debug(f"Found pyproject file: {str(pyproject_file[0])}")
-
-            with open(str(pyproject_file[0]), "rb") as pyproject_toml:
-                toml_dict = tomllib.load(pyproject_toml)
-
-            toml_config = toml_dict.get("tool", {}).get("ruff", {})
-
-            # Update settings with local project settings
-            for key, value in toml_config.items():
-                settings[key] = value
+        log.debug(
+            f"Found pyproject file: {str(pyproject_file[0])}, "
+            + "skipping pylsp config."
+        )
+
+        # Leave config to pyproject.toml
+        settings = {
+            "config": None,
+            "exclude": None,
+            "executable": _settings.get("executable", "ruff"),
+            "ignore": None,
+            "line-length": None,
+            "per-file-ignores": None,
+            "select": None,
+        }
 
-        except (tomllib.TOMLDecodeError, OSError) as e:
-            log.warning(f"Failed loading {str(pyproject_file)}: {e}")
+    else:
+        # Default values are given by ruff
+        settings = {
+            "config": _settings.get("config", None),
+            "exclude": _settings.get("exclude", None),
+            "executable": _settings.get("executable", "ruff"),
+            "ignore": _settings.get("ignore", None),
+            "line-length": _settings.get("lineLength", None),
+            "per-file-ignores": _settings.get("perFileIgnores", None),
+            "select": _settings.get("select", None),
+        }
 
     return settings

tests/test_ruff_lint.py

@@ -116,25 +116,34 @@ def get_ruff_cfg_settings(workspace, doc, config_str):
     return ruff_lint.load_config(workspace, doc)
 
 
-def test_ruff_multiline(workspace):
+def test_ruff_config(workspace):
     config_str = r"""[tool.ruff]
+ignore = ["F481"]
 exclude = [
     "blah",
     "file_2.py"
 ]
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401", "E402"]
+"test_something.py" = ["E402"]
     """
 
     doc_str = "print('hi')\nimport os\n"
 
     doc_uri = uris.from_fs_path(os.path.join(workspace.root_path, "blah/__init__.py"))
     workspace.put_document(doc_uri, doc_str)
+    workspace._config.update({"plugins": {"ruff": {"select": ["E", "F"]}}})
 
     ruff_settings = get_ruff_cfg_settings(
         workspace, workspace.get_document(doc_uri), config_str
     )
 
-    assert "exclude" in ruff_settings
-    assert len(ruff_settings["exclude"]) == 2
+    # Check that user config is ignored
+    for key, value in ruff_settings.items():
+        if key == "executable":
+            assert value == "ruff"
+            continue
+        assert value is None
 
     with patch("pylsp_ruff.ruff_lint.Popen") as popen_mock:
         mock_instance = popen_mock.return_value
@@ -148,66 +157,14 @@ def test_ruff_multiline(workspace):
         "ruff",
         "--quiet",
         "--format=json",
-        "--exclude=blah,file_2.py",
+        "--no-fix",
         "--",
         "-",
     ]
 
-    os.unlink(os.path.join(workspace.root_path, "pyproject.toml"))
-
-
-def test_ruff_per_file_ignores(workspace):
-    config_str = r"""[tool.ruff]
-ignore = ["F403"]
-exclude = [
-    "file_1.py",
-    "file_2.py",
-]
-[tool.ruff.per-file-ignores]
-"__init__.py" = ["F401", "E402"]
-"test_something.py" = ["E402"]
-    """
-
-    doc_str = "print('hi')\nimport os\n"
-
-    doc_uri = uris.from_fs_path(os.path.join(workspace.root_path, "blah/__init__.py"))
-    workspace.put_document(doc_uri, doc_str)
-
-    ruff_settings = get_ruff_cfg_settings(
-        workspace, workspace.get_document(doc_uri), config_str
-    )
-
-    assert "per-file-ignores" in ruff_settings
-    assert len(ruff_settings["per-file-ignores"]) == 2
-    assert "exclude" in ruff_settings
-    assert len(ruff_settings["exclude"]) == 2
-
-    doc = workspace.get_document(doc_uri)
-    res = ruff_lint.pylsp_lint(workspace, doc)
-    assert not res
-
-    os.unlink(os.path.join(workspace.root_path, "pyproject.toml"))
-
-
-def test_per_file_ignores_alternative_syntax(workspace):
-    config_str = r"""[tool.ruff.per-file-ignores]
-"__init__.py" = ["F401", "E402"]
-    """
-
-    doc_str = "print('hi')\nimport os\n"
-
-    doc_uri = uris.from_fs_path(os.path.join(workspace.root_path, "blah/__init__.py"))
-    workspace.put_document(doc_uri, doc_str)
-
-    ruff_settings = get_ruff_cfg_settings(
-        workspace, workspace.get_document(doc_uri), config_str
-    )
-
-    assert "per-file-ignores" in ruff_settings
-    assert ruff_settings["per-file-ignores"] == {"__init__.py": ["F401", "E402"]}
+    diags = ruff_lint.pylsp_lint(workspace, doc)
 
-    doc = workspace.get_document(doc_uri)
-    res = ruff_lint.pylsp_lint(workspace, doc)
-    assert not res
+    for diag in diags:
+        assert diag["code"] != "F841"
 
     os.unlink(os.path.join(workspace.root_path, "pyproject.toml"))