Specialize patterns

Author: cpburnz

pathspec/gitignore.py

@@ -45,7 +45,7 @@
 """
 
 
-class GitIgnoreSpec(PathSpec):
+class GitIgnoreSpec(PathSpec[GitIgnoreSpecPattern]):
 	"""
 	The :class:`GitIgnoreSpec` class extends :class:`.PathSpec` to replicate
 	*gitignore* behavior. This is uses :class:`.GitIgnoreSpecPattern` to fully

pathspec/pathspec.py

@@ -13,10 +13,13 @@
 	zip_longest)
 from typing import (
 	Callable,  # Replaced by `collections.abc.Callable` in 3.9.2.
+	Generic,
+	Literal,
 	Optional,  # Replaced by `X | None` in 3.10.
 	TypeVar,
 	Union,  # Replaced by `X | Y` in 3.10.
-	cast)
+	cast,
+	overload)
 
 Self = TypeVar("Self", bound='PathSpec')
 """
@@ -32,30 +35,33 @@
 	make_pathspec_backend)
 from pathspec.pattern import (
 	Pattern)
+from pathspec.patterns.gitignore.basic import (
+	GitIgnoreBasicPattern)
 from pathspec._typing import (
 	AnyStr,  # Removed in 3.18.
 	deprecated)  # Added in 3.13.
 from pathspec.util import (
 	CheckResult,
 	StrPath,
+	TPattern,
 	TStrPath,
 	TreeEntry,
 	_is_iterable,
 	normalize_file)
 
 
-class PathSpec(object):
+class PathSpec(Generic[TPattern]):
 	"""
 	The :class:`PathSpec` class is a wrapper around a list of compiled
 	:class:`.Pattern` instances.
 	"""
 
 	def __init__(
 		self,
-		patterns: Union[Sequence[Pattern], Iterable[Pattern]],
+		patterns: Union[Sequence[TPattern], Iterable[TPattern]],
 		*,
 		backend: Union[BackendNamesHint, str, None] = None,
-		_test_backend_factory: Optional[Callable[[Sequence[Pattern]], _Backend]] = None,
+		_test_backend_factory: Optional[Callable[[Sequence[TPattern]], _Backend]] = None,
 	) -> None:
 		"""
 		Initializes the :class:`.PathSpec` instance.
@@ -92,7 +98,7 @@ def __init__(
 		*_backend_name* (:class:`str`) is the name of backend to use.
 		"""
 
-		self.patterns: Sequence[Pattern] = patterns
+		self.patterns: Sequence[TPattern] = patterns
 		"""
 		*patterns* (:class:`~collections.abc.Sequence` of :class:`.Pattern`)
 		contains the compiled patterns.
@@ -225,6 +231,42 @@ def check_tree_files(
 		files = util.iter_tree_files(root, on_error=on_error, follow_links=follow_links)
 		yield from self.check_files(files)
 
+	@overload
+	@classmethod
+	def from_lines(
+		cls: type[PathSpec],
+		pattern_factory: Literal['gitignore'],
+		lines: Iterable[AnyStr],
+		*,
+		backend: Union[BackendNamesHint, str, None] = None,
+		_test_backend_factory: Optional[Callable[[Sequence[Pattern]], _Backend]] = None,
+	) -> PathSpec[GitIgnoreBasicPattern]:
+		...
+
+	@overload
+	@classmethod
+	def from_lines(
+		cls: type[PathSpec],
+		pattern_factory: Callable[[AnyStr], TPattern],
+		lines: Iterable[AnyStr],
+		*,
+		backend: Union[BackendNamesHint, str, None] = None,
+		_test_backend_factory: Optional[Callable[[Sequence[TPattern]], _Backend]] = None,
+	) -> PathSpec[TPattern]:
+		...
+
+	@overload
+	@classmethod
+	def from_lines(
+		cls: type[PathSpec],
+		pattern_factory: Union[str, Callable[[AnyStr], Pattern]],
+		lines: Iterable[AnyStr],
+		*,
+		backend: Union[BackendNamesHint, str, None] = None,
+		_test_backend_factory: Optional[Callable[[Sequence[Pattern]], _Backend]] = None,
+	) -> PathSpec[Pattern]:
+		...
+
 	@classmethod
 	def from_lines(
 		cls: type[Self],

pathspec/util.py

@@ -30,6 +30,12 @@
 
 StrPath = Union[str, os.PathLike[str]]
 
+TPattern = TypeVar('TPattern', bound=Pattern)
+"""
+Type variable for :class:`.Pattern`. This is used by :class:`pathspec.pathspec.PathSpec`
+to specialize the type of patterns.
+"""
+
 TStrPath = TypeVar("TStrPath", bound=StrPath)
 """
 Type variable for :class:`str` or :class:`os.PathLike`.

tests/test_04_pathspec.py

@@ -19,7 +19,9 @@
 	Path)
 from typing import (
 	Callable,  # Replaced by `collections.abc.Callable` in 3.9.2.
-	Optional)  # Replaced by `X | None` in 3.10.
+	Literal,
+	Optional,  # Replaced by `X | None` in 3.10.
+	overload)
 from unittest import (
 	SkipTest)
 
@@ -38,6 +40,8 @@
 	Pattern)
 from pathspec.patterns.gitignore.base import (
 	GitIgnorePatternError)
+from pathspec.patterns.gitignore.basic import (
+	GitIgnoreBasicPattern)
 from pathspec._typing import (
 	AnyStr)  # Removed in 3.18.
 from pathspec.util import (
@@ -89,6 +93,22 @@ def make_files(self, files: Iterable[str]) -> None:
 		"""
 		return make_files(self.temp_dir, files)
 
+	@overload
+	def parameterize_from_lines(
+		self,
+		pattern_factory: Literal['gitignore'],
+		lines: Iterable[AnyStr],
+	) -> Iterator[Callable[[], AbstractContextManager[PathSpec[GitIgnoreBasicPattern]]]]:
+		...
+
+	@overload
+	def parameterize_from_lines(
+		self,
+		pattern_factory: str,
+		lines: Iterable[AnyStr],
+	) -> Iterator[Callable[[], AbstractContextManager[PathSpec[Pattern]]]]:
+		...
+
 	def parameterize_from_lines(
 		self,
 		pattern_factory: str,