Viewing file:  issequence_containing.py (3.35 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
from typing import Sequence, TypeVar, Union, cast
from hamcrest.core.base_matcher import BaseMatcher
from hamcrest.core.core.allof import all_of
from hamcrest.core.description import Description
from hamcrest.core.helpers.wrap_matcher import wrap_matcher
from hamcrest.core.matcher import Matcher
__author__ = "Jon Reid"
__copyright__ = "Copyright 2011 hamcrest.org"
__license__ = "BSD, see License.txt"
T = TypeVar("T")
class IsSequenceContaining(BaseMatcher[Sequence[T]]):
def __init__(self, element_matcher: Matcher[T]) -> None:
self.element_matcher = element_matcher
def _matches(self, item: Sequence[T]) -> bool:
try:
for element in item:
if self.element_matcher.matches(element):
return True
except TypeError: # not a sequence
pass
return False
def describe_to(self, description: Description) -> None:
description.append_text("a sequence containing ").append_description_of(
self.element_matcher
)
# It'd be great to make use of all_of, but we can't be sure we won't
# be seeing a one-time sequence here (like a generator); see issue #20
# Instead, we wrap it inside a class that will convert the sequence into
# a concrete list and then hand it off to the all_of matcher.
class IsSequenceContainingEvery(BaseMatcher[Sequence[T]]):
def __init__(self, *element_matchers: Matcher[T]) -> None:
delegates = [cast(Matcher[Sequence[T]], has_item(e)) for e in element_matchers]
self.matcher = all_of(*delegates) # type: Matcher[Sequence[T]]
def _matches(self, item: Sequence[T]) -> bool:
try:
return self.matcher.matches(list(item))
except TypeError:
return False
def describe_mismatch(self, item: Sequence[T], mismatch_description: Description) -> None:
self.matcher.describe_mismatch(item, mismatch_description)
def describe_to(self, description: Description) -> None:
self.matcher.describe_to(description)
def has_item(match: Union[Matcher[T], T]) -> Matcher[Sequence[T]]:
"""Matches if any element of sequence satisfies a given matcher.
:param match: The matcher to satisfy, or an expected value for
:py:func:`~hamcrest.core.core.isequal.equal_to` matching.
This matcher iterates the evaluated sequence, searching for any element
that satisfies a given matcher. If a matching element is found,
``has_item`` is satisfied.
If the ``match`` argument is not a matcher, it is implicitly wrapped in an
:py:func:`~hamcrest.core.core.isequal.equal_to` matcher to check for
equality.
"""
return IsSequenceContaining(wrap_matcher(match))
def has_items(*items: Union[Matcher[T], T]) -> Matcher[Sequence[T]]:
"""Matches if all of the given matchers are satisfied by any elements of
the sequence.
:param match1,...: A comma-separated list of matchers.
This matcher iterates the given matchers, searching for any elements in the
evaluated sequence that satisfy them. If each matcher is satisfied, then
``has_items`` is satisfied.
Any argument that is not a matcher is implicitly wrapped in an
:py:func:`~hamcrest.core.core.isequal.equal_to` matcher to check for
equality.
"""
matchers = []
for item in items:
matchers.append(wrap_matcher(item))
return IsSequenceContainingEvery(*matchers)
|