decoy 2.2.1__tar.gz → 2.3.0__tar.gz

{decoy-2.2.1 → decoy-2.3.0}/PKG-INFO

@@ -1,18 +1,17 @@
 Metadata-Version: 2.4
 Name: decoy
-Version: 2.2.1
+Version: 2.3.0
 Summary: Opinionated mocking library for Python
-License-Expression: MIT
-License-File: LICENSE
 Author: Michael Cousins
-Author-email: michael@cousins.io>
-Requires-Python: >=3.7
+Author-email: Michael Cousins <michael@cousins.io>>
+License-Expression: MIT
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Software Development :: Testing :: Mocking
 Classifier: Typing :: Typed
+Requires-Python: >=3.7
 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/
@@ -30,7 +29,7 @@ Description-Content-Type: text/markdown
         <a title="Code Coverage" href="https://app.codecov.io/gh/mcous/decoy/"><img src="https://img.shields.io/codecov/c/github/mcous/decoy?style=flat-square"></a>
         <a title="License" href="https://github.com/mcous/decoy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/mcous/decoy?style=flat-square"></a>
         <a title="PyPI Version"href="https://pypi.org/project/decoy/"><img src="https://img.shields.io/pypi/v/decoy?style=flat-square"></a>
-        <a title="Supported Python Versions" href="https://pypi.org/project/decoy/"><img src="https://img.shields.io/pypi/pyversions/decoy?style=flat-square"></a>
+        <a title="Supported Python Versions" href="https://pypi.org/project/decoy/"><img src="https://img.shields.io/python/required-version-toml?style=flat-square&tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fmcous%2Fdecoy%2Fmain%2Fpyproject.toml"></a>
     </p>
     <p>
         <a href="https://michael.cousins.io/decoy/" class="decoy-hidden">Usage guide and documentation</a>
@@ -44,14 +43,7 @@ Decoy mocks are **async/await** and **type-checking** friendly. Decoy is heavily
 ## Install
 
 ```bash
-# pip
 pip install decoy
-
-# poetry
-poetry add --dev decoy
-
-# pipenv
-pipenv install --dev decoy
 ```
 
 ## Setup
@@ -171,4 +163,3 @@ See [spying with verify][] for more details.
 [creating mocks]: https://michael.cousins.io/decoy/usage/create/
 [stubbing with when]: https://michael.cousins.io/decoy/usage/when/
 [spying with verify]: https://michael.cousins.io/decoy/usage/verify/
-

{decoy-2.2.1 → decoy-2.3.0}/README.md

@@ -8,7 +8,7 @@
         <a title="Code Coverage" href="https://app.codecov.io/gh/mcous/decoy/"><img src="https://img.shields.io/codecov/c/github/mcous/decoy?style=flat-square"></a>
         <a title="License" href="https://github.com/mcous/decoy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/mcous/decoy?style=flat-square"></a>
         <a title="PyPI Version"href="https://pypi.org/project/decoy/"><img src="https://img.shields.io/pypi/v/decoy?style=flat-square"></a>
-        <a title="Supported Python Versions" href="https://pypi.org/project/decoy/"><img src="https://img.shields.io/pypi/pyversions/decoy?style=flat-square"></a>
+        <a title="Supported Python Versions" href="https://pypi.org/project/decoy/"><img src="https://img.shields.io/python/required-version-toml?style=flat-square&tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fmcous%2Fdecoy%2Fmain%2Fpyproject.toml"></a>
     </p>
     <p>
         <a href="https://michael.cousins.io/decoy/" class="decoy-hidden">Usage guide and documentation</a>
@@ -22,14 +22,7 @@ Decoy mocks are **async/await** and **type-checking** friendly. Decoy is heavily
 ## Install
 
 ```bash
-# pip
 pip install decoy
-
-# poetry
-poetry add --dev decoy
-
-# pipenv
-pipenv install --dev decoy
 ```
 
 ## Setup

{decoy-2.2.1 → decoy-2.3.0}/decoy/matchers.py

@@ -28,17 +28,17 @@ See the [matchers guide][] for more details.
 """
 
 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",
-]
+from typing import (
+    Any,
+    Generic,
+    List,
+    Mapping,
+    Optional,
+    Pattern,
+    Type,
+    TypeVar,
+    cast,
+)
 
 
 class _AnythingOrNone:
@@ -212,9 +212,9 @@ def HasAttributes(attributes: Mapping[str, Any]) -> Any:
 
 
 class _DictMatching:
-    _values: Mapping[str, Any]
+    _values: Mapping[Any, Any]
 
-    def __init__(self, values: Mapping[str, Any]) -> None:
+    def __init__(self, values: Mapping[Any, Any]) -> None:
         self._values = values
 
     def __eq__(self, target: object) -> bool:
@@ -235,7 +235,7 @@ class _DictMatching:
         return f"<DictMatching {self._values!r}>"
 
 
-def DictMatching(values: Mapping[str, Any]) -> Any:
+def DictMatching(values: Mapping[Any, Any]) -> Any:
     """Match any dictionary with the passed in keys / values.
 
     Arguments:
@@ -362,12 +362,32 @@ def ErrorMatching(error: Type[ErrorT], match: Optional[str] = None) -> ErrorT:
     return cast(ErrorT, _ErrorMatching(error, match))
 
 
-class _Captor:
+CapturedT = TypeVar("CapturedT")
+
+
+class ValueCaptor(Generic[CapturedT]):
+    """Match anything, capturing its value for further assertions.
+
+    Compare against the `matcher` property to capture a value.
+    The last captured value is available via `captor.value`,
+    while all captured values are stored in `captor.values`.
+
+    !!! example
+        ```python
+        captor = ValueCaptor[str]()
+        assert "foobar" == captor.matcher
+        print(captor.value)  # "foobar"
+        print(captor.values)  # ["foobar"]
+        ```
+    """
+
+    _values: List[object]
+
     def __init__(self) -> None:
-        self._values: List[Any] = []
+        self._values = []
 
     def __eq__(self, target: object) -> bool:
-        """Capture compared value, always returning True."""
+        """Captors are always "equal" to a given target."""
         self._values.append(target)
         return True
 
@@ -376,11 +396,19 @@ class _Captor:
         return "<Captor>"
 
     @property
-    def value(self) -> Any:
-        """Get the captured value.
+    def matcher(self) -> CapturedT:
+        """Match anything, capturing its value.
+
+        This method exists as a type-checking convenience.
+        """
+        return cast(CapturedT, self)
+
+    @property
+    def value(self) -> object:
+        """The latest captured value.
 
         Raises:
-            AssertionError: if no value was captured.
+            AssertionError: no value has been captured.
         """
         if len(self._values) == 0:
             raise AssertionError("No value captured by captor.")
@@ -388,24 +416,15 @@ class _Captor:
         return self._values[-1]
 
     @property
-    def values(self) -> List[Any]:
-        """Get all captured values."""
+    def values(self) -> List[object]:
+        """All captured values."""
         return self._values
 
 
 def Captor() -> Any:
-    """Match anything, capturing its value.
+    """Match anything, capturing its value for further assertions.
 
-    The last captured value will be set to `captor.value`. All captured
-    values will be placed in the `captor.values` list, which can be
-    helpful if a captor needs to be triggered multiple times.
-
-    !!! example
-        ```python
-        captor = Captor()
-        assert "foobar" == captor
-        print(captor.value)  # "foobar"
-        print(captor.values)  # ["foobar"]
-        ```
+    !!! tip
+        Prefer [decoy.matchers.ValueCaptor][], which has better type annotations.
     """
-    return _Captor()
+    return ValueCaptor()

{decoy-2.2.1 → decoy-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "decoy"
-version = "2.2.1"
+version = "2.3.0"
 description = "Opinionated mocking library for Python"
 readme = "README.md"
 license = "MIT"
@@ -29,39 +29,33 @@ Changelog = "https://github.com/mcous/decoy/releases"
 
 [dependency-groups]
 dev = [
-    "poethepoet (==0.19.0) ; python_version < '3.8'",
-    "poethepoet (==0.30.0) ; python_version >= '3.8' and python_version < '3.9'",
-    "poethepoet (==0.35.0) ; python_version >= '3.9'",
-]
-
-test = [
-  "coverage[toml] (==7.2.7) ; python_version < '3.8'",
-  "coverage[toml] (==7.6.1) ; python_version >= '3.8' and python_version < '3.9'",
-  "coverage[toml] (==7.9.1) ; python_version >= '3.9'",
-  "mypy (==1.4.1) ; python_version < '3.8'",
-  "mypy (==1.14.1) ; python_version >= '3.8' and python_version < '3.9'",
-  "mypy (==1.16.0) ; python_version >= '3.9'",
-  "pytest (==7.4.4) ; python_version < '3.8'",
-  "pytest (==8.3.5) ; python_version >= '3.8' and python_version < '3.9'",
-  "pytest (==8.4.0) ; python_version >= '3.9'",
-  "pytest-asyncio (==0.21.2) ; python_version < '3.8'",
-  "pytest-asyncio (==0.24.0) ; python_version >= '3.8' and python_version < '3.9'",
-  "pytest-asyncio (==1.0.0) ; python_version >= '3.9'",
-  "pytest-mypy-plugins (==2.0.0) ; python_version < '3.8'",
-  "pytest-mypy-plugins (==3.1.2) ; python_version >= '3.8' and python_version < '3.9'",
-  "pytest-mypy-plugins (==3.2.0) ; python_version >= '3.9'",
-  "pytest-xdist (==3.5.0) ; python_version < '3.8'",
-  "pytest-xdist (==3.6.1) ; python_version >= '3.8' and python_version < '3.9'",
-  "pytest-xdist (==3.7.0) ; python_version >= '3.9'",
-  "ruff (==0.14.7)"
-]
-
-docs = [
+    "coverage[toml] (==7.2.7) ; python_version < '3.8'",
+    "coverage[toml] (==7.6.1) ; python_version >= '3.8' and python_version < '3.9'",
+    "coverage[toml] (==7.9.1) ; python_version >= '3.9'",
+    "mypy (==1.4.1) ; python_version < '3.8'",
+    "mypy (==1.14.1) ; python_version >= '3.8' and python_version < '3.9'",
+    "mypy (==1.16.0) ; python_version >= '3.9'",
+    "pytest (==7.4.4) ; python_version < '3.8'",
+    "pytest (==8.3.5) ; python_version >= '3.8' and python_version < '3.9'",
+    "pytest (==8.4.0) ; python_version >= '3.9'",
+    "pytest-asyncio (==0.21.2) ; python_version < '3.8'",
+    "pytest-asyncio (==0.24.0) ; python_version >= '3.8' and python_version < '3.9'",
+    "pytest-asyncio (==1.0.0) ; python_version >= '3.9'",
+    "pytest-mypy-plugins (==2.0.0) ; python_version < '3.8'",
+    "pytest-mypy-plugins (==3.1.2) ; python_version >= '3.8' and python_version < '3.9'",
+    "pytest-mypy-plugins (==3.2.0) ; python_version >= '3.9'",
+    "pytest-xdist (==3.5.0) ; python_version < '3.8'",
+    "pytest-xdist (==3.6.1) ; python_version >= '3.8' and python_version < '3.9'",
+    "pytest-xdist (==3.7.0) ; python_version >= '3.9'",
+    "ruff (==0.14.10)",
     "mkdocs (==1.6.1) ; python_version >= '3.10'",
-    "mkdocs-material (==9.6.21) ; python_version >= '3.10'",
-    "mkdocstrings[python] (==0.30.1) ; python_version >= '3.10'"
+    "mkdocs-material (==9.7.1) ; python_version >= '3.10'",
+    "mkdocstrings[python] (==1.0.0) ; python_version >= '3.10'"
 ]
 
+[tool.poe]
+executor.type = "uv"
+
 [tool.poe.tasks]
 all = [
     "check",
@@ -82,7 +76,7 @@ coverage = "coverage report"
 coverage-xml = "coverage xml"
 docs = "mkdocs serve"
 build-docs = "mkdocs build"
-build-package = "poetry build"
+build-package = "uv build"
 check-ci = ["check", "lint", "format-check"]
 test-ci = ["test-once", "coverage-xml"]
 
@@ -111,5 +105,12 @@ ignore = ["ANN401", "D107", "E501"]
 convention = "google"
 
 [build-system]
-requires = ["poetry_core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
+requires = ["uv_build>=0.9.21,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "decoy"
+module-root = ""
+
+[tool.uv]
+required-version = ">=0.9.21,<0.10.0"

decoy-2.2.1/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020-2023, Michael Cousins
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.