Skip to content

keywordfinder

KeywordFinder

Bases: Generic[K]

Source code in src/robot/running/keywordfinder.py 
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
class KeywordFinder(Generic[K]):

    def __init__(self, owner: 'TestLibrary|ResourceFile'):
        self.owner = owner
        self.cache: KeywordCache|None = None

    @overload
    def find(self, name: str, count: Literal[1]) -> 'K':
        ...

    @overload
    def find(self, name: str, count: 'int|None' = None) -> 'list[K]':
        ...

    def find(self, name: str, count: 'int|None' = None) -> 'list[K]|K':
        """Find keywords based on the given ``name``.

        With normal keywords matching is a case, space and underscore insensitive
        string comparison and there cannot be more than one match. With keywords
        accepting embedded arguments, matching is done against the name and
        there can be multiple matches.

        Returns matching keywords as a list, possibly as an empty list, without
        any validation by default. If the optional ``count`` is used, raises
        a ``ValueError`` if the number of found keywords does not match. If
        ``count`` is ``1`` and exactly one keyword is found, returns that keyword
        directly and not as a list.
        """
        if self.cache is None:
            self.cache = KeywordCache[K](self.owner.keywords)
        return self.cache.find(name, count)

    def invalidate_cache(self):
        self.cache = None

find(name, count=None)

Find keywords based on the given name.

With normal keywords matching is a case, space and underscore insensitive string comparison and there cannot be more than one match. With keywords accepting embedded arguments, matching is done against the name and there can be multiple matches.

Returns matching keywords as a list, possibly as an empty list, without any validation by default. If the optional count is used, raises a ValueError if the number of found keywords does not match. If count is 1 and exactly one keyword is found, returns that keyword directly and not as a list.

Source code in src/robot/running/keywordfinder.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def find(self, name: str, count: 'int|None' = None) -> 'list[K]|K':
    """Find keywords based on the given ``name``.

    With normal keywords matching is a case, space and underscore insensitive
    string comparison and there cannot be more than one match. With keywords
    accepting embedded arguments, matching is done against the name and
    there can be multiple matches.

    Returns matching keywords as a list, possibly as an empty list, without
    any validation by default. If the optional ``count`` is used, raises
    a ``ValueError`` if the number of found keywords does not match. If
    ``count`` is ``1`` and exactly one keyword is found, returns that keyword
    directly and not as a list.
    """
    if self.cache is None:
        self.cache = KeywordCache[K](self.owner.keywords)
    return self.cache.find(name, count)