aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/PyHamcrest/src/hamcrest/library/collection/isdict_containingkey.py
blob: 6d5cca438905446459f977628332e38dce1ee474 (plain) (blame)
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
from hamcrest.core.base_matcher import BaseMatcher 
from hamcrest.core.helpers.hasmethod import hasmethod 
from hamcrest.core.helpers.wrap_matcher import wrap_matcher 
 
__author__ = "Jon Reid" 
__copyright__ = "Copyright 2011 hamcrest.org" 
__license__ = "BSD, see License.txt" 
 
 
class IsDictContainingKey(BaseMatcher): 
 
    def __init__(self, key_matcher): 
        self.key_matcher = key_matcher 
 
    def _matches(self, dictionary): 
        if hasmethod(dictionary, 'keys'): 
            for key in dictionary.keys(): 
                if self.key_matcher.matches(key): 
                    return True 
        return False 
 
    def describe_to(self, description): 
        description.append_text('a dictionary containing key ')     \ 
                    .append_description_of(self.key_matcher) 
 
 
def has_key(key_match): 
    """Matches if dictionary contains an entry whose key satisfies a given 
    matcher. 
 
    :param key_match: The matcher to satisfy for the key, or an expected value 
        for :py:func:`~hamcrest.core.core.isequal.equal_to` matching. 
 
    This matcher iterates the evaluated dictionary, searching for any key-value 
    entry whose key satisfies the given matcher. If a matching entry is found, 
    ``has_key`` is satisfied. 
 
    Any 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_key(equal_to('foo')) 
        has_key('foo') 
 
    """ 
    return IsDictContainingKey(wrap_matcher(key_match))