aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/PyHamcrest/src/hamcrest/library/text/stringcontainsinorder.py
blob: 9d23193882e40b26388e4ebe35b064f19569ad35 (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
49
50
51
52
__author__ = "Romilly Cocking" 
__copyright__ = "Copyright 2011 hamcrest.org" 
__license__ = "BSD, see License.txt" 
 
from hamcrest.core.base_matcher import BaseMatcher 
from hamcrest.core.helpers.hasmethod import hasmethod 
 
import six 
 
class StringContainsInOrder(BaseMatcher): 
 
    def __init__(self, *substrings): 
        for substring in substrings: 
            if not isinstance(substring, six.string_types): 
                raise TypeError(self.__class__.__name__ 
                                + ' requires string arguments') 
        self.substrings = substrings 
 
    def _matches(self, item): 
        if not hasmethod(item, 'find'): 
            return False 
        from_index = 0 
        for substring in self.substrings: 
            from_index = item.find(substring, from_index) 
            if from_index == -1: 
                return False 
        return True 
 
    def describe_to(self, description): 
        description.append_list('a string containing ', ', ', ' in order', 
                                self.substrings) 
 
 
def string_contains_in_order(*substrings): 
    """Matches if object is a string containing a given list of substrings in 
    relative order. 
 
    :param string1,...:  A comma-separated list of strings. 
 
    This matcher first checks whether the evaluated object is a string. If so, 
    it checks whether it contains a given list of strings, in relative order to 
    each other. The searches are performed starting from the beginning of the 
    evaluated string. 
 
    Example:: 
 
        string_contains_in_order("bc", "fg", "jkl") 
 
    will match "abcdefghijklm". 
 
    """ 
    return StringContainsInOrder(*substrings)