pytest-extended-mock 0.1.1__tar.gz

pytest_extended_mock-0.1.1/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.3
+Name: pytest-extended-mock
+Version: 0.1.1
+Summary: a pytest extension for easy mock setup
+License: MIT
+Author: Adam Davenport
+Author-email: adam006@gmail.com
+Requires-Python: >=3.12
+Classifier: Framework :: Pytest
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Testing
+Requires-Dist: pytest (>=8.3.5,<9.0.0)
+Requires-Dist: pytest-mock (>=3.14.0,<4.0.0)
+Project-URL: Homepage, https://github.com/adam006/pytest-mock-setup
+Project-URL: Repository, https://github.com/adam006/pytest-mock-setup
+Description-Content-Type: text/markdown
+
+# ExtendedMock Pytest Plugin
+
+Welcome to the **ExtendedMock Pytest Plugin**! This plugin enhances Python's `unittest.mock.MagicMock` with additional functionality inspired by the setup and verification patterns found in popular .NET mocking libraries like **Moq**. If you've ever used Moq and loved its fluent API for configuring mock behavior, this plugin will feel like home.
+
+## What is ExtendedMock?
+
+`ExtendedMock` is a drop-in replacement for `unittest.mock.MagicMock` that adds a `setup` method, allowing you to configure mock behavior for specific arguments. This makes it easier to write expressive and precise tests by defining exactly what your mock should return (or raise) when called with certain arguments.
+
+### Key Features:
+- **Fluent API**: Configure mock behavior using a clean, chainable `setup` method.
+- **Argument-Specific Behavior**: Define return values or exceptions for specific argument combinations.
+- **Seamless Integration**: Works out of the box with `pytest` and replaces `MagicMock` automatically.
+- **Familiar to .NET Developers**: If you've used Moq, you'll feel right at home with the `setup` method.
+
+---
+
+## Usage
+
+### Basic Example
+
+Here's how you can use `ExtendedMock` in your tests:
+
+```python
+from unittest.mock import MagicMock
+
+def test_extended_mock():
+    mock = MagicMock()
+    
+    # Configure the mock to return "Hello, World!" when called with ("foo", bar=42)
+    mock.setup("foo", bar=42, return_value="Hello, World!")
+    
+    # Call the mock with the configured arguments
+    result = mock("foo", bar=42)
+    
+    assert result == "Hello, World!"
+```
+
+### Raising Exceptions
+
+You can also configure the mock to raise an exception for specific arguments:
+
+```python
+def test_extended_mock_with_exception():
+    mock = MagicMock()
+    
+    # Configure the mock to raise a ValueError when called with ("error",)
+    mock.setup("error", return_value=ValueError("Something went wrong!"))
+    
+    # Call the mock with the configured arguments
+    with pytest.raises(ValueError):
+        mock("error")
+```
+
+### Default Behavior
+
+If the mock is called with arguments that don't match any configured setup, it falls back to the default `MagicMock` behavior:
+
+```python
+def test_extended_mock_default_behavior():
+    mock = MagicMock()
+    
+    # No setup configured, so it returns a new MagicMock instance
+    result = mock("unconfigured", args=123)
+    
+    assert isinstance(result, MagicMock)
+```
+
+---
+
+## Why Use ExtendedMock?
+
+If you've ever found yourself writing repetitive code to configure `MagicMock` instances for different argument combinations, `ExtendedMock` is here to save the day. It provides a more expressive and concise way to define mock behavior, making your tests easier to read and maintain.
+
+### For .NET Developers
+
+If you're coming from the .NET world and have used libraries like **Moq**, you'll find the `setup` method very familiar. It mirrors the `Setup` and `Returns` methods in Moq, allowing you to define mock behavior in a similar way. For example:
+
+```csharp
+// Moq in .NET
+var mock = new Mock<IService>();
+mock.Setup(x => x.DoSomething("foo", 42)).Returns("Hello, World!");
+```
+
+```python
+# ExtendedMock in Python
+mock = MagicMock()
+mock.setup("foo", 42, return_value="Hello, World!")
+```
+
+---
+
+## How It Works
+
+The `ExtendedMock` class extends `unittest.mock.MagicMock` and adds a `_setup_data` dictionary to store configurations. When the mock is called, it checks if the arguments match any configured setup. If a match is found, it returns the configured value or raises the configured exception. If no match is found, it falls back to the default `MagicMock` behavior.
+
+---
+
+## Contributing
+
+We welcome contributions! If you have ideas for improvements or find a bug, please open an issue or submit a pull request on [GitHub](https://github.com/yourusername/pytest-extendedmock).
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## Keywords
+
+- pytest
+- mocking
+- unittest
+- MagicMock
+- Moq
+- .NET
+- testing
+- fluent API
+- mock setup
+
+---
+
+Happy testing! 🚀
+

pytest_extended_mock-0.1.1/README.md

@@ -0,0 +1,124 @@
+# ExtendedMock Pytest Plugin
+
+Welcome to the **ExtendedMock Pytest Plugin**! This plugin enhances Python's `unittest.mock.MagicMock` with additional functionality inspired by the setup and verification patterns found in popular .NET mocking libraries like **Moq**. If you've ever used Moq and loved its fluent API for configuring mock behavior, this plugin will feel like home.
+
+## What is ExtendedMock?
+
+`ExtendedMock` is a drop-in replacement for `unittest.mock.MagicMock` that adds a `setup` method, allowing you to configure mock behavior for specific arguments. This makes it easier to write expressive and precise tests by defining exactly what your mock should return (or raise) when called with certain arguments.
+
+### Key Features:
+- **Fluent API**: Configure mock behavior using a clean, chainable `setup` method.
+- **Argument-Specific Behavior**: Define return values or exceptions for specific argument combinations.
+- **Seamless Integration**: Works out of the box with `pytest` and replaces `MagicMock` automatically.
+- **Familiar to .NET Developers**: If you've used Moq, you'll feel right at home with the `setup` method.
+
+---
+
+## Usage
+
+### Basic Example
+
+Here's how you can use `ExtendedMock` in your tests:
+
+```python
+from unittest.mock import MagicMock
+
+def test_extended_mock():
+    mock = MagicMock()
+    
+    # Configure the mock to return "Hello, World!" when called with ("foo", bar=42)
+    mock.setup("foo", bar=42, return_value="Hello, World!")
+    
+    # Call the mock with the configured arguments
+    result = mock("foo", bar=42)
+    
+    assert result == "Hello, World!"
+```
+
+### Raising Exceptions
+
+You can also configure the mock to raise an exception for specific arguments:
+
+```python
+def test_extended_mock_with_exception():
+    mock = MagicMock()
+    
+    # Configure the mock to raise a ValueError when called with ("error",)
+    mock.setup("error", return_value=ValueError("Something went wrong!"))
+    
+    # Call the mock with the configured arguments
+    with pytest.raises(ValueError):
+        mock("error")
+```
+
+### Default Behavior
+
+If the mock is called with arguments that don't match any configured setup, it falls back to the default `MagicMock` behavior:
+
+```python
+def test_extended_mock_default_behavior():
+    mock = MagicMock()
+    
+    # No setup configured, so it returns a new MagicMock instance
+    result = mock("unconfigured", args=123)
+    
+    assert isinstance(result, MagicMock)
+```
+
+---
+
+## Why Use ExtendedMock?
+
+If you've ever found yourself writing repetitive code to configure `MagicMock` instances for different argument combinations, `ExtendedMock` is here to save the day. It provides a more expressive and concise way to define mock behavior, making your tests easier to read and maintain.
+
+### For .NET Developers
+
+If you're coming from the .NET world and have used libraries like **Moq**, you'll find the `setup` method very familiar. It mirrors the `Setup` and `Returns` methods in Moq, allowing you to define mock behavior in a similar way. For example:
+
+```csharp
+// Moq in .NET
+var mock = new Mock<IService>();
+mock.Setup(x => x.DoSomething("foo", 42)).Returns("Hello, World!");
+```
+
+```python
+# ExtendedMock in Python
+mock = MagicMock()
+mock.setup("foo", 42, return_value="Hello, World!")
+```
+
+---
+
+## How It Works
+
+The `ExtendedMock` class extends `unittest.mock.MagicMock` and adds a `_setup_data` dictionary to store configurations. When the mock is called, it checks if the arguments match any configured setup. If a match is found, it returns the configured value or raises the configured exception. If no match is found, it falls back to the default `MagicMock` behavior.
+
+---
+
+## Contributing
+
+We welcome contributions! If you have ideas for improvements or find a bug, please open an issue or submit a pull request on [GitHub](https://github.com/yourusername/pytest-extendedmock).
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## Keywords
+
+- pytest
+- mocking
+- unittest
+- MagicMock
+- Moq
+- .NET
+- testing
+- fluent API
+- mock setup
+
+---
+
+Happy testing! 🚀

pytest_extended_mock-0.1.1/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "pytest-extended-mock"
+version = "0.1.1"
+description = "a pytest extension for easy mock setup"
+authors = [{ name = "Adam Davenport", email = "adam006@gmail.com" }]
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = ["pytest (>=8.3.5,<9.0.0)", "pytest-mock (>=3.14.0,<4.0.0)"]
+classifiers = [
+  "Framework :: Pytest",
+  "Programming Language :: Python",
+  "Topic :: Software Development :: Testing",
+]
+[tool.poetry]
+repository = "https://github.com/adam006/pytest-mock-setup"
+homepage = "https://github.com/adam006/pytest-mock-setup"
+license = "MIT"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.plugins.pytest11]
+extended_mock = "pytest_extended_mock.plugin"

pytest_extended_mock-0.1.1/src/pytest_extended_mock/__init__.py

@@ -0,0 +1,3 @@
+from .plugin import ExtendedMock
+
+__all__ = ["ExtendedMock"]

pytest_extended_mock-0.1.1/src/pytest_extended_mock/plugin.py

@@ -0,0 +1,43 @@
+from unittest.mock import MagicMock
+
+
+class ExtendedMock(MagicMock):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._setup_data = {}
+
+    def setup(self, *args, return_value=None, **kwargs):
+        # Default to empty tuple and frozenset
+        args = args if args is not None else ()
+        kwargs = kwargs if kwargs is not None else {}
+        frozen_kwargs = frozenset(kwargs.items()) if kwargs else frozenset()
+
+        # Store the configuration
+        key = (args, frozen_kwargs)
+        self._setup_data[key] = return_value
+
+        return self
+
+    def __call__(self, *args, **kwargs):
+        if self._setup_data:
+            # Check if we have a specific setup for these arguments
+            frozen_kwargs = frozenset(kwargs.items()) if kwargs else frozenset()
+            exact_key = (args, frozen_kwargs)
+
+            # If we have a specific setup, return that
+            if exact_key in self._setup_data:
+                value = self._setup_data[exact_key]
+                if isinstance(value, Exception):
+                    raise value
+                return value
+            return None
+
+        # Otherwise, fall back to default MagicMock behavior
+        return super().__call__(*args, **kwargs)
+
+
+def pytest_configure(config):
+    # Replace MagicMock with our ExtendedMock
+    import unittest.mock
+
+    unittest.mock.MagicMock = ExtendedMock