panda-pytest-assertions 0.1.0__tar.gz

panda_pytest_assertions-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

panda_pytest_assertions-0.1.0/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: panda-pytest-assertions
+Version: 0.1.0
+Summary: Complex assertions that can be used when writing test with pytest
+Home-page: https://github.com/KRunchPL/panda-pytest-assertions
+License: Apache-2.0
+Author: Cyber Panda
+Author-email: krunchfrompoland@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pytest (>4.6.0)
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Project-URL: Documentation, https://github.com/KRunchPL/panda-pytest-assertions
+Project-URL: Repository, https://github.com/KRunchPL/panda-pytest-assertions
+Description-Content-Type: text/markdown
+
+# panda-pytest-assertions
+
+Complex assertions that can be used when writing test with pytest.
+
+See [documentation page](https://krunchpl.github.io/panda-pytest-assertions/).
+
+## Additional Documentation
+
+[Development documentation](README-DEV.md)
+
+[Changelog](CHANGELOG.md)
+

panda_pytest_assertions-0.1.0/README.md

@@ -0,0 +1,11 @@
+# panda-pytest-assertions
+
+Complex assertions that can be used when writing test with pytest.
+
+See [documentation page](https://krunchpl.github.io/panda-pytest-assertions/).
+
+## Additional Documentation
+
+[Development documentation](README-DEV.md)
+
+[Changelog](CHANGELOG.md)

panda_pytest_assertions-0.1.0/panda_pytest_assertions/assert_context/__init__.py

@@ -0,0 +1,15 @@
+# ruff: noqa: E402
+# isort: off
+import pytest
+
+pytest.register_assert_rewrite(__name__ + '._assert_context')
+# isort: on
+
+
+from ._assert_context import assert_context, AssertContext
+
+
+__all__ = [
+    'assert_context',
+    'AssertContext',
+]

panda_pytest_assertions-0.1.0/panda_pytest_assertions/assert_context/_assert_context.py

@@ -0,0 +1,128 @@
+from collections.abc import Generator
+from contextlib import contextmanager, ExitStack, nullcontext
+from typing import Any, overload
+
+import pytest
+
+
+class _Unset:
+    __instance: '_Unset | None' = None
+
+    def __new__(cls) -> '_Unset':
+        if cls.__instance is None:
+            cls.__instance = object.__new__(cls)
+        return cls.__instance
+
+
+_UNSET = _Unset()
+
+
+class AssertContext:
+    __slots__ = ('_result',)
+
+    def __init__(self) -> None:
+        self._result: Any = _UNSET
+
+    def set(self, value: Any) -> None:  # noqa: ANN401
+        self._result = value
+
+    @contextmanager
+    def assert_result_equal(self, expected_result: Any) -> Generator[None, None, None]:  # noqa: ANN401
+        yield
+        assert expected_result == self._result
+
+
+@overload
+@contextmanager
+def assert_context(  # noqa: D418
+    *,
+    exception: type[Exception] | _Unset = ...,
+    result: Any | _Unset = ...,  # noqa: ANN401
+) -> Generator[AssertContext, None, None]:
+    """
+    Context manager that makes sure `with` block behaved according to the arguments.
+
+    If the `exception` parameter is set, the `with` block is expected to raise an exception of provided type.
+    If it is NOT set, the `with` block is expected NOT TO raise any exceptions.
+
+    If the `result` parameter is set, its value is expected to be equal to `with` block result. The `with`
+    block result is set with the `set` method of an object yielded by the context manager. The comparison
+    is used with `==` operator, where `result` argument is on the left side.
+    If the `result` parameter is NOT set, the `set` method of yielded object is expected
+    not to be called at all.
+
+    :param exception: type of exception, expected to be raised
+    :param result: value expected to be set with `set` method of yielded object
+    """
+
+
+@overload
+@contextmanager
+def assert_context(  # noqa: D418
+    *,
+    behaviour: type[Exception] | Any | _Unset = ...,  # noqa: ANN401
+) -> Generator[AssertContext, None, None]:
+    """
+    Context manager that makes sure `with` block behaved according to the arguments.
+
+    Context manager yields a single object used that provides `set` method used to set the `with`
+    block result that is to be asserted.
+
+    If the `behaviour` parameter is set to an exception type, the `with` block is expected
+    to raise an exception of provided type and the `set` method of yielded object is expected
+    not to be called at all.
+
+    If the `behaviour` parameter is set to anything else, its value is expected to be equal to `with`
+    block result. The comparison is used with `==` operator, where `result` argument is on the left side and
+    the `with` block is expected to not raise any exceptions.
+
+    If the `behaviour` parameter is NOT set, the `with` block is expected NOT TO raise any exceptions and
+    the `set` method of yielded object is expected not to be called at all.
+
+    :param behaviour: describes expected behaviour of the `with` block
+    """
+
+
+@contextmanager
+def assert_context(
+    *,
+    exception: type[Exception] | _Unset = _UNSET,
+    result: Any | _Unset = _UNSET,
+    behaviour: type[Exception] | Any | _Unset = _UNSET,
+) -> Generator[AssertContext, None, None]:
+    """
+    Context manager that makes sure `with` block behaved according to the arguments.
+
+    Pair of parameters `exception` and `result` are exclusive with parameter `behaviour`. If `behaviour`
+    is set to an exception type, it is the same as if `exception` would be set to this value and `result`
+    would not be set. If `behaviour` is set to any other value, its treated as the value of `result` and the
+    `exception` remains unset.
+
+    If the `exception` parameter is set, the `with` block is expected to raise an exception of provided type.
+    If it is NOT set, the `with` block is expected NOT TO raise any exceptions.
+
+    If the `result` parameter is set, its value is expected to be equal to `with` block result. The `with`
+    block result is set with the `set` method of an object yielded by the context manager. The comparison
+    is used with `==` operator, where `result` argument is on the left side.
+    If the `result` parameter is NOT set, the `set` method of yielded object is expected
+    not to be called at all.
+
+    :param exception: type of exception, expected to be raised
+    :param result: value expected to be set with `set` method of yielded object
+    :param behaviour: a common name for `exception` and `result` parameters, exclusive to them
+    :yield: object used to set the result of a `with` block
+    """
+    if behaviour != _UNSET:
+        assert exception == _UNSET
+        assert result == _UNSET
+        if isinstance(behaviour, type) and issubclass(behaviour, Exception):
+            exception = behaviour
+        else:
+            result = behaviour
+    context = AssertContext()
+    exception_behaviour = nullcontext() if isinstance(exception, _Unset) else pytest.raises(exception)
+
+    with ExitStack() as behaviours_stack:
+        behaviours_stack.enter_context(context.assert_result_equal(result))
+        behaviours_stack.enter_context(exception_behaviour)
+        yield context

panda_pytest_assertions-0.1.0/panda_pytest_assertions/assert_object/__init__.py

@@ -0,0 +1,41 @@
+from ._assert_object import assert_object, Expectation
+from ._asserter_factories import AsserterFactory, BuiltInAsserterFactory
+from ._converters import (
+    expectation_from_yaml,
+    expectation_to_yaml,
+    ExpectationYamlDumper,
+    ExpectationYamlLoader,
+)
+from ._expectation_modificators import (
+    MappingSubset,
+    ObjectAttributes,
+    Stringified,
+    Unordered,
+    with_type,
+    WithType,
+)
+from ._objects_asserters import Asserter
+from ._protocols import AsserterFactoryProtocol, AsserterProtocol, GeneratorFactoryProtocol, GeneratorProtocol
+
+
+__all__ = [
+    'assert_object',
+    'Expectation',
+    'AsserterFactory',
+    'BuiltInAsserterFactory',
+    'expectation_to_yaml',
+    'expectation_from_yaml',
+    'ExpectationYamlDumper',
+    'ExpectationYamlLoader',
+    'MappingSubset',
+    'ObjectAttributes',
+    'Stringified',
+    'Unordered',
+    'with_type',
+    'WithType',
+    'Asserter',
+    'AsserterProtocol',
+    'AsserterFactoryProtocol',
+    'GeneratorFactoryProtocol',
+    'GeneratorProtocol',
+]

panda_pytest_assertions-0.1.0/panda_pytest_assertions/assert_object/_assert_object.py

@@ -0,0 +1,36 @@
+from typing import Any
+
+from ._asserter_factories import BuiltInAsserterFactory
+from ._protocols import AsserterFactoryProtocol
+
+
+def assert_object(
+    expectation: Any,  # noqa: ANN401
+    object_: Any,  # noqa: ANN401
+    *,
+    asserter_factory: type[AsserterFactoryProtocol] = BuiltInAsserterFactory,
+) -> None:
+    asserter = asserter_factory.create(expectation)
+    try:
+        asserter.assert_object(object_)
+    except AssertionError as exc:
+        msg = f'Object assertion failed. {exc!s}'
+        raise AssertionError(msg) from None
+
+
+class Expectation:
+    def __init__(
+        self,
+        expectation: Any,  # noqa: ANN401
+        *,
+        asserter_factory: type[AsserterFactoryProtocol] = BuiltInAsserterFactory,
+    ) -> None:
+        self.expectation = expectation
+        self.asserter_factory = asserter_factory
+
+    def __eq__(self, value: object) -> bool:
+        try:
+            assert_object(self.expectation, value, asserter_factory=self.asserter_factory)
+        except AssertionError:
+            return False
+        return True

panda_pytest_assertions-0.1.0/panda_pytest_assertions/assert_object/_asserter_factories/__init__.py

@@ -0,0 +1,8 @@
+from .asserter_factory import AsserterFactory
+from .built_in_asserter_factory import BuiltInAsserterFactory
+
+
+__all__ = [
+    'AsserterFactory',
+    'BuiltInAsserterFactory',
+]

panda_pytest_assertions-0.1.0/panda_pytest_assertions/assert_object/_asserter_factories/asserter_factory.py

@@ -0,0 +1,66 @@
+from collections import deque
+from typing import Any, ClassVar
+
+from panda_pytest_assertions.assert_object._protocols import AsserterProtocol
+
+
+class AsserterFactory:
+    """
+    Factory for registered asserters.
+    """
+
+    #: list of registered asserter classes
+    _ASSERTER_TYPES: ClassVar[deque[type[AsserterProtocol]]] = deque()
+
+    @classmethod
+    def create(cls, expectation: Any) -> AsserterProtocol:  # noqa: ANN401
+        """
+        Create asserter object for given expectation.
+
+        The function goes through all registered asserter types and creates the first one that matches.
+
+        :param expectation: expectation to create asserter for
+        :return: created asserter
+        """
+        for asserter_type in cls._ASSERTER_TYPES:
+            if asserter_type.matches(expectation):
+                return asserter_type(cls, expectation)
+        msg = (
+            f'None of the registered asserters matches expectation "{expectation}" '
+            f'of type "{type(expectation)}".'
+        )
+        raise ValueError(msg)
+
+    @classmethod
+    def register_asserter(
+        cls,
+        asserter: type[AsserterProtocol],
+        *,
+        after: type[AsserterProtocol] | None = None,
+        before: type[AsserterProtocol] | None = None,
+    ) -> None:
+        """
+        Register the provided asserter to be used.
+
+        The asserter is registered at the earliest possible position. If `after` and `before`
+        parameters are not set, it is registered at the beginning of the list to be matched
+        when creating asserter for expectations.
+
+        :param asserter: asserter to be registered
+        :param after: registered asserter must be matched after this one
+        :param before: registered asserter must be matched before this one
+        """
+        if '_ASSERTER_TYPES' not in cls.__dict__:
+            cls._ASSERTER_TYPES = cls._ASSERTER_TYPES.copy()
+
+        after_position = cls._ASSERTER_TYPES.index(after) if after is not None else -1
+        before_position = (
+            cls._ASSERTER_TYPES.index(before) if before is not None else len(cls._ASSERTER_TYPES) + 1
+        )
+        if after_position >= before_position:
+            msg = (
+                f'Cannot register asserter between "{after}" and "{before}" as their '
+                f'respective positions are: "{after_position}" and "{before_position}"'
+            )
+            raise ValueError(msg)
+        cls._ASSERTER_TYPES.insert(after_position + 1, asserter)

panda_pytest_assertions-0.1.0/panda_pytest_assertions/assert_object/_asserter_factories/built_in_asserter_factory.py

@@ -0,0 +1,29 @@
+from panda_pytest_assertions.assert_object._objects_asserters import (
+    EqualityAsserter,
+    MappingAsserter,
+    MappingSubsetAsserter,
+    ObjectAttributesAsserter,
+    OrderedElementsAsserter,
+    StringifiedAsserter,
+    UnorderedElementsAsserter,
+    WithTypeAsserter,
+)
+
+from .asserter_factory import AsserterFactory
+
+
+class BuiltInAsserterFactory(AsserterFactory):
+    """
+    Factory that has all built-in asserters registered.
+    """
+
+
+# MUST be the first one as it implements a fallback mechanism and matches everything
+BuiltInAsserterFactory.register_asserter(EqualityAsserter)
+BuiltInAsserterFactory.register_asserter(MappingAsserter)
+BuiltInAsserterFactory.register_asserter(MappingSubsetAsserter)
+BuiltInAsserterFactory.register_asserter(ObjectAttributesAsserter)
+BuiltInAsserterFactory.register_asserter(OrderedElementsAsserter)
+BuiltInAsserterFactory.register_asserter(StringifiedAsserter)
+BuiltInAsserterFactory.register_asserter(UnorderedElementsAsserter)
+BuiltInAsserterFactory.register_asserter(WithTypeAsserter)

panda_pytest_assertions-0.1.0/panda_pytest_assertions/assert_object/_converters/__init__.py

@@ -0,0 +1,10 @@
+from .expectation_from_yaml import expectation_from_yaml, ExpectationYamlLoader
+from .expectation_to_yaml import expectation_to_yaml, ExpectationYamlDumper
+
+
+__all__ = [
+    'expectation_from_yaml',
+    'ExpectationYamlLoader',
+    'expectation_to_yaml',
+    'ExpectationYamlDumper',
+]