Move MatcherSpecInvalidError to exceptions.py

Author: c0llab0rat0r

ipfshttpclient/exceptions.py

@@ -10,13 +10,14 @@
 	 │    ├── EncoderMissingError
 	 │    ├── EncodingError
 	 │    └── DecodingError
-	 └── CommunicationError
-	      ├── ProtocolError
-	      ├── StatusError
-	      ├── ErrorResponse
-	      │    └── PartialErrorResponse
-	      ├── ConnectionError
-	      └── TimeoutError
+	 ├── CommunicationError
+	 │    ├── ProtocolError
+	 │    ├── StatusError
+	 │    ├── ErrorResponse
+	 │    │    └── PartialErrorResponse
+	 │    ├── ConnectionError
+	 │    └── TimeoutError
+	 └── MatcherSpecInvalidError
 
 """
 import typing as ty
@@ -105,6 +106,22 @@ def __init__(self, encoder_name: str, original: Exception) -> None:
 		super().__init__("Object decoding error: {}".format(original), encoder_name)
 
 
+##################
+# filescanner.py #
+##################
+
+class MatcherSpecInvalidError(TypeError):
+	"""
+	An attempt was made to build a matcher using matcher_from_spec, but an invalid
+	specification was provided.
+	"""
+
+	def __init__(self, matcher_class: type, invalid_spec: ty.Any) -> None:
+		super().__init__(
+			f"Don't know how to create a {matcher_class.__name__} from spec {invalid_spec!r}"
+		)
+
+
 ###########
 # http.py #
 ###########

ipfshttpclient/filescanner.py

@@ -16,6 +16,8 @@
 # To encourage contributions from PyCharm users, we redefine AnyStr.
 #
 # This will get inlined if/when PyCharm no longer flags typing.AnyStr.
+from .exceptions import MatcherSpecInvalidError
+
 AnyStr = ty.TypeVar('AnyStr', bytes, str)
 
 if sys.version_info >= (3, 7):  #PY37+
@@ -413,13 +415,6 @@ def should_report(self, path: AnyStr, *, is_dir: bool) -> bool:
 ]
 
 
-class MatcherSpecInvalidError(TypeError):
-	def __init__(self, invalid_spec: ty.Any) -> None:
-		super().__init__(
-			f"Don't know how to create a {Matcher.__name__} from spec {invalid_spec!r}"
-		)
-
-
 def _require_spec(spec: ty.Optional[match_spec_t[AnyStr]]) -> match_spec_t[AnyStr]:
 	"""
 	Assist the type checker by narrowing the number of places accepting Optional.
@@ -502,7 +497,7 @@ def _recursive_matcher_from_spec(spec: match_spec_t[AnyStr], *,
 		else:  # Actual list of matchers (plural)
 			return MetaMatcher(matchers)
 	else:
-		raise MatcherSpecInvalidError(spec)
+		raise MatcherSpecInvalidError(Matcher, spec)
 
 
 class walk(ty.Generator[FSNodeEntry[AnyStr], ty.Any, None], ty.Generic[AnyStr]):

test/unit/test_filescanner.py

@@ -6,8 +6,10 @@
 import pytest
 
 from datetime import datetime
+
 from ipfshttpclient import filescanner
 
+from ipfshttpclient.exceptions import MatcherSpecInvalidError
 from ipfshttpclient.filescanner import FSNodeEntry
 from ipfshttpclient.filescanner import FSNodeType
 
@@ -164,7 +166,7 @@ def test_glob_matching(
 
 @pytest.mark.parametrize('spec', [123, datetime.now()])
 def test_matcher_from_spec_rejects_invalid_spec_type(spec: ty.Any) -> None:
-	with pytest.raises(filescanner.MatcherSpecInvalidError):
+	with pytest.raises(MatcherSpecInvalidError):
 		filescanner.matcher_from_spec(spec)