Merge pull request #110 from henryiii/henryiii/fix/addstr

fix: nicer debug print outs (and str for regex pattern)

Author: cpburnz

pathspec/pathspec.py

@@ -98,6 +98,12 @@ def __init__(
 		contains the compiled patterns.
 		"""
 
+	def __repr__(self) -> str:
+		"""
+		Returns a debug representation of this path-spec.
+		"""
+		return f"{self.__class__.__name__}(patterns={self.patterns!r}, backend={self._backend_name!r})"
+
 	def __add__(self: Self, other: PathSpec) -> Self:
 		"""
 		Combines the :attr:`self.patterns <.PathSpec.patterns>` patterns from two

pathspec/pattern.py

@@ -158,6 +158,21 @@ def __init__(
 		expression for the pattern.
 		"""
 
+	def __repr__(self) -> str:
+		"""
+		Returns a debug representation of this regex pattern.
+		"""
+		return f"{self.__class__.__name__}(pattern={self.pattern!r}, include={self.include!r})"
+
+	def __str__(self) -> str:
+		"""
+		Returns a string representation of this regex pattern. Equivalent to uncompiled pattern.
+
+		The string representation is the uncompiled pattern if it is not
+		:data:`None`; otherwise, an empty string.
+		"""
+		return str(self.pattern or "")
+
 	def __copy__(self: RegexPatternSelf) -> RegexPatternSelf:
 		"""
 		Performa a shallow copy of the pattern.

tests/test_02_gitignore_basic.py

@@ -926,3 +926,11 @@ def test_15_issue_93_c_2(self):
 		pattern = GitIgnoreBasicPattern('[!]')
 		self.assertIs(pattern.include, True)
 		self.assertEqual(pattern.regex.pattern, f'^(?:.+/)?\\[!\\]{_DIR_OPT}')
+
+	def test_16_repr_str(self):
+		"""
+		Test debug and string representations.
+		"""
+		pattern = GitIgnoreBasicPattern('*.py')
+		self.assertEqual(repr(pattern), "GitIgnoreBasicPattern(pattern='*.py', include=True)")
+		self.assertEqual(str(pattern), '*.py')

tests/test_04_pathspec.py

@@ -1041,3 +1041,13 @@ def test_10_issue_100(self):
 				includes = get_includes(results)
 				debug = debug_results(spec, results)
 				self.assertEqual(includes, set(), debug)
+
+	def test_11_repr(self):
+		"""
+		Test the path-spec debug representation.
+		"""
+		spec = PathSpec.from_lines('gitignore', ['*.py'], backend='simple')
+		self.assertEqual(
+			repr(spec),
+			"PathSpec(patterns=[GitIgnoreBasicPattern(pattern='*.py', include=True)], backend='simple')",
+		)