<filename>Lib/site-packages/hamcrest/library/integration/match_equality.py
from typing import Any

from hamcrest.core.helpers.wrap_matcher import wrap_matcher
from hamcrest.core.matcher import Matcher
from hamcrest.core.string_description import tostring

__author__ = "<NAME>"
__copyright__ = "Copyright 2011 hamcrest.org"
__license__ = "BSD, see License.txt"
__unittest = True


class EqualityWrapper(object):
    def __init__(self, matcher: Matcher) -> None:
        self.matcher = matcher

    def __eq__(self, obj: Any) -> bool:
        return self.matcher.matches(obj)

    def __str__(self) -> str:
        return repr(self)

    def __repr__(self) -> str:
        return tostring(self.matcher)


def match_equality(matcher: Matcher) -> EqualityWrapper:
    """Wraps a matcher to define equality in terms of satisfying the matcher.

    ``match_equality`` allows Hamcrest matchers to be used in libraries that
    are not Hamcrest-aware. They might use the equality operator::

        assert match_equality(matcher) == object

    Or they might provide a method that uses equality for its test::

        library.method_that_tests_eq(match_equality(matcher))

    One concrete example is integrating with the ``assert_called_with`` methods
    in Michael Foord's `mock <http://www.voidspace.org.uk/python/mock/>`_
    library.

    """
    return EqualityWrapper(wrap_matcher(matcher))
