Skip to content

keywordimplementation

KeywordImplementation

Bases: ModelObject

Base class for different keyword implementations.

Source code in src/robot/running/keywordimplementation.py 
 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
class KeywordImplementation(ModelObject):
    """Base class for different keyword implementations."""
    USER_KEYWORD = 'USER KEYWORD'
    LIBRARY_KEYWORD = 'LIBRARY KEYWORD'
    INVALID_KEYWORD = 'INVALID KEYWORD'
    repr_args = ('name', 'args')
    __slots__ = ['embedded', '_name', '_doc', '_lineno', 'owner', 'parent', 'error']
    type: Literal['USER KEYWORD', 'LIBRARY KEYWORD', 'INVALID KEYWORD']

    def __init__(self, name: str = '',
                 args: 'ArgumentSpec|None' = None,
                 doc: str = '',
                 tags: 'Tags|Sequence[str]' = (),
                 lineno: 'int|None' = None,
                 owner: 'ResourceFile|TestLibrary|None' = None,
                 parent: 'BodyItemParent|None' = None,
                 error: 'str|None' = None):
        self._name = name
        self.embedded = self._get_embedded(name)
        self.args = args
        self._doc = doc
        self.tags = tags
        self._lineno = lineno
        self.owner = owner
        self.parent = parent
        self.error = error

    def _get_embedded(self, name) -> 'EmbeddedArguments|None':
        return EmbeddedArguments.from_name(name)

    @property
    def name(self) -> str:
        return self._name

    @name.setter
    def name(self, name: str):
        self.embedded = self._get_embedded(name)
        if self.owner and self._name:
            self.owner.keyword_finder.invalidate_cache()
        self._name = name

    @property
    def full_name(self) -> str:
        if self.owner and self.owner.name:
            return f'{self.owner.name}.{self.name}'
        return self.name

    @setter
    def args(self, spec: 'ArgumentSpec|None') -> ArgumentSpec:
        """Information about accepted arguments.

        It would be more correct to use term *parameter* instead of
        *argument* in this context, and this attribute may be renamed
        accordingly in the future. A forward compatible :attr:`params`
        attribute exists already now.
        """
        if spec is None:
            spec = ArgumentSpec()
        spec.name = lambda: self.full_name
        return spec

    @property
    def params(self) -> ArgumentSpec:
        """Keyword parameter information.

        This is a forward compatible alias for :attr:`args`.
        """
        return self.args

    @property
    def doc(self) -> str:
        return self._doc

    @doc.setter
    def doc(self, doc: str):
        self._doc = doc

    @property
    def short_doc(self) -> str:
        return getshortdoc(self.doc)

    @setter
    def tags(self, tags: 'Tags|Sequence[str]') -> Tags:
        return Tags(tags)

    @property
    def lineno(self) -> 'int|None':
        return self._lineno

    @lineno.setter
    def lineno(self, lineno: 'int|None'):
        self._lineno = lineno

    @property
    def private(self) -> bool:
        return bool(self.tags and self.tags.robot('private'))

    @property
    def source(self) -> 'Path|None':
        return self.owner.source if self.owner is not None else None

    def matches(self, name: str) -> bool:
        """Returns true if ``name`` matches the keyword name.

        With normal keywords matching is a case, space and underscore insensitive
        string comparison. With keywords accepting embedded arguments, matching
        is done against the name.
        """
        if self.embedded:
            return self.embedded.match(name) is not None
        return eq(self.name, name, ignore='_')

    def resolve_arguments(self, args: 'Sequence[str|Any]',
                          named_args: 'Mapping[str, Any]|None' = None,
                          variables=None,
                          languages: 'LanguagesLike' = None) -> 'tuple[list, list]':
        return self.args.resolve(args, named_args, variables, languages=languages)

    def create_runner(self, name: 'str|None', languages: 'LanguagesLike' = None) \
            -> 'LibraryKeywordRunner|UserKeywordRunner':
        raise NotImplementedError

    def bind(self, data: Keyword) -> 'KeywordImplementation':
        raise NotImplementedError

    def _include_in_repr(self, name: str, value: Any) -> bool:
        return name == 'name' or value

    def _repr_format(self, name: str, value: Any) -> str:
        if name == 'args':
            value = [self._decorate_arg(a) for a in self.args]
        return super()._repr_format(name, value)

    def _decorate_arg(self, arg: ArgInfo) -> str:
        return str(arg)

params: ArgumentSpec property

Keyword parameter information.

This is a forward compatible alias for :attr:args.

args(spec)

Information about accepted arguments.

It would be more correct to use term parameter instead of argument in this context, and this attribute may be renamed accordingly in the future. A forward compatible :attr:params attribute exists already now.

Source code in src/robot/running/keywordimplementation.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
@setter
def args(self, spec: 'ArgumentSpec|None') -> ArgumentSpec:
    """Information about accepted arguments.

    It would be more correct to use term *parameter* instead of
    *argument* in this context, and this attribute may be renamed
    accordingly in the future. A forward compatible :attr:`params`
    attribute exists already now.
    """
    if spec is None:
        spec = ArgumentSpec()
    spec.name = lambda: self.full_name
    return spec

config(**attributes)

Configure model object with given attributes.

obj.config(name='Example', doc='Something') is equivalent to setting obj.name = 'Example' and obj.doc = 'Something'.

New in Robot Framework 4.0.

Source code in src/robot/model/modelobject.py 
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
def config(self: T, **attributes) -> T:
    """Configure model object with given attributes.

    ``obj.config(name='Example', doc='Something')`` is equivalent to setting
    ``obj.name = 'Example'`` and ``obj.doc = 'Something'``.

    New in Robot Framework 4.0.
    """
    for name, value in attributes.items():
        try:
            orig = getattr(self, name)
        except AttributeError:
            raise AttributeError(f"'{full_name(self)}' object does not have "
                                 f"attribute '{name}'")
        # Preserve tuples. Main motivation is converting lists with `from_json`.
        if isinstance(orig, tuple) and not isinstance(value, tuple):
            try:
                value = tuple(value)
            except TypeError:
                raise TypeError(f"'{full_name(self)}' object attribute '{name}' "
                                f"is 'tuple', got '{type_name(value)}'.")
        try:
            setattr(self, name, value)
        except AttributeError as err:
            # Ignore error setting attribute if the object already has it.
            # Avoids problems with `from_dict` with body items having
            # un-settable `type` attribute that is needed in dict data.
            if value != orig:
                raise AttributeError(f"Setting attribute '{name}' failed: {err}")
    return self

copy(**attributes)

Return a shallow copy of this object.

:param attributes: Attributes to be set to the returned copy. For example, obj.copy(name='New name').

See also :meth:deepcopy. The difference between copy and deepcopy is the same as with the methods having same names in the copy__ module.

__ https://docs.python.org/3/library/copy.html

Source code in src/robot/model/modelobject.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
def copy(self: T, **attributes) -> T:
    """Return a shallow copy of this object.

    :param attributes: Attributes to be set to the returned copy.
        For example, ``obj.copy(name='New name')``.

    See also :meth:`deepcopy`. The difference between ``copy`` and
    ``deepcopy`` is the same as with the methods having same names in
    the copy__ module.

    __ https://docs.python.org/3/library/copy.html
    """
    return copy.copy(self).config(**attributes)

deepcopy(**attributes)

Return a deep copy of this object.

:param attributes: Attributes to be set to the returned copy. For example, obj.deepcopy(name='New name').

See also :meth:copy. The difference between deepcopy and copy is the same as with the methods having same names in the copy__ module.

__ https://docs.python.org/3/library/copy.html

Source code in src/robot/model/modelobject.py 
167
168
169
170
171
172
173
174
175
176
177
178
179
def deepcopy(self: T, **attributes) -> T:
    """Return a deep copy of this object.

    :param attributes: Attributes to be set to the returned copy.
        For example, ``obj.deepcopy(name='New name')``.

    See also :meth:`copy`. The difference between ``deepcopy`` and
    ``copy`` is the same as with the methods having same names in
    the copy__ module.

    __ https://docs.python.org/3/library/copy.html
    """
    return copy.deepcopy(self).config(**attributes)

from_dict(data) classmethod

Create this object based on data in a dictionary.

Data can be got from the :meth:to_dict method or created externally.

With robot.running model objects new in Robot Framework 6.1, with robot.result new in Robot Framework 7.0.

Source code in src/robot/model/modelobject.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
@classmethod
def from_dict(cls: Type[T], data: DataDict) -> T:
    """Create this object based on data in a dictionary.

    Data can be got from the :meth:`to_dict` method or created externally.

    With ``robot.running`` model objects new in Robot Framework 6.1,
    with ``robot.result`` new in Robot Framework 7.0.
    """
    try:
        return cls().config(**data)
    except (AttributeError, TypeError) as err:
        raise DataError(f"Creating '{full_name(cls)}' object from dictionary "
                        f"failed: {err}")

from_json(source) classmethod

Create this object based on JSON data.

The data is given as the source parameter. It can be:

  • a string (or bytes) containing the data directly,
  • an open file object where to read the data from, or
  • a path (pathlib.Path or string) to a UTF-8 encoded file to read.

The JSON data is first converted to a Python dictionary and the object created using the :meth:from_dict method.

Notice that the source is considered to be JSON data if it is a string and contains {. If you need to use { in a file system path, pass it in as a pathlib.Path instance.

With robot.running model objects new in Robot Framework 6.1, with robot.result new in Robot Framework 7.0.

Source code in src/robot/model/modelobject.py 
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
@classmethod
def from_json(cls: Type[T], source: 'str|bytes|TextIO|Path') -> T:
    """Create this object based on JSON data.

    The data is given as the ``source`` parameter. It can be:

    - a string (or bytes) containing the data directly,
    - an open file object where to read the data from, or
    - a path (``pathlib.Path`` or string) to a UTF-8 encoded file to read.

    The JSON data is first converted to a Python dictionary and the object
    created using the :meth:`from_dict` method.

    Notice that the ``source`` is considered to be JSON data if it is
    a string and contains ``{``. If you need to use ``{`` in a file system
    path, pass it in as a ``pathlib.Path`` instance.

    With ``robot.running`` model objects new in Robot Framework 6.1,
    with ``robot.result`` new in Robot Framework 7.0.
    """
    try:
        data = JsonLoader().load(source)
    except (TypeError, ValueError) as err:
        raise DataError(f'Loading JSON data failed: {err}')
    return cls.from_dict(data)

matches(name)

Returns true if name matches the keyword name.

With normal keywords matching is a case, space and underscore insensitive string comparison. With keywords accepting embedded arguments, matching is done against the name.

Source code in src/robot/running/keywordimplementation.py 
135
136
137
138
139
140
141
142
143
144
def matches(self, name: str) -> bool:
    """Returns true if ``name`` matches the keyword name.

    With normal keywords matching is a case, space and underscore insensitive
    string comparison. With keywords accepting embedded arguments, matching
    is done against the name.
    """
    if self.embedded:
        return self.embedded.match(name) is not None
    return eq(self.name, name, ignore='_')

to_dict()

Serialize this object into a dictionary.

The object can be later restored by using the :meth:from_dict method.

With robot.running model objects new in Robot Framework 6.1, with robot.result new in Robot Framework 7.0.

Source code in src/robot/model/modelobject.py 
74
75
76
77
78
79
80
81
82
def to_dict(self) -> DataDict:
    """Serialize this object into a dictionary.

    The object can be later restored by using the :meth:`from_dict` method.

    With ``robot.running`` model objects new in Robot Framework 6.1,
    with ``robot.result`` new in Robot Framework 7.0.
    """
    raise NotImplementedError

to_json(file=None, *, ensure_ascii=False, indent=0, separators=(',', ':'))

Serialize this object into JSON.

The object is first converted to a Python dictionary using the :meth:to_dict method and then the dictionary is converted to JSON.

The file parameter controls what to do with the resulting JSON data. It can be:

  • None (default) to return the data as a string,
  • an open file object where to write the data to, or
  • a path (pathlib.Path or string) to a file where to write the data using UTF-8 encoding.

JSON formatting can be configured using optional parameters that are passed directly to the underlying json__ module. Notice that the defaults differ from what json uses.

With robot.running model objects new in Robot Framework 6.1, with robot.result new in Robot Framework 7.0.

__ https://docs.python.org/3/library/json.html

Source code in src/robot/model/modelobject.py 
 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
def to_json(self, file: 'None|TextIO|Path|str' = None, *,
            ensure_ascii: bool = False, indent: int = 0,
            separators: 'tuple[str, str]' = (',', ':')) -> 'str|None':
    """Serialize this object into JSON.

    The object is first converted to a Python dictionary using the
    :meth:`to_dict` method and then the dictionary is converted to JSON.

    The ``file`` parameter controls what to do with the resulting JSON data.
    It can be:

    - ``None`` (default) to return the data as a string,
    - an open file object where to write the data to, or
    - a path (``pathlib.Path`` or string) to a file where to write
      the data using UTF-8 encoding.

    JSON formatting can be configured using optional parameters that
    are passed directly to the underlying json__ module. Notice that
    the defaults differ from what ``json`` uses.

    With ``robot.running`` model objects new in Robot Framework 6.1,
    with ``robot.result`` new in Robot Framework 7.0.

    __ https://docs.python.org/3/library/json.html
    """
    return JsonDumper(ensure_ascii=ensure_ascii, indent=indent,
                      separators=separators).dump(self.to_dict(), file)