summaryrefslogtreecommitdiffstats
path: root/contrib/python/PyHamcrest/py3/hamcrest/core/matcher.py
diff options
context:
space:
mode:
authornkozlovskiy <[email protected]>2023-09-29 12:24:06 +0300
committernkozlovskiy <[email protected]>2023-09-29 12:41:34 +0300
commite0e3e1717e3d33762ce61950504f9637a6e669ed (patch)
treebca3ff6939b10ed60c3d5c12439963a1146b9711 /contrib/python/PyHamcrest/py3/hamcrest/core/matcher.py
parent38f2c5852db84c7b4d83adfcb009eb61541d1ccd (diff)
add ydb deps
Diffstat (limited to 'contrib/python/PyHamcrest/py3/hamcrest/core/matcher.py')
-rw-r--r--contrib/python/PyHamcrest/py3/hamcrest/core/matcher.py52
1 files changed, 52 insertions, 0 deletions
diff --git a/contrib/python/PyHamcrest/py3/hamcrest/core/matcher.py b/contrib/python/PyHamcrest/py3/hamcrest/core/matcher.py
new file mode 100644
index 00000000000..81ee27c6d9d
--- /dev/null
+++ b/contrib/python/PyHamcrest/py3/hamcrest/core/matcher.py
@@ -0,0 +1,52 @@
+from __future__ import absolute_import
+from .selfdescribing import SelfDescribing
+
+__author__ = "Jon Reid"
+__copyright__ = "Copyright 2011 hamcrest.org"
+__license__ = "BSD, see License.txt"
+
+
+class Matcher(SelfDescribing):
+ """A matcher over acceptable values.
+
+ A matcher is able to describe itself to give feedback when it fails.
+
+ Matcher implementations should *not* directly implement this protocol.
+ Instead, *extend* the :py:class:`~hamcrest.core.base_matcher.BaseMatcher`
+ class, which will ensure that the
+ :py:class:`~hamcrest.core.matcher.Matcher` API can grow to support new
+ features and remain compatible with all
+ :py:class:`~hamcrest.core.matcher.Matcher` implementations.
+
+ """
+
+ def matches(self, item, mismatch_description=None):
+ """Evaluates the matcher for argument item.
+
+ If a mismatch is detected and argument ``mismatch_description`` is
+ provided, it will generate a description of why the matcher has not
+ accepted the item.
+
+ :param item: The object against which the matcher is evaluated.
+ :returns: ``True`` if ``item`` matches, otherwise ``False``.
+
+ """
+ raise NotImplementedError('matches')
+
+ def describe_mismatch(self, item, mismatch_description):
+ """Generates a description of why the matcher has not accepted the
+ item.
+
+ The description will be part of a larger description of why a matching
+ failed, so it should be concise.
+
+ This method assumes that ``matches(item)`` is ``False``, but will not
+ check this.
+
+ :param item: The item that the
+ :py:class:`~hamcrest.core.matcher.Matcher` has rejected.
+ :param mismatch_description: The description to be built or appended
+ to.
+
+ """
+ raise NotImplementedError('describe_mismatch')