flexmock 0.12.2__py3-none-any.whl

flexmock/_integrations.py

@@ -0,0 +1,184 @@
+"""Flexmock test runner integrations."""
+
+# pylint: disable=import-outside-toplevel, import-error
+import sys
+import unittest
+from contextlib import suppress
+from functools import wraps
+from typing import Any, Type
+
+from flexmock._api import flexmock_teardown
+
+
+def _patch_test_result(klass: Type[Any]) -> None:
+    """Patches flexmock into any class that inherits unittest.TestResult.
+
+    This seems to work well for majority of test runners. In the case of nose
+    it's not even necessary as it doesn't override unittest.TestResults's
+    addSuccess and addFailure methods so simply patching unittest works
+    out of the box for nose.
+
+    For those that do inherit from unittest.TestResult and override its
+    stopTest and addSuccess methods, patching is pretty straightforward
+    (numerous examples below).
+
+    The reason we don't simply patch unittest's parent TestResult class
+    is stopTest and addSuccess in the child classes tend to add messages
+    into the output that we want to override in case flexmock generates
+    its own failures.
+
+    Args:
+        klass: the class whose stopTest method needs to be decorated.
+    """
+    # pylint: disable=invalid-name
+    _patch_stop_test(klass)
+    _patch_add_success(klass)
+
+
+def _patch_stop_test(klass: Type[unittest.TextTestResult]) -> None:
+    """Patch TextTestResult class stopTest method and add call to flexmock
+    teardown.
+
+    If the test failed already before flexmock teardown, nothing is done.
+    However if the test was successful before flexmock teardown and flexmock
+    assertions fail, flexmock updates the test result to failed by calling
+    addFailure method.
+
+    Args:
+        klass: the class whose stopTest method needs to be decorated.
+    """
+    saved_add_success = klass.addSuccess
+    saved_stop_test = klass.stopTest
+
+    @wraps(saved_stop_test)
+    def decorated(self: unittest.TextTestResult, test: unittest.TestCase) -> None:
+        if saved_stop_test.__code__ is not decorated.__code__:  # type: ignore [attr-defined]
+            # if parent class was for some reason patched, avoid calling
+            # flexmock_teardown() twice and delegate up the class hierarchy
+            # this doesn't help if there is a gap and only the parent's
+            # parent class was patched, but should cover most screw-ups
+            try:
+                flexmock_teardown()
+                saved_add_success(self, test)
+            except Exception:
+                if hasattr(self, "_pre_flexmock_success"):
+                    self.addFailure(test, sys.exc_info())
+            if hasattr(self, "_pre_flexmock_success"):
+                del self._pre_flexmock_success
+        return saved_stop_test(self, test)
+
+    if klass.stopTest is not decorated:
+        klass.stopTest = decorated  # type: ignore
+
+
+def _patch_add_success(klass: Type[unittest.TextTestResult]) -> None:
+    """Patch the addSuccess method of the TextTestResult class.
+
+    TextTestResult addSuccess method is replaced and the original addSuccess
+    method is called after flexmock teardown patched stopTest method.
+
+    An attribute is set in the replaced addSuccess method to indicate if the
+    test was successful before flexmock teardown was called.
+
+    Args:
+        klass: the class whose addSuccess method needs to be decorated.
+    """
+
+    @wraps(klass.addSuccess)
+    def decorated(self: unittest.TextTestResult, _test: unittest.TestCase, **_kwargs: Any) -> None:
+        self._pre_flexmock_success = True  # type: ignore
+
+    if klass.addSuccess is not decorated:
+        klass.addSuccess = decorated  # type: ignore
+
+
+# Hook flexmock into doctest.
+
+with suppress(ImportError):
+    from doctest import DocTestRunner, TestResults
+
+    saved_doctest = DocTestRunner.run
+
+    @wraps(saved_doctest)
+    def run(
+        *args: Any,
+        **kwargs: Any,
+    ) -> TestResults:
+        """Call the teardown at the end of the tests.
+
+        Args:
+            args: the arguments passed to the runner
+            kwargs: the keyword arguments passed to the runner
+
+        Returns:
+            The test results
+
+        """
+        try:
+            return saved_doctest(*args, **kwargs)
+        finally:
+            flexmock_teardown()
+
+    DocTestRunner.run = run  # type: ignore
+
+
+# Hook flexmock into unittest.
+# only valid TestResult class for unittest is TextTestResult
+_patch_test_result(unittest.TextTestResult)
+
+
+# Hook into Teamcity unittests.
+# This allows flexmock to be used within PyCharm.
+with suppress(ImportError):
+    from teamcity.unittestpy import TeamcityTestResult
+
+    _patch_test_result(TeamcityTestResult)
+
+
+# Hook into teststools.
+# testtools is a set of extensions to the Python standard library's unit testing framework:
+# https://github.com/testing-cabal/testtools
+
+with suppress(ImportError):
+    from testtools import testresult
+
+    _patch_test_result(testresult.TestResult)
+
+
+# Hook into Zope testrunner.
+# Zope is an open-source web application server:
+# https://github.com/zopefoundation/Zope
+
+with suppress(ImportError):
+    from zope import testrunner  # pylint: disable=no-name-in-module
+
+    try:
+        _patch_test_result(testrunner.runner.TestResult)
+    except AttributeError:
+        # testrunner.runner is only available when tests are executed with zope.testrunner
+        pass
+
+
+# Hook into subunit.
+# Subunit is a test reporting and controlling protocol.
+# https://github.com/testing-cabal/subunit
+
+with suppress(ImportError):
+    import subunit
+
+    _patch_test_result(subunit.TestProtocolClient)
+    with suppress(AttributeError):
+        _patch_test_result(subunit.test_results.TestResultDecorator)
+
+
+# Hook into twisted.
+# Twisted is an event-based framework for internet applications:
+# https://github.com/twisted/twisted
+
+with suppress(ImportError):
+    from twisted.trial import reporter
+
+    _patch_test_result(reporter.MinimalReporter)
+    _patch_test_result(reporter.TextReporter)
+    _patch_test_result(reporter.VerboseTextReporter)
+    _patch_test_result(reporter.TreeReporter)

flexmock/_pytest_plugin.py

@@ -0,0 +1,36 @@
+"""Hook flexmock into Pytest.
+Pytest is a Python test framework:
+https://github.com/pytest-dev/pytest
+"""
+
+from typing import Generator, Optional
+
+import pytest
+from _pytest.runner import CallInfo, ExceptionInfo, Item, TestReport
+
+from flexmock._api import flexmock_teardown
+
+
+@pytest.hookimpl(hookwrapper=True)
+def pytest_runtest_makereport(
+    item: Item,  # pylint: disable=unused-argument
+    call: CallInfo[None],
+) -> Generator[None, None, None]:
+    """Called to verify and tear down the mocks set up by flexmock.
+
+    Args:
+        item: Test item for which the hook is being called.
+        call: Information about the current call phase.
+
+    Yields:
+        Control back to the pytest runner.
+    """
+    if call.when == "call":
+        try:
+            flexmock_teardown()
+        except BaseException:  # pylint: disable=broad-except
+            call.excinfo = call.excinfo or ExceptionInfo.from_current()
+    elif call.when == "teardown":
+        flexmock_teardown()
+
+    _test_report: Optional[TestReport] = yield

flexmock/exceptions.py

@@ -0,0 +1,33 @@
+"""Flexmock exceptions."""
+
+
+class FlexmockError(Exception):
+    """FlexmockError"""
+
+
+class MockBuiltinError(Exception):
+    """MockBuiltinError"""
+
+
+class MethodSignatureError(FlexmockError):
+    """MethodSignatureError"""
+
+
+class ExceptionClassError(FlexmockError):
+    """ExceptionClassError"""
+
+
+class ExceptionMessageError(FlexmockError):
+    """ExceptionMessageError"""
+
+
+class StateError(FlexmockError):
+    """StateError"""
+
+
+class MethodCallError(FlexmockError):
+    """MethodCallError"""
+
+
+class CallOrderError(FlexmockError):
+    """CallOrderError"""

flexmock-0.12.2.dist-info/LICENSE

@@ -0,0 +1,26 @@
+Copyright 2011-2015 Herman Sheremetyev, Slavek Kabrda.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies,
+either expressed or implied, of the FreeBSD Project.

flexmock-0.12.2.dist-info/METADATA

@@ -0,0 +1,130 @@
+Metadata-Version: 2.1
+Name: flexmock
+Version: 0.12.2
+Summary: flexmock is a testing library for Python that makes it easy to create mocks, stubs and fakes.
+Home-page: https://github.com/flexmock/flexmock
+License: BSD-2-Clause
+Keywords: mock,testing,test,unittest,pytest
+Author: Slavek Kabrda
+Maintainer: Adarsh Krishnan
+Maintainer-email: adarshk7@gmail.com
+Requires-Python: >=3.8.0,<4.0.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Testing :: Mocking
+Classifier: Topic :: Software Development :: Testing :: Unit
+Classifier: Typing :: Typed
+Project-URL: Changes, https://flexmock.readthedocs.io/en/latest/changelog/
+Project-URL: Documentation, https://flexmock.readthedocs.io
+Project-URL: Issue Tracker, https://github.com/flexmock/flexmock/issues
+Project-URL: Repository, https://github.com/flexmock/flexmock
+Project-URL: Source Code, https://github.com/flexmock/flexmock
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img alt="banner" src="https://user-images.githubusercontent.com/25169984/138661460-969caf9e-8e88-4609-87c4-1a0ab9624ee4.png">
+</p>
+
+<p align="center"><strong>flexmock</strong> <em>- Mock, stub, and spy library for Python.</em></p>
+
+<p align="center">
+<a href="https://pypi.org/project/flexmock/">
+  <img src="https://img.shields.io/pypi/v/flexmock" alt="pypi">
+</a>
+<a href="https://github.com/flexmock/flexmock/actions/workflows/ci.yml">
+  <img src="https://github.com/flexmock/flexmock/actions/workflows/ci.yml/badge.svg" alt="ci">
+</a>
+<a href="https://flexmock.readthedocs.io/">
+  <img src="https://img.shields.io/readthedocs/flexmock" alt="documentation">
+</a>
+<a href="https://codecov.io/gh/flexmock/flexmock">
+  <img src="https://codecov.io/gh/flexmock/flexmock/branch/master/graph/badge.svg?token=wRgtiGxhiL" alt="codecov">
+</a>
+<a href="./LICENSE">
+  <img src="https://img.shields.io/pypi/l/flexmock" alt="license">
+</a>
+</p>
+
+---
+
+Flexmock is a testing library for Python that makes it easy to create mocks, stubs, and fakes.
+
+## Features
+
+- **Mock**: Easily create mock objects and make assertions about which methods or attributes were used and arguments they were called with.
+- **Spy**: Proxy calls to object's original methods or attributes and make assertions based on return values or call count.
+- **Fake**: Generate a fake objects to be used in your tests with ease.
+- **Stub**: Create stub objects which replace parts of existing objects and classes with just one call.
+- **No external dependencies**: Flexmock is lightweight and only uses Python standard library. There are no external dependencies.
+- **Simple and intuitive**: Declarations are structured to read more like English sentences than API calls, so they are easy to learn and use.
+- **Fully type annotated**: External API is fully type annotated so it works great with static analysis tools and editor auto-completion.
+- **Integrations with test runners**: Integrates seamlessly with all major test runners like unittest, doctest, and pytest.
+- **Python 3.8+ and PyPy3**: Extensively tested to work with latest Python versions.
+
+## Installation
+
+Install with pip:
+
+```
+pip install flexmock
+```
+
+## Examples
+
+Flexmock features smooth integration with pretty much every popular test runner, so no special setup is necessary. Simply importing flexmock into your test module is sufficient to get started with any of the following examples:
+
+```python
+from flexmock import flexmock
+```
+
+### Mocks
+
+Assertions take many flavors and flexmock has many different facilities to generate them:
+
+```python
+# Simplest is ensuring that a certain method is called
+flexmock(Train).should_receive("get_tickets").once()
+
+# Of course, it is also possible to provide a default return value
+flexmock(Train).should_receive("get_destination").and_return("Paris").once()
+
+# Or check that a method is called with specific arguments
+flexmock(Train).should_receive("set_destination").with_args("Seoul").at_least().twice()
+```
+
+### Spies
+
+Instead of mocking, there are also times when you want to execute the actual method and simply find out how many times it was called. Flexmock uses `should_call` to generate this sort of assertions instead of `should_receive`:
+
+```python
+# Verify that a method is called at most three times
+flexmock(Train).should_call("get_tickets").at_most().times(3)
+
+# Make sure that a method is never called with specific arguments
+flexmock(Train).should_call("set_destination").with_args("Helsinki").never()
+
+# More complex example with features like argument type and exception matching
+flexmock(Train).should_call("crash").with_args(str, int).and_raise(AttributeError).once()
+```
+
+See more examples in the documentation.
+
+## Documentation
+
+User guide, examples, and a full API reference is available at: https://flexmock.readthedocs.io
+
+## Contributing
+
+Contributions are absolutely welcome and encouraged! See [CONTRIBUTING.md](https://github.com/flexmock/flexmock/blob/master/CONTRIBUTING.md) to get started.
+

flexmock-0.12.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+flexmock/__init__.py,sha256=s_lmZTsOuFGTcSRr1EZW3nhMyNTapalTiPzJQWYfgN8,228
+flexmock/_api.py,sha256=J-FzuVg6alXJVN6AdbSIsn_EvzK10kynG79E9AO361Y,61049
+flexmock/_integrations.py,sha256=RyRxBqtEv8akylGFVh_hn2Irh_lgtJuqaULnpcTcDtE,6007
+flexmock/_pytest_plugin.py,sha256=Jc6H81iZR787DCIAwYPel5swWeANZ_zwn1vEiRM54Ek,1030
+flexmock/exceptions.py,sha256=N4nOPY25yc-VUbOrx1pigzf0dXpfH7kHCpyaVR3bh_Y,563
+flexmock/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flexmock-0.12.2.dist-info/LICENSE,sha256=JkR6IDOxBjK60IMwDVGo6dC6fx71CYXIgb4ovX-qgqY,1534
+flexmock-0.12.2.dist-info/METADATA,sha256=5f9kPi9_0d4WFFnBi7QudpMPCFJQJcsT9q1NkzGA_5A,5615
+flexmock-0.12.2.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+flexmock-0.12.2.dist-info/entry_points.txt,sha256=QPIoN9FjtXL4VToIFHSVh_8_6k_IhxnnGCGOO7JaW6E,45
+flexmock-0.12.2.dist-info/RECORD,,

flexmock-0.12.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any

flexmock-0.12.2.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[pytest11]
+flexmock=flexmock._pytest_plugin
+