types: explicit Protocol inheritance permits changing parameter names

nedbat · nedbat · commit 57b975d3b8e0 · 2025-12-26T10:39:48.000-05:00
ty didn't consider TreeMatcher to be an instance of TMatcher because the
argument names differ.
diff --git a/coverage/files.py b/coverage/files.py
@@ -17,6 +17,7 @@
 from coverage import env
 from coverage.exceptions import ConfigError
 from coverage.misc import human_sorted, isolate_module, join_regex
+from coverage.types import TMatcher
 
 os = isolate_module(os)
 
@@ -214,7 +215,7 @@ def prep_patterns(patterns: Iterable[str]) -> list[str]:
     return prepped
 
 
-class TreeMatcher:
+class TreeMatcher(TMatcher):
     """A matcher for files in a tree.
 
     Construct with a list of paths, either files or directories. Paths match
@@ -235,7 +236,7 @@ def info(self) -> list[str]:
         """A list of strings for displaying when dumping state."""
         return self.original_paths
 
-    def match(self, fpath: str) -> bool:
+    def match(self, fpath: str) -> bool:  # pylint: disable=arguments-renamed
         """Does `fpath` indicate a file in one of our trees?"""
         fpath = os.path.normcase(fpath)
         for p in self.paths:
@@ -249,7 +250,7 @@ def match(self, fpath: str) -> bool:
         return False
 
 
-class ModuleMatcher:
+class ModuleMatcher(TMatcher):
     """A matcher for modules in a tree."""
 
     def __init__(self, module_names: Iterable[str], name: str = "unknown") -> None:
@@ -263,7 +264,7 @@ def info(self) -> list[str]:
         """A list of strings for displaying when dumping state."""
         return self.modules
 
-    def match(self, module_name: str) -> bool:
+    def match(self, module_name: str) -> bool:  # pylint: disable=arguments-renamed
         """Does `module_name` indicate a module in one of our packages?"""
         if not module_name:
             return False
@@ -279,7 +280,7 @@ def match(self, module_name: str) -> bool:
         return False
 
 
-class GlobMatcher:
+class GlobMatcher(TMatcher):
     """A matcher for files by file name pattern."""
 
     def __init__(self, pats: Iterable[str], name: str = "unknown") -> None:
@@ -294,7 +295,7 @@ def info(self) -> list[str]:
         """A list of strings for displaying when dumping state."""
         return self.pats
 
-    def match(self, fpath: str) -> bool:
+    def match(self, fpath: str) -> bool:  # pylint: disable=arguments-renamed
         """Does `fpath` match one of our file name patterns?"""
         return self.re.match(fpath) is not None
 
diff --git a/coverage/types.py b/coverage/types.py
@@ -65,6 +65,13 @@ class TFileDisposition(Protocol):
     has_dynamic_filename: bool
 
 
+class TMatcher(Protocol):
+    """The shape all Matchers have."""
+
+    def match(self, s: str) -> bool:
+        """Does this string match?"""
+
+
 # When collecting data, we use a dictionary with a few possible shapes. The
 # keys are always file names.
 # - If measuring line coverage, the values are sets of line numbers.
diff --git a/tests/test_files.py b/tests/test_files.py
@@ -10,7 +10,7 @@
 import os.path
 import re
 
-from typing import Any, Protocol
+from typing import Any
 from collections.abc import Iterable
 from unittest import mock
 
@@ -29,6 +29,7 @@
     flat_rootname,
     globs_to_regex,
 )
+from coverage.types import TMatcher
 
 from tests.coveragetest import CoverageTest
 from tests.helpers import os_sep
@@ -361,13 +362,6 @@ def test_invalid_globs(pattern: str, bad_word: str) -> None:
         globs_to_regex([pattern])
 
 
-class TMatcher(Protocol):
-    """The shape all Matchers have."""
-
-    def match(self, s: str) -> bool:
-        """Does this string match?"""
-
-
 class MatcherTest(CoverageTest):
     """Tests of file matchers."""
 
