feat(v3): add improved matcher class to v3 preview

Author: mcous

codebook.toml

@@ -1,4 +1,5 @@
 words = [
+    "matcher's",
     "matchers",
     "mundo",
     "stubbings",

decoy/errors.py

@@ -125,3 +125,12 @@ class VerifyOrderError(VerifyError):
 
     [spying with verify]: usage/verify.md
     """
+
+
+class NoMatcherValueCapturedError(ValueError):
+    """An error raised if a [decoy.next.Matcher][] has not captured any matching values.
+
+    See the [matchers guide][] for more details.
+
+    [matchers guide]: ./v3/matchers.md
+    """

decoy/next/__init__.py

@@ -5,13 +5,15 @@
 """
 
 from ._internal.decoy import Decoy
+from ._internal.matcher import Matcher
 from ._internal.mock import AsyncMock, Mock
 from ._internal.verify import Verify
 from ._internal.when import Stub, When
 
 __all__ = [
     "AsyncMock",
     "Decoy",
+    "Matcher",
     "Mock",
     "Stub",
     "Verify",

decoy/next/_internal/errors.py

@@ -95,3 +95,9 @@ def createVerifyOrderError(
     )
 
     return errors.VerifyOrderError(message)
+
+
+def createNoMatcherValueCapturedError(
+    message: str,
+) -> errors.NoMatcherValueCapturedError:
+    return errors.NoMatcherValueCapturedError(message)

decoy/next/_internal/matcher.py

@@ -0,0 +1,307 @@
+import collections.abc
+import re
+from typing import Any, Callable, Generic, TypeVar, cast, overload
+
+try:
+    from typing import TypeIs
+except ImportError:
+    from typing_extensions import TypeIs
+
+from .errors import createNoMatcherValueCapturedError
+
+ValueT = TypeVar("ValueT")
+MatchT = TypeVar("MatchT")
+MappingT = TypeVar("MappingT", bound=collections.abc.Mapping[Any, Any])
+SequenceT = TypeVar("SequenceT", bound=collections.abc.Sequence[Any])
+ErrorT = TypeVar("ErrorT", bound=BaseException)
+
+TypedMatch = Callable[[object], TypeIs[MatchT]]
+UntypedMatch = Callable[[object], bool]
+
+
+class Matcher(Generic[ValueT]):
+    """Create a matcher from a comparison function.
+
+    Arguments:
+        match: A comparison function that returns a bool or `TypeIs` guard.
+        name: Optional name for the matcher; defaults to `match.__name__`
+        description: Optional extra description for the matcher's repr.
+
+    Example:
+        Matchers can be constructed from built-in inspection functions, like `callable`.
+
+        ```python
+        callable_matcher = Matcher(callable)
+        ```
+    """
+
+    @overload
+    def __init__(
+        self: "Matcher[MatchT]",
+        match: TypedMatch[MatchT],
+        name: str | None = None,
+        description: str | None = None,
+    ) -> None: ...
+
+    @overload
+    def __init__(
+        self: "Matcher[Any]",
+        match: UntypedMatch,
+        name: str | None = None,
+        description: str | None = None,
+    ) -> None: ...
+
+    def __init__(
+        self,
+        match: TypedMatch[ValueT] | UntypedMatch,
+        name: str | None = None,
+        description: str | None = None,
+    ) -> None:
+        self._match = match
+        self._name = name or match.__name__
+        self._description = description
+        self._values: list[ValueT] = []
+
+    def __eq__(self, target: object) -> bool:
+        if self._match(target):
+            self._values.append(cast(ValueT, target))  # type: ignore[redundant-cast]
+            return True
+
+        return False
+
+    def __repr__(self) -> str:
+        matcher_name = f"Matcher.{self._name}"
+        if self._description:
+            return f"<{matcher_name} {self._description.strip()}>"
+
+        return f"<{matcher_name}>"
+
+    @property
+    def arg(self) -> ValueT:
+        """Type-cast the matcher as the expected value.
+
+        Example:
+            If the mock expects a `str` argument, using `arg` prevents the type-checker from raising an error.
+
+            ```python
+            decoy
+              .when(mock)
+              .called_with(Matcher.matches("^(hello|hi)$").arg)
+              .then_return("world")
+            ```
+        """
+        return cast(ValueT, self)
+
+    @property
+    def value(self) -> ValueT:
+        """The latest matching compared value.
+
+        Raises:
+            NoMatcherValueCapturedError: the matcher has not been compared with any matching value.
+
+        Example:
+            You can use `value` to trigger a callback passed to your mock.
+
+            ```python
+            callback_matcher = Matcher(callable)
+            decoy.verify(mock).called_with(callback_matcher)
+            callback_matcher.value("value")
+            ```
+        """
+        if len(self._values) == 0:
+            raise createNoMatcherValueCapturedError(
+                f"{self} has not matched any values"
+            )
+
+        return self._values[-1]
+
+    @property
+    def values(self) -> list[ValueT]:
+        """All matching compared values."""
+        return self._values.copy()
+
+    @staticmethod
+    @overload
+    def any(
+        type: type[MatchT],
+        attrs: collections.abc.Mapping[str, object] | None = None,
+    ) -> "Matcher[MatchT]": ...
+
+    @staticmethod
+    @overload
+    def any(
+        type: None = None,
+        attrs: collections.abc.Mapping[str, object] | None = None,
+    ) -> "Matcher[Any]": ...
+
+    @staticmethod
+    def any(
+        type: type[MatchT] | None = None,
+        attrs: collections.abc.Mapping[str, object] | None = None,
+    ) -> "Matcher[MatchT] | Matcher[Any]":
+        """Match an argument, optionally by type and/or attributes.
+
+        If type and attributes are omitted, will match everything,
+        including `None`.
+
+        Arguments:
+            type: Type to match, if any.
+            attrs: Set of attributes to match, if any.
+        """
+        description = ""
+
+        if type:
+            description = type.__name__
+
+        if attrs:
+            description = f"{description} {attrs!r}"
+
+        return Matcher(
+            lambda t: _any(t, type, attrs),
+            name="any",
+            description=description,
+        )
+
+    @staticmethod
+    def is_not(value: object) -> "Matcher[Any]":
+        """Match any value that does not `==` the given value.
+
+        Arguments:
+            value: The value that the matcher rejects.
+        """
+        return Matcher(
+            lambda t: t != value,
+            name="is_not",
+            description=repr(value),
+        )
+
+    @staticmethod
+    @overload
+    def contains(values: MappingT) -> "Matcher[MappingT]": ...
+
+    @staticmethod
+    @overload
+    def contains(values: SequenceT, in_order: bool = False) -> "Matcher[SequenceT]": ...
+
+    @staticmethod
+    def contains(
+        values: MappingT | SequenceT,
+        in_order: bool = False,
+    ) -> "Matcher[MappingT] | Matcher[SequenceT]":
+        """Match a dict, list, or string with a partial value.
+
+        Arguments:
+            values: Partial value to match.
+            in_order: Match list values in order.
+        """
+        description = repr(values)
+
+        if in_order:
+            description = f"{description} {in_order=}"
+
+        return Matcher(
+            lambda t: _contains(t, values, in_order),
+            name="contains",
+            description=description,
+        )
+
+    @staticmethod
+    def matches(pattern: str) -> "Matcher[str]":
+        """Match a string by a pattern.
+
+        Arguments:
+            pattern: Regular expression pattern.
+        """
+        pattern_re = re.compile(pattern)
+
+        return Matcher(
+            lambda t: isinstance(t, str) and pattern_re.search(t) is not None,
+            name="matches",
+            description=repr(pattern),
+        )
+
+    @staticmethod
+    def error(type: type[ErrorT], message: str | None = None) -> "Matcher[ErrorT]":
+        """Match an exception object.
+
+        Arguments:
+            type: The type of exception to match.
+            message: An optional regular expression pattern to match.
+        """
+        message_re = re.compile(message or "")
+        description = type.__name__
+
+        if message:
+            description = f"{description} {message!r}"
+
+        return Matcher(
+            lambda t: isinstance(t, type) and message_re.search(str(t)) is not None,
+            name="error",
+            description=description,
+        )
+
+
+def _any(
+    target: object,
+    match_type: type[Any] | None,
+    attrs: collections.abc.Mapping[str, object] | None,
+) -> bool:
+    return (match_type is None or isinstance(target, match_type)) and (
+        attrs is None or _has_attrs(target, attrs)
+    )
+
+
+def _has_attrs(
+    target: object,
+    attributes: collections.abc.Mapping[str, object],
+) -> bool:
+    return all(
+        hasattr(target, attr_name) and getattr(target, attr_name) == attr_value
+        for attr_name, attr_value in attributes.items()
+    )
+
+
+def _contains(
+    target: object,
+    values: collections.abc.Mapping[object, object] | collections.abc.Sequence[object],
+    in_order: bool,
+) -> bool:
+    if isinstance(values, str):
+        return isinstance(target, str) and values in target
+    if isinstance(values, collections.abc.Mapping):
+        return _dict_containing(target, values)
+    if isinstance(values, collections.abc.Sequence):
+        return _list_containing(target, values, in_order)
+
+
+def _dict_containing(
+    target: object,
+    values: collections.abc.Mapping[object, object],
+) -> bool:
+    try:
+        return all(
+            attr_name in target and target[attr_name] == attr_value  # type: ignore[index,operator]
+            for attr_name, attr_value in values.items()
+        )
+    except TypeError:
+        return False
+
+
+def _list_containing(
+    target: object,
+    values: collections.abc.Sequence[object],
+    in_order: bool,
+) -> bool:
+    target_index = 0
+
+    try:
+        for value in values:
+            if in_order:
+                target = target[target_index:]  # type: ignore[index]
+
+            target_index = target.index(value)  # type: ignore[attr-defined]
+
+    except (AttributeError, TypeError, ValueError):
+        return False
+
+    return True