Move exclude part to own function, add unit test

Author: maerteijn

pylsp_mypy/plugin.py

@@ -142,6 +142,22 @@ def didSettingsChange(workspace: str, settings: Dict[str, Any]) -> None:
         settingsCache[workspace] = settings.copy()
 
 
+def match_exclude_patterns(document_path: str, exclude_patterns: list) -> bool:
+    for pattern in exclude_patterns:
+        # This makes sure that \\ characters are encoded correctly so for
+        # example windows paths are matched without any bad escape errors
+        pattern = pattern.encode("unicode-escape").decode()
+
+        try:
+            if re.search(pattern, document_path):
+                log.debug(f"{document_path} matches " f"exclude pattern '{pattern}'")
+                return True
+        except re.error as e:
+            log.error(f"pattern {pattern} is not a valid regular expression: {e}")
+
+    return False
+
+
 @hookimpl
 def pylsp_lint(
     config: Config, workspace: Workspace, document: Document, is_saved: bool

test/test_plugin.py

@@ -330,6 +330,26 @@ def foo():
     assert diag["code"] == "unreachable"
 
 
+@pytest.mark.parametrize(
+    "document_path,pattern,pattern_matched",
+    (
+        ("/workspace/my-file.py", "/someting-else", False),
+        ("/workspace/my-file.py", "^/workspace$", False),
+        ("/workspace/my-file.py", "/workspace", True),
+        ("/workspace/my-file.py", "^/workspace(.*)$", True),
+        # This is a broken regex (missing ')'), but should not choke
+        ("/workspace/my-file.py", "/((workspace)", False),
+        # A windows path is tricky with all those \\ but should work
+        ("d:\\a\\my-file.py", "\\a", True),
+    ),
+)
+def test_match_exclude_patterns(document_path, pattern, pattern_matched):
+    assert (
+        plugin.match_exclude_patterns(document_path=document_path, exclude_patterns=[pattern])
+        is pattern_matched
+    )
+
+
 def test_config_exclude(tmpdir, workspace):
     """When exclude is set in config then mypy should not run for that file."""
     doc = Document(DOC_URI, workspace, DOC_TYPE_ERR)