summaryrefslogtreecommitdiffstats
path: root/contrib/python/PyHamcrest/py3/hamcrest/library/text/stringcontains.py
blob: 34df2f6f01dbf13cee7be169df842ae021b8f766 (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
from hamcrest.core.helpers.hasmethod import hasmethod
from hamcrest.core.matcher import Matcher
from hamcrest.library.text.substringmatcher import SubstringMatcher

__author__ = "Jon Reid"
__copyright__ = "Copyright 2011 hamcrest.org"
__license__ = "BSD, see License.txt"


class StringContains(SubstringMatcher):
    def __init__(self, substring) -> None:
        super(StringContains, self).__init__(substring)

    def _matches(self, item: str) -> bool:
        if not hasmethod(item, "find"):
            return False
        return item.find(self.substring) >= 0

    def relationship(self):
        return "containing"


def contains_string(substring: str) -> Matcher[str]:
    """Matches if object is a string containing a given string.

    :param string: The string to search for.

    This matcher first checks whether the evaluated object is a string. If so,
    it checks whether it contains ``string``.

    Example::

        contains_string("def")

    will match "abcdefg".

    """
    return StringContains(substring)