decoy 2.1.1__tar.gz → 2.2.0__tar.gz

{decoy-2.1.1 → decoy-2.2.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: decoy
-Version: 2.1.1
+Version: 2.2.0
 Summary: Opinionated mocking library for Python
-Home-page: https://michael.cousins.io/decoy/
 License: MIT
 Author: Michael Cousins
 Author-email: michael@cousins.io
@@ -18,11 +17,13 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Software Development :: Testing :: Mocking
 Classifier: Typing :: Typed
 Project-URL: Changelog, https://github.com/mcous/decoy/releases
 Project-URL: Documentation, https://michael.cousins.io/decoy/
+Project-URL: Homepage, https://michael.cousins.io/decoy/
 Project-URL: Repository, https://github.com/mcous/decoy
 Description-Content-Type: text/markdown
 

{decoy-2.1.1 → decoy-2.2.0}/decoy/__init__.py

@@ -1,4 +1,5 @@
 """Decoy stubbing and spying library."""
+
 from typing import Any, Callable, Coroutine, Generic, Optional, Union, overload
 
 from . import errors, matchers, warnings
@@ -40,16 +41,13 @@ class Decoy:
         self._core = DecoyCore()
 
     @overload
-    def mock(self, *, cls: Callable[..., ClassT]) -> ClassT:
-        ...
+    def mock(self, *, cls: Callable[..., ClassT]) -> ClassT: ...
 
     @overload
-    def mock(self, *, func: FuncT) -> FuncT:
-        ...
+    def mock(self, *, func: FuncT) -> FuncT: ...
 
     @overload
-    def mock(self, *, name: str, is_async: bool = False) -> Any:
-        ...
+    def mock(self, *, name: str, is_async: bool = False) -> Any: ...
 
     def mock(
         self,
@@ -255,29 +253,25 @@ class Stub(Generic[ReturnT]):
     def then_enter_with(
         self: "Stub[ContextManager[ContextValueT]]",
         value: ContextValueT,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     @overload
     def then_enter_with(
         self: "Stub[AsyncContextManager[ContextValueT]]",
         value: ContextValueT,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     @overload
     def then_enter_with(
         self: "Stub[GeneratorContextManager[ContextValueT]]",
         value: ContextValueT,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     @overload
     def then_enter_with(
         self: "Stub[AsyncGeneratorContextManager[ContextValueT]]",
         value: ContextValueT,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     def then_enter_with(
         self: Union[
@@ -347,4 +341,4 @@ class Prop(Generic[ReturnT]):
         self._core.delete()
 
 
-__all__ = ["Decoy", "Stub", "Prop", "matchers", "warnings", "errors"]
+__all__ = ["Decoy", "Prop", "Stub", "errors", "matchers", "warnings"]

{decoy-2.1.1 → decoy-2.2.0}/decoy/call_handler.py

@@ -1,4 +1,5 @@
 """Spy call handling."""
+
 from typing import Any, NamedTuple, Optional
 
 from .spy_log import SpyLog

{decoy-2.1.1 → decoy-2.2.0}/decoy/context_managers.py

@@ -1,4 +1,5 @@
 """Wrappers around contextlib types and fallbacks."""
+
 from typing import Any, AsyncContextManager, ContextManager, Generic, TypeVar
 
 from contextlib import (
@@ -44,6 +45,6 @@ __all__ = [
     "AsyncContextManager",
     "AsyncGeneratorContextManager",
     "ContextManager",
-    "GeneratorContextManager",
     "ContextWrapper",
+    "GeneratorContextManager",
 ]

{decoy-2.1.1 → decoy-2.2.0}/decoy/core.py

@@ -1,4 +1,5 @@
 """Decoy implementation logic."""
+
 import inspect
 from typing import Any, Callable, Optional
 

{decoy-2.1.1 → decoy-2.2.0}/decoy/errors.py

@@ -4,6 +4,7 @@ See the [errors guide][] for more details.
 
 [errors guide]: usage/errors-and-warnings.md#errors
 """
+
 from typing import Optional, Sequence
 
 from .spy_events import SpyEvent, VerifyRehearsal

{decoy-2.1.1 → decoy-2.2.0}/decoy/matchers.py

@@ -26,20 +26,42 @@ See the [matchers guide][] for more details.
     Identity comparisons (`is`) will not work with matchers. Decoy only uses
     equality comparisons (`==`) for stubbing and verification.
 """
+
 from re import compile as compile_re
 from typing import cast, Any, List, Mapping, Optional, Pattern, Type, TypeVar
 
 
 __all__ = [
     "Anything",
+    "Captor",
+    "ErrorMatching",
     "IsA",
     "IsNot",
     "StringMatching",
-    "ErrorMatching",
-    "Captor",
 ]
 
 
+class _AnythingOrNone:
+    def __eq__(self, target: object) -> bool:
+        return True
+
+    def __repr__(self) -> str:
+        """Return a string representation of the matcher."""
+        return "<AnythingOrNone>"
+
+
+def AnythingOrNone() -> Any:
+    """Match anything including None.
+
+    !!! example
+        ```python
+        assert "foobar" == AnythingOrNone()
+        assert None == AnythingOrNone()
+        ```
+    """
+    return _AnythingOrNone()
+
+
 class _Anything:
     def __eq__(self, target: object) -> bool:
         """Return true if target is not None."""
@@ -228,6 +250,41 @@ def DictMatching(values: Mapping[str, Any]) -> Any:
     return _DictMatching(values)
 
 
+class _ListMatching:
+    _values: List[Any]
+
+    def __init__(self, values: List[Any]) -> None:
+        self._values = values
+
+    def __eq__(self, target: object) -> bool:
+        """Return true if target matches all given values."""
+        if not hasattr(target, "__iter__"):
+            return False
+
+        return all(
+            any(item == target_item for target_item in target) for item in self._values
+        )
+
+    def __repr__(self) -> str:
+        """Return a string representation of the matcher."""
+        return f"<ListMatching {self._values!r}>"
+
+
+def ListMatching(values: List[Any]) -> Any:
+    """Match any list with the passed in values.
+
+    Arguments:
+        values: Values to check.
+
+    !!! example
+        ```python
+        value = [1, 2, 3]
+        assert value == matchers.ListMatching([1, 2])
+        ```
+    """
+    return _ListMatching(values)
+
+
 class _StringMatching:
     _pattern: Pattern[str]
 
@@ -270,7 +327,7 @@ class _ErrorMatching:
 
     def __eq__(self, target: object) -> bool:
         """Return true if target is not self._reject_value."""
-        error_match = type(target) == self._error_type
+        error_match = type(target) is self._error_type
         message_match = (
             str(target) == self._string_matcher
             if self._string_matcher is not None

{decoy-2.1.1 → decoy-2.2.0}/decoy/mypy/__init__.py

@@ -1,4 +1,5 @@
 """Decoy mypy plugin entrypoint."""
+
 from .plugin import plugin
 
 __all__ = ["plugin"]

{decoy-2.1.1 → decoy-2.2.0}/decoy/mypy/plugin.py

@@ -1,4 +1,5 @@
 """Decoy mypy plugin."""
+
 from typing import Callable, Optional, Type as ClassType
 
 from mypy.errorcodes import FUNC_RETURNS_VALUE

{decoy-2.1.1 → decoy-2.2.0}/decoy/pytest_plugin.py

@@ -4,6 +4,7 @@ The plugin will be registered with pytest when you install Decoy. It adds a
 fixture without modifying any other pytest behavior. Its usage is optional
 but highly recommended.
 """
+
 from typing import Iterable
 
 import pytest

{decoy-2.1.1 → decoy-2.2.0}/decoy/spy.py

@@ -3,6 +3,7 @@
 Classes in this module are heavily inspired by the
 [unittest.mock library](https://docs.python.org/3/library/unittest.mock.html).
 """
+
 import inspect
 from types import TracebackType
 from typing import Any, ContextManager, Dict, Optional, Type, Union, cast, overload
@@ -186,14 +187,12 @@ class SpyCreator:
         self._decoy_spy_call_handler = call_handler
 
     @overload
-    def create(self, *, core: SpyCore) -> AnySpy:
-        ...
+    def create(self, *, core: SpyCore) -> AnySpy: ...
 
     @overload
     def create(
         self, *, spec: Optional[object], name: Optional[str], is_async: bool
-    ) -> AnySpy:
-        ...
+    ) -> AnySpy: ...
 
     def create(
         self,

{decoy-2.1.1 → decoy-2.2.0}/decoy/spy_core.py

@@ -1,11 +1,22 @@
 """Core spy logic."""
+
 import inspect
 import functools
 import warnings
-from typing import Any, Dict, NamedTuple, Optional, Tuple, Type, Union, get_type_hints
+from typing import (
+    Any,
+    Dict,
+    NamedTuple,
+    Optional,
+    Tuple,
+    Type,
+    Union,
+    Sequence,
+    get_type_hints,
+)
 
 from .spy_events import SpyInfo
-from .warnings import IncorrectCallWarning, MissingSpecAttributeWarning
+from .warnings import IncorrectCallWarning
 
 
 class _FROM_SOURCE:
@@ -136,12 +147,7 @@ class SpyCore:
                     # signature reporting by wrapping it in a partial
                     child_source = functools.partial(child_source, None)
 
-        if child_source is None and source is not None:
-            # stacklevel: 4 ensures warning is linked to call location
-            warnings.warn(
-                MissingSpecAttributeWarning(f"{self._name} has no attribute '{name}'"),
-                stacklevel=4,
-            )
+        child_source = _unwrap_optional(child_source)
 
         return SpyCore(
             source=child_source,
@@ -215,3 +221,24 @@ def _get_type_hints(obj: Any) -> Dict[str, Any]:
         return get_type_hints(obj)
     except Exception:
         return {}
+
+
+def _unwrap_optional(source: Any) -> Any:
+    """Return the source's base type if it's a optional.
+
+    If the type is a union of more than just T | None,
+    bail out and return None to avoid potentially false warnings.
+    """
+    origin = getattr(source, "__origin__", None)
+    args: Sequence[Any] = getattr(source, "__args__", ())
+
+    # TODO(mc, 2025-03-19): support larger unions? might be a lot of work for little payoff
+    if origin is Union:
+        if len(args) == 2 and args[0] is type(None):
+            return args[1]
+        if len(args) == 2 and args[1] is type(None):
+            return args[0]
+
+        return None
+
+    return source

{decoy-2.1.1 → decoy-2.2.0}/decoy/spy_events.py

@@ -1,4 +1,5 @@
 """Spy interaction event value objects."""
+
 import enum
 from typing import Any, Dict, NamedTuple, Optional, Tuple, Union
 

{decoy-2.1.1 → decoy-2.2.0}/decoy/spy_log.py

@@ -1,4 +1,5 @@
 """Spy activity log."""
+
 from typing import List, Sequence
 
 from .errors import MissingRehearsalError

{decoy-2.1.1 → decoy-2.2.0}/decoy/stringify.py

@@ -1,4 +1,5 @@
 """Message string generation."""
+
 import os
 from typing import Sequence
 

{decoy-2.1.1 → decoy-2.2.0}/decoy/stub_store.py

@@ -1,4 +1,5 @@
 """Stub creation and storage."""
+
 from typing import Any, Callable, List, NamedTuple, Optional, Union
 
 from .spy_events import SpyEvent, WhenRehearsal, match_event

{decoy-2.1.1 → decoy-2.2.0}/decoy/types.py

@@ -1,4 +1,5 @@
 """Common type definitions."""
+
 from typing import Any, Callable, TypeVar
 
 FuncT = TypeVar("FuncT", bound=Callable[..., Any])

{decoy-2.1.1 → decoy-2.2.0}/decoy/verifier.py

@@ -1,4 +1,5 @@
 """Spy call verification."""
+
 from typing import Optional, Sequence
 
 from .spy_events import SpyEvent, VerifyRehearsal, match_event

{decoy-2.1.1 → decoy-2.2.0}/decoy/warning_checker.py

@@ -1,4 +1,5 @@
 """Warning checker."""
+
 from collections import defaultdict
 from itertools import groupby
 from typing import Dict, List, NamedTuple, Sequence

{decoy-2.1.1 → decoy-2.2.0}/decoy/warnings.py

@@ -4,6 +4,7 @@ See the [warnings guide][] for more details.
 
 [warnings guide]: usage/errors-and-warnings.md#warnings
 """
+
 import os
 from typing import Sequence
 
@@ -95,13 +96,3 @@ class IncorrectCallWarning(DecoyWarning):
 
     [IncorrectCallWarning guide]: usage/errors-and-warnings.md#incorrectcallwarning
     """
-
-
-class MissingSpecAttributeWarning(DecoyWarning):
-    """A warning raised if a Decoy mock with a spec is used with a missing attribute.
-
-    This will become an error in the next major version of Decoy.
-    See the [MissingSpecAttributeWarning guide][] for more details.
-
-    [MissingSpecAttributeWarning guide]: usage/errors-and-warnings.md#missingspecattributewarning
-    """

{decoy-2.1.1 → decoy-2.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "decoy"
-version = "2.1.1"
+version = "2.2.0"
 description = "Opinionated mocking library for Python"
 authors = ["Michael Cousins <michael@cousins.io>"]
 license = "MIT"
@@ -36,8 +36,8 @@ mypy = [
 pytest = "7.4.0"
 pytest-asyncio = "0.21.1"
 pytest-mypy-plugins = "2.0.0"
-pytest-xdist = "3.3.1"
-ruff = "0.1.3"
+pytest-xdist = "3.5.0"
+ruff = "0.11.0"
 
 [tool.poetry.group.docs.dependencies]
 mkdocs = { version = "1.5.3", python = ">=3.8" }
@@ -88,10 +88,12 @@ exclude_lines = ["@overload", "if TYPE_CHECKING:"]
 [tool.ruff]
 target-version = "py37"
 extend-exclude = [".cache"]
+
+[tool.ruff.lint]
 select = ["ANN", "B", "D", "E", "F", "RUF", "W"]
-ignore = ["ANN101", "ANN102", "ANN401", "D107", "E501"]
+ignore = ["ANN401", "D107", "E501"]
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "google"
 
 [build-system]