Sequence Matchers¶
Matchers of sequences.
contains¶
-
hamcrest.library.collection.issequence_containinginorder.
contains
(match1[, match2[, ...]])¶ Matches if sequence’s elements satisfy a given list of matchers, in order.
Parameters: match1,... – A comma-separated list of matchers. This matcher iterates the evaluated sequence and a given list of matchers, seeing if each element satisfies its corresponding matcher.
Any argument that is not a matcher is implicitly wrapped in an
equal_to
matcher to check for equality.
contains_inanyorder¶
-
hamcrest.library.collection.issequence_containinginanyorder.
contains_inanyorder
(match1[, match2[, ...]])¶ Matches if sequences’s elements, in any order, satisfy a given list of matchers.
Parameters: match1,... – A comma-separated list of matchers. This matcher iterates the evaluated sequence, seeing if each element satisfies any of the given matchers. The matchers are tried from left to right, and when a satisfied matcher is found, it is no longer a candidate for the remaining elements. If a one-to-one correspondence is established between elements and matchers,
contains_inanyorder
is satisfied.Any argument that is not a matcher is implicitly wrapped in an
equal_to
matcher to check for equality.
has_item, has_items¶
-
hamcrest.library.collection.issequence_containing.
has_item
(match)¶ Matches if any element of sequence satisfies a given matcher.
Parameters: match – The matcher to satisfy, or an expected value for 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 anequal_to
matcher to check for equality.
-
hamcrest.library.collection.issequence_containing.
has_items
(match1[, match2[, ...]])¶ Matches if all of the given matchers are satisfied by any elements of the sequence.
Parameters: 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
equal_to
matcher to check for equality.
is_in¶
-
hamcrest.library.collection.isin.
is_in
(sequence)¶ Matches if evaluated object is present in a given sequence.
Parameters: sequence – The sequence to search. This matcher invokes the
in
membership operator to determine if the evaluated object is a member of the sequence.
only_contains¶
-
hamcrest.library.collection.issequence_onlycontaining.
only_contains
(match1[, match2[, ...]])¶ Matches if each element of sequence satisfies any of the given matchers.
Parameters: match1,... – A comma-separated list of matchers. This matcher iterates the evaluated sequence, confirming whether each element satisfies any of the given matchers.
Example:
only_contains(less_than(4))
will match
[3,1,2]
.Any argument that is not a matcher is implicitly wrapped in an
equal_to
matcher to check for equality.