Core API¶
BaseDescription¶
- class hamcrest.core.base_description.BaseDescription¶
Bases:
Description
Base class for all
Description
implementations.- append_description_of(value)¶
Appends description of given value to this description.
If the value implements
describe_to
, then it will be used.- Returns:
self
, for chaining- Parameters:
value (Any) –
- Return type:
- append_list(start, separator, end, list)¶
Appends a list of objects to the description.
- Parameters:
- Returns:
self
, for chaining- Return type:
BaseMatcher¶
- class hamcrest.core.base_matcher.BaseMatcher¶
Bases:
Matcher
[T
]Base class for all
Matcher
implementations.Most implementations can just implement
_matches
, leaving the handling of any mismatch description to thematches
method. But if it makes more sense to generate the mismatch description during the matching, overridematches
instead.- describe_match(item, match_description)¶
Generates a description of why the matcher has accepted the item.
The description may be part of a larger description of why a matching failed, so it should be concise.
This method assumes that
matches(item)
isTrue
, but will not check this.- Parameters:
item (T) – The item that the
Matcher
has accepted.match_description (Description) – The description to be built or appended to.
- Return type:
None
- describe_mismatch(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)
isFalse
, but will not check this.- Parameters:
item (T) – The item that the
Matcher
has rejected.mismatch_description (Description) – The description to be built or appended to.
- Return type:
None
- matches(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.- Parameters:
item (T) – The object against which the matcher is evaluated.
mismatch_description (Optional[Description]) –
- Returns:
True
ifitem
matches, otherwiseFalse
.- Return type:
Description¶
- class hamcrest.core.description.Description¶
Bases:
object
A description of a
Matcher
.A
Matcher
will describe itself to a description which can later be used for reporting.- append_description_of(value)¶
Appends description of given value to this description.
If the value implements
describe_to
, then it will be used.- Returns:
self
, for chaining- Parameters:
value (Any) –
- Return type:
- append_list(start, separator, end, list)¶
Appends a list of objects to the description.
- Parameters:
- Returns:
self
, for chaining- Return type:
Matcher¶
- class hamcrest.core.matcher.Matcher¶
Bases:
Generic
[T
],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
BaseMatcher
class, which will ensure that theMatcher
API can grow to support new features and remain compatible with allMatcher
implementations.- describe_match(item, match_description)¶
Generates a description of why the matcher has accepted the item.
The description may be part of a larger description of why a matching failed, so it should be concise.
This method assumes that
matches(item)
isTrue
, but will not check this.- Parameters:
item (T) – The item that the
Matcher
has accepted.match_description (Description) – The description to be built or appended to.
- Return type:
None
- describe_mismatch(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)
isFalse
, but will not check this.- Parameters:
item (T) – The item that the
Matcher
has rejected.mismatch_description (Description) – The description to be built or appended to.
- Return type:
None
- matches(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.- Parameters:
item (T) – The object against which the matcher is evaluated.
mismatch_description (Optional[Description]) –
- Returns:
True
ifitem
matches, otherwiseFalse
.- Return type:
SelfDescribing¶
- class hamcrest.core.selfdescribing.SelfDescribing¶
Bases:
object
The ability of an object to describe itself.
- describe_to(description)¶
Generates a description of the object.
The description may be part of a description of a larger object of which this is just a component, so it should be worded appropriately.
- Parameters:
description (Description) – The description to be built or appended to.
- Return type:
None
SelfDescribingValue¶
- class hamcrest.core.selfdescribingvalue.SelfDescribingValue(value)¶
Bases:
SelfDescribing
Wrap any value in a
SelfDescribingValue
to satisfy theSelfDescribing
interface.Deprecated: No need for this class now that
append_description_of
handles any type of value.- Parameters:
value (Any) –
- describe_to(description)¶
Generates a description of the value.
- Parameters:
description (Description) –
- Return type:
None
StringDescription¶
- class hamcrest.core.string_description.StringDescription¶
Bases:
BaseDescription
A
Description
that is stored as a string.
- hamcrest.core.string_description.tostring(selfdescribing)¶
Returns the description of a
SelfDescribing
object as a string.- Parameters:
selfdescribing (SelfDescribing) – The object to be described.
- Returns:
The description of the object.
- Return type: