Core API¶
BaseDescription¶
-
class
hamcrest.core.base_description.BaseDescription¶ Bases:
hamcrest.core.description.DescriptionBase class for all
Descriptionimplementations.-
append(string)¶ Append the string to the description.
-
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
-
append_list(start, separator, end, list)¶ Appends a list of objects to the description.
- Parameters
start – String that will begin the list description.
separator – String that will separate each object in the description.
end – String that will end the list description.
list – List of objects to be described.
- Returns
self, for chaining
-
append_text(text)¶ Appends some plain text to the description.
- Returns
self, for chaining
-
append_value(value)¶ Appends an arbitary value to the description.
Deprecated: Call
append_description_ofinstead.- Returns
self, for chaining
-
BaseMatcher¶
-
class
hamcrest.core.base_matcher.BaseMatcher¶ Bases:
hamcrest.core.matcher.MatcherBase class for all
Matcherimplementations.Most implementations can just implement
_matches, leaving the handling of any mismatch description to thematchesmethod. But if it makes more sense to generate the mismatch description during the matching, overridematchesinstead.-
_matches(item)¶
-
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 – The item that the
Matcherhas rejected.mismatch_description – The description to be built or appended to.
-
matches(item, mismatch_description=None)¶ Evaluates the matcher for argument item.
If a mismatch is detected and argument
mismatch_descriptionis provided, it will generate a description of why the matcher has not accepted the item.- Parameters
item – The object against which the matcher is evaluated.
- Returns
Trueifitemmatches, otherwiseFalse.
-
Description¶
-
class
hamcrest.core.description.Description¶ Bases:
objectA description of a
Matcher.A
Matcherwill 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
-
append_list(start, separator, end, list)¶ Appends a list of objects to the description.
- Parameters
start – String that will begin the list description.
separator – String that will separate each object in the description.
end – String that will end the list description.
list – List of objects to be described.
- Returns
self, for chaining
-
append_text(text)¶ Appends some plain text to the description.
- Returns
self, for chaining
-
append_value(value)¶ Appends an arbitary value to the description.
Deprecated: Call
append_description_ofinstead.- Returns
self, for chaining
-
Matcher¶
-
class
hamcrest.core.matcher.Matcher¶ Bases:
hamcrest.core.selfdescribing.SelfDescribingA 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
BaseMatcherclass, which will ensure that theMatcherAPI can grow to support new features and remain compatible with allMatcherimplementations.-
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 – The item that the
Matcherhas rejected.mismatch_description – The description to be built or appended to.
-
matches(item, mismatch_description=None)¶ Evaluates the matcher for argument item.
If a mismatch is detected and argument
mismatch_descriptionis provided, it will generate a description of why the matcher has not accepted the item.- Parameters
item – The object against which the matcher is evaluated.
- Returns
Trueifitemmatches, otherwiseFalse.
-
SelfDescribing¶
-
class
hamcrest.core.selfdescribing.SelfDescribing¶ Bases:
objectThe 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 – The description to be built or appended to.
-
SelfDescribingValue¶
-
class
hamcrest.core.selfdescribingvalue.SelfDescribingValue(value)¶ Bases:
hamcrest.core.selfdescribing.SelfDescribingWrap any value in a
SelfDescribingValueto satisfy theSelfDescribinginterface.Deprecated: No need for this class now that
append_description_ofhandles any type of value.-
describe_to(description)¶ Generates a description of the value.
-
StringDescription¶
-
class
hamcrest.core.string_description.StringDescription¶ Bases:
hamcrest.core.base_description.BaseDescriptionA
Descriptionthat is stored as a string.-
append(string)¶ Append the string to the description.
-
-
hamcrest.core.string_description.tostring(selfdescribing)¶ Returns the description of a
SelfDescribingobject as a string.- Parameters
selfdescribing – The object to be described.
- Returns
The description of the object.