1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
from typing import Any, Mapping, TypeVar, Union, overload
from hamcrest import described_as
from hamcrest.core import anything
from hamcrest.core.base_matcher import BaseMatcher
from hamcrest.core.core.allof import AllOf
from hamcrest.core.description import Description
from hamcrest.core.helpers.wrap_matcher import wrap_matcher as wrap_shortcut
from hamcrest.core.matcher import Matcher
from hamcrest.core.string_description import StringDescription
__author__ = "Chris Rose"
__copyright__ = "Copyright 2011 hamcrest.org"
__license__ = "BSD, see License.txt"
V = TypeVar("V")
class IsObjectWithProperty(BaseMatcher[object]):
def __init__(self, property_name: str, value_matcher: Matcher[V]) -> None:
self.property_name = property_name
self.value_matcher = value_matcher
def _matches(self, item: object) -> bool:
if item is None:
return False
if not hasattr(item, self.property_name):
return False
value = getattr(item, self.property_name)
return self.value_matcher.matches(value)
def describe_to(self, description: Description) -> None:
description.append_text("an object with a property '").append_text(
self.property_name
).append_text("' matching ").append_description_of(self.value_matcher)
def describe_mismatch(self, item: object, mismatch_description: Description) -> None:
if item is None:
mismatch_description.append_text("was None")
return
if not hasattr(item, self.property_name):
mismatch_description.append_description_of(item).append_text(
" did not have the "
).append_description_of(self.property_name).append_text(" property")
return
mismatch_description.append_text("property ").append_description_of(
self.property_name
).append_text(" ")
value = getattr(item, self.property_name)
self.value_matcher.describe_mismatch(value, mismatch_description)
def __str__(self):
d = StringDescription()
self.describe_to(d)
return str(d)
def has_property(name: str, match: Union[None, Matcher[V], V] = None) -> Matcher[object]:
"""Matches if object has a property with a given name whose value satisfies
a given matcher.
:param name: The name of the property.
:param match: Optional matcher to satisfy.
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 :py:func:`~hamcrest.core.core.isequal.equal_to` matcher to
check for equality.
If the ``match`` argument is not provided, the
:py:func:`~hamcrest.core.core.isanything.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')
"""
if match is None:
match = anything()
return IsObjectWithProperty(name, wrap_shortcut(match))
# Keyword argument form
@overload
def has_properties(**keys_valuematchers: Union[Matcher[V], V]) -> Matcher[Any]:
...
# Name to matcher dict form
@overload
def has_properties(keys_valuematchers: Mapping[str, Union[Matcher[V], V]]) -> Matcher[Any]:
...
# Alternating name/matcher form
@overload
def has_properties(*keys_valuematchers: Any) -> Matcher[Any]:
...
def has_properties(*keys_valuematchers, **kv_args):
"""Matches if an object has properties satisfying all of a dictionary
of string property names and corresponding value matchers.
:param matcher_dict: A dictionary mapping keys to associated value matchers,
or to expected values for
:py:func:`~hamcrest.core.core.isequal.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
:py:func:`~hamcrest.core.core.isequal.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:
.. function:: has_properties(keyword1=value_matcher1[, keyword2=value_matcher2[, ...]])
:param keyword1: A keyword to look up.
:param valueMatcher1: The matcher to satisfy for the value, or an expected
value for :py:func:`~hamcrest.core.core.isequal.equal_to` matching.
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:
.. function:: has_properties(key1, value_matcher1[, ...])
:param key1: A key (not a matcher) to look up.
:param valueMatcher1: The matcher to satisfy for the value, or an expected
value for :py:func:`~hamcrest.core.core.isequal.equal_to` matching.
Examples::
has_properties('foo', equal_to(1), 'bar', equal_to(2))
has_properties('foo', 1, 'bar', 2)
"""
if len(keys_valuematchers) == 1:
try:
base_dict = keys_valuematchers[0].copy()
for key in base_dict:
base_dict[key] = wrap_shortcut(base_dict[key])
except AttributeError:
raise ValueError(
"single-argument calls to has_properties must pass a dict as the argument"
)
else:
if len(keys_valuematchers) % 2:
raise ValueError("has_properties requires key-value pairs")
base_dict = {}
for index in range(int(len(keys_valuematchers) / 2)):
base_dict[keys_valuematchers[2 * index]] = wrap_shortcut(
keys_valuematchers[2 * index + 1]
)
for key, value in kv_args.items():
base_dict[key] = wrap_shortcut(value)
if len(base_dict) > 1:
description = StringDescription().append_text("an object with properties ")
for i, (property_name, property_value_matcher) in enumerate(sorted(base_dict.items())):
description.append_description_of(property_name).append_text(
" matching "
).append_description_of(property_value_matcher)
if i < len(base_dict) - 1:
description.append_text(" and ")
return described_as(
str(description),
AllOf(
*[
has_property(property_name, property_value_matcher)
for property_name, property_value_matcher in sorted(base_dict.items())
],
describe_all_mismatches=True,
describe_matcher_in_mismatch=False,
),
)
else:
property_name, property_value_matcher = base_dict.popitem()
return has_property(property_name, property_value_matcher)
|
