Matchers that inspect objects.
Matches if object is equal to a given object.
Parameters: | obj – The object to compare against as the expected value. |
---|
This matcher compares the evaluated object to obj for equality.
Matches if len(item) satisfies a given matcher.
Parameters: | match – The matcher to satisfy, or an expected value for equal_to matching. |
---|
This matcher invokes the len function on the evaluated object to get its length, passing the result to a given matcher for evaluation.
If the match argument is not a matcher, it is implicitly wrapped in an equal_to matcher to check for :equality.
Examples:
has_length(greater_than(6))
has_length(5)
Matches if str(item) satisfies a given matcher.
Parameters: | match – The matcher to satisfy, or an expected value for equal_to matching. |
---|
This matcher invokes the str function on the evaluated object to get its length, passing the result to a given matcher for evaluation. If the match argument is not a matcher, it is implicitly wrapped in an equal_to matcher to check for equality.
Examples:
has_string(starts_with('foo'))
has_string('bar')
Matches if an object has properties satisfying all of a dictionary of string property names and corresponding value matchers.
Parameters: | matcher_dict – A dictionary mapping keys to associated value matchers, or to expected values for equal_to matching. |
---|
Note that the keys must be actual keys, not matchers. Any value argument that is not a matcher is implicitly wrapped in an equal_to matcher to check for equality.
Examples:
has_properties({'foo':equal_to(1), 'bar':equal_to(2)})
has_properties({'foo':1, 'bar':2})
has_properties also accepts a list of keyword arguments:
Parameters: |
|
---|
Examples:
has_properties(foo=equal_to(1), bar=equal_to(2))
has_properties(foo=1, bar=2)
Finally, has_properties also accepts a list of alternating keys and their value matchers:
Parameters: |
|
---|
Examples:
has_properties('foo', equal_to(1), 'bar', equal_to(2))
has_properties('foo', 1, 'bar', 2)
Matches if object has a property with a given name whose value satisfies a given matcher.
Parameters: |
|
---|
This matcher determines if the evaluated object has a property with a given name. If no such property is found, has_property is not satisfied.
If the property is found, its value is passed to a given matcher for evaluation. If the match argument is not a matcher, it is implicitly wrapped in an equal_to matcher to check for equality.
If the match argument is not provided, the anything matcher is used so that has_property is satisfied if a matching property is found.
Examples:
has_property('name', starts_with('J'))
has_property('name', 'Jon')
has_property('name')
Matches if object is an instance of, or inherits from, a given type.
Parameters: | atype – The type to compare against as the expected type. |
---|
This matcher checks whether the evaluated object is an instance of atype or an instance of any class that inherits from atype.
Example:
instance_of(str)
Matches if object is None.
Matches if object is not None.
Matches if evaluated object is the same instance as a given object.
Parameters: | obj – The object to compare against as the expected value. |
---|
This matcher invokes the is identity operator to determine if the evaluated object is the the same object as obj.
Wrapper for function call that delays the actual execution so that raises matcher can catch any thrown exception.
Parameters: | func – The function or method to be called |
---|
The arguments can be provided with a call to the with_args function on the returned object:
calling(my_method).with_args(arguments, and_='keywords')
Matches if the called function raised the expected exception.
Parameters: |
|
---|
Expects the actual to be wrapped by using calling, or a callable taking no arguments. Optional argument pattern should be a string containing a regular expression. If provided, the string representation of the actual exception - e.g. str(actual) - must match pattern.
Examples:
assert_that(calling(int).with_args('q'), raises(TypeError))
assert_that(calling(parse, broken_input), raises(ValueError))