Skip to content

robot.model.body

BodyItem

Bases: ModelObject

from_dict classmethod 

1
from_dict(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.

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 classmethod 

1
from_json(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.

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)

to_json 

1
2
3
4
5
6
7
to_json(
    file: None = None,
    *,
    ensure_ascii: bool = False,
    indent: int = 0,
    separators: tuple[str, str] = (",", ":")
) -> str

1
2
3
4
5
6
7
to_json(
    file: TextIO | Path | str,
    *,
    ensure_ascii: bool = False,
    indent: int = 0,
    separators: tuple[str, str] = (",", ":")
) -> None

1
2
3
4
5
6
7
to_json(
    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

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)

config 

1
config(**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.

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 

1
copy(**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

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 

1
deepcopy(**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

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)

id property 

1
id: str | None

Item id in format like s1-t3-k1.

See :attr:TestSuite.id <robot.model.testsuite.TestSuite.id> for more information.

id is None only in these special cases:

  • Keyword uses a placeholder for setup or teardown when a setup or teardown is not actually used.
  • With :class:~robot.model.control.If and :class:~robot.model.control.Try instances representing IF/TRY structure roots.

BaseBody 

1
2
3
4
BaseBody(
    parent: BodyItemParent = None,
    items: Iterable[BodyItem | DataDict] = (),
)

Bases: ItemList[BodyItem], Generic[KW, F, W, I, T, V, R, C, B, M, E]

Base class for Body and Branches objects.

Source code in src/robot/model/body.py 
133
134
135
def __init__(self, parent: BodyItemParent = None,
             items: 'Iterable[BodyItem|DataDict]' = ()):
    super().__init__(BodyItem, {'parent': parent}, items)

to_dicts 

1
to_dicts() -> list[DataDict]

Return list of items converted to dictionaries.

Items are converted to dictionaries using the to_dict method, if they have it, or the built-in vars().

New in Robot Framework 6.1.

Source code in src/robot/model/itemlist.py 
217
218
219
220
221
222
223
224
225
226
227
def to_dicts(self) -> 'list[DataDict]':
    """Return list of items converted to dictionaries.

    Items are converted to dictionaries using the ``to_dict`` method, if
    they have it, or the built-in ``vars()``.

    New in Robot Framework 6.1.
    """
    if not hasattr(self._item_class, 'to_dict'):
        return [vars(item) for item in self]
    return [item.to_dict() for item in self]    # type: ignore

filter 

1
2
3
4
5
filter(
    keywords: bool | None = None,
    messages: bool | None = None,
    predicate: Callable[[T], bool] | None = None,
)

Filter body items based on type and/or custom predicate.

To include or exclude items based on types, give matching arguments True or False values. For example, to include only keywords, use body.filter(keywords=True) and to exclude messages use body.filter(messages=False). Including and excluding by types at the same time is not supported and filtering my messages is supported only if the Body object actually supports messages.

Custom predicate is a callable getting each body item as an argument that must return True/False depending on should the item be included or not.

Selected items are returned as a list and the original body is not modified.

It was earlier possible to filter also based on FOR and IF types. That support was removed in RF 5.0 because it was not considered useful in general and because adding support for all new control structures would have required extra work. To exclude all control structures, use body.filter(keywords=True, messages=True) and to only include them use body.filter(keywords=False, messages=False). For more detailed filtering it is possible to usepredicate``.

Source code in src/robot/model/body.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
def filter(self, keywords: 'bool|None' = None, messages: 'bool|None' = None,
           predicate: 'Callable[[T], bool]|None' = None):
    """Filter body items based on type and/or custom predicate.

    To include or exclude items based on types, give matching arguments
    ``True`` or ``False`` values. For example, to include only keywords,
    use ``body.filter(keywords=True)`` and to exclude messages use
    ``body.filter(messages=False)``. Including and excluding by types
    at the same time is not supported and filtering my ``messages``
    is supported only if the ``Body`` object actually supports messages.

    Custom ``predicate`` is a callable getting each body item as an argument
    that must return ``True/False`` depending on should the item be included
    or not.

    Selected items are returned as a list and the original body is not modified.

    It was earlier possible to filter also based on FOR and IF types.
    That support was removed in RF 5.0 because it was not considered useful
    in general and because adding support for all new control structures
    would have required extra work. To exclude all control structures, use
    ``body.filter(keywords=True, messages=True)`` and to only include them
    use ``body.filter(keywords=False``, messages=False)``. For more detailed
    filtering it is possible to use ``predicate``.
    """
    if messages is not None and self.message_class is KnownAtRuntime:
        raise TypeError(f"'{full_name(self)}' object does not support "
                        f"filtering by 'messages'.")
    return self._filter([(self.keyword_class, keywords),
                         (self.message_class, messages)], predicate)

flatten 

1
flatten() -> list[BodyItem]

Return steps so that IF and TRY structures are flattened.

Basically the IF/ELSE and TRY/EXCEPT root elements are replaced with their branches. This is how they are shown in log files.

Source code in src/robot/model/body.py 
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
def flatten(self) -> 'list[BodyItem]':
    """Return steps so that IF and TRY structures are flattened.

    Basically the IF/ELSE and TRY/EXCEPT root elements are replaced
    with their branches. This is how they are shown in log files.
    """
    roots = BodyItem.IF_ELSE_ROOT, BodyItem.TRY_EXCEPT_ROOT
    steps = []
    for item in self:
        if item.type in roots:
            item = cast('Try|If', item)
            steps.extend(item.body)
        else:
            steps.append(item)
    return steps

Body 

1
2
3
4
Body(
    parent: BodyItemParent = None,
    items: Iterable[BodyItem | DataDict] = (),
)

Bases: BaseBody['Keyword', 'For', 'While', 'If', 'Try', 'Var', 'Return', 'Continue', 'Break', 'Message', 'Error']

A list-like object representing a body of a test, keyword, etc.

Body contains the keywords and other structures such as FOR loops.

Source code in src/robot/model/body.py 
133
134
135
def __init__(self, parent: BodyItemParent = None,
             items: 'Iterable[BodyItem|DataDict]' = ()):
    super().__init__(BodyItem, {'parent': parent}, items)

to_dicts 

1
to_dicts() -> list[DataDict]

Return list of items converted to dictionaries.

Items are converted to dictionaries using the to_dict method, if they have it, or the built-in vars().

New in Robot Framework 6.1.

Source code in src/robot/model/itemlist.py 
217
218
219
220
221
222
223
224
225
226
227
def to_dicts(self) -> 'list[DataDict]':
    """Return list of items converted to dictionaries.

    Items are converted to dictionaries using the ``to_dict`` method, if
    they have it, or the built-in ``vars()``.

    New in Robot Framework 6.1.
    """
    if not hasattr(self._item_class, 'to_dict'):
        return [vars(item) for item in self]
    return [item.to_dict() for item in self]    # type: ignore

filter 

1
2
3
4
5
filter(
    keywords: bool | None = None,
    messages: bool | None = None,
    predicate: Callable[[T], bool] | None = None,
)

Filter body items based on type and/or custom predicate.

To include or exclude items based on types, give matching arguments True or False values. For example, to include only keywords, use body.filter(keywords=True) and to exclude messages use body.filter(messages=False). Including and excluding by types at the same time is not supported and filtering my messages is supported only if the Body object actually supports messages.

Custom predicate is a callable getting each body item as an argument that must return True/False depending on should the item be included or not.

Selected items are returned as a list and the original body is not modified.

It was earlier possible to filter also based on FOR and IF types. That support was removed in RF 5.0 because it was not considered useful in general and because adding support for all new control structures would have required extra work. To exclude all control structures, use body.filter(keywords=True, messages=True) and to only include them use body.filter(keywords=False, messages=False). For more detailed filtering it is possible to usepredicate``.

Source code in src/robot/model/body.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
def filter(self, keywords: 'bool|None' = None, messages: 'bool|None' = None,
           predicate: 'Callable[[T], bool]|None' = None):
    """Filter body items based on type and/or custom predicate.

    To include or exclude items based on types, give matching arguments
    ``True`` or ``False`` values. For example, to include only keywords,
    use ``body.filter(keywords=True)`` and to exclude messages use
    ``body.filter(messages=False)``. Including and excluding by types
    at the same time is not supported and filtering my ``messages``
    is supported only if the ``Body`` object actually supports messages.

    Custom ``predicate`` is a callable getting each body item as an argument
    that must return ``True/False`` depending on should the item be included
    or not.

    Selected items are returned as a list and the original body is not modified.

    It was earlier possible to filter also based on FOR and IF types.
    That support was removed in RF 5.0 because it was not considered useful
    in general and because adding support for all new control structures
    would have required extra work. To exclude all control structures, use
    ``body.filter(keywords=True, messages=True)`` and to only include them
    use ``body.filter(keywords=False``, messages=False)``. For more detailed
    filtering it is possible to use ``predicate``.
    """
    if messages is not None and self.message_class is KnownAtRuntime:
        raise TypeError(f"'{full_name(self)}' object does not support "
                        f"filtering by 'messages'.")
    return self._filter([(self.keyword_class, keywords),
                         (self.message_class, messages)], predicate)

flatten 

1
flatten() -> list[BodyItem]

Return steps so that IF and TRY structures are flattened.

Basically the IF/ELSE and TRY/EXCEPT root elements are replaced with their branches. This is how they are shown in log files.

Source code in src/robot/model/body.py 
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
def flatten(self) -> 'list[BodyItem]':
    """Return steps so that IF and TRY structures are flattened.

    Basically the IF/ELSE and TRY/EXCEPT root elements are replaced
    with their branches. This is how they are shown in log files.
    """
    roots = BodyItem.IF_ELSE_ROOT, BodyItem.TRY_EXCEPT_ROOT
    steps = []
    for item in self:
        if item.type in roots:
            item = cast('Try|If', item)
            steps.extend(item.body)
        else:
            steps.append(item)
    return steps

BaseBranches 

1
2
3
4
5
BaseBranches(
    branch_class: Type[IT],
    parent: BodyItemParent = None,
    items: Iterable[IT | DataDict] = (),
)

Bases: BaseBody[KW, F, W, I, T, V, R, C, B, M, E], BranchType[IT]

A list-like object representing IF and TRY branches.

Source code in src/robot/model/body.py 
297
298
299
300
301
def __init__(self, branch_class: Type[IT],
             parent: BodyItemParent = None,
             items: 'Iterable[IT|DataDict]' = ()):
    self.branch_class = branch_class
    super().__init__(parent, items)

to_dicts 

1
to_dicts() -> list[DataDict]

Return list of items converted to dictionaries.

Items are converted to dictionaries using the to_dict method, if they have it, or the built-in vars().

New in Robot Framework 6.1.

Source code in src/robot/model/itemlist.py 
217
218
219
220
221
222
223
224
225
226
227
def to_dicts(self) -> 'list[DataDict]':
    """Return list of items converted to dictionaries.

    Items are converted to dictionaries using the ``to_dict`` method, if
    they have it, or the built-in ``vars()``.

    New in Robot Framework 6.1.
    """
    if not hasattr(self._item_class, 'to_dict'):
        return [vars(item) for item in self]
    return [item.to_dict() for item in self]    # type: ignore

filter 

1
2
3
4
5
filter(
    keywords: bool | None = None,
    messages: bool | None = None,
    predicate: Callable[[T], bool] | None = None,
)

Filter body items based on type and/or custom predicate.

To include or exclude items based on types, give matching arguments True or False values. For example, to include only keywords, use body.filter(keywords=True) and to exclude messages use body.filter(messages=False). Including and excluding by types at the same time is not supported and filtering my messages is supported only if the Body object actually supports messages.

Custom predicate is a callable getting each body item as an argument that must return True/False depending on should the item be included or not.

Selected items are returned as a list and the original body is not modified.

It was earlier possible to filter also based on FOR and IF types. That support was removed in RF 5.0 because it was not considered useful in general and because adding support for all new control structures would have required extra work. To exclude all control structures, use body.filter(keywords=True, messages=True) and to only include them use body.filter(keywords=False, messages=False). For more detailed filtering it is possible to usepredicate``.

Source code in src/robot/model/body.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
def filter(self, keywords: 'bool|None' = None, messages: 'bool|None' = None,
           predicate: 'Callable[[T], bool]|None' = None):
    """Filter body items based on type and/or custom predicate.

    To include or exclude items based on types, give matching arguments
    ``True`` or ``False`` values. For example, to include only keywords,
    use ``body.filter(keywords=True)`` and to exclude messages use
    ``body.filter(messages=False)``. Including and excluding by types
    at the same time is not supported and filtering my ``messages``
    is supported only if the ``Body`` object actually supports messages.

    Custom ``predicate`` is a callable getting each body item as an argument
    that must return ``True/False`` depending on should the item be included
    or not.

    Selected items are returned as a list and the original body is not modified.

    It was earlier possible to filter also based on FOR and IF types.
    That support was removed in RF 5.0 because it was not considered useful
    in general and because adding support for all new control structures
    would have required extra work. To exclude all control structures, use
    ``body.filter(keywords=True, messages=True)`` and to only include them
    use ``body.filter(keywords=False``, messages=False)``. For more detailed
    filtering it is possible to use ``predicate``.
    """
    if messages is not None and self.message_class is KnownAtRuntime:
        raise TypeError(f"'{full_name(self)}' object does not support "
                        f"filtering by 'messages'.")
    return self._filter([(self.keyword_class, keywords),
                         (self.message_class, messages)], predicate)

flatten 

1
flatten() -> list[BodyItem]

Return steps so that IF and TRY structures are flattened.

Basically the IF/ELSE and TRY/EXCEPT root elements are replaced with their branches. This is how they are shown in log files.

Source code in src/robot/model/body.py 
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
def flatten(self) -> 'list[BodyItem]':
    """Return steps so that IF and TRY structures are flattened.

    Basically the IF/ELSE and TRY/EXCEPT root elements are replaced
    with their branches. This is how they are shown in log files.
    """
    roots = BodyItem.IF_ELSE_ROOT, BodyItem.TRY_EXCEPT_ROOT
    steps = []
    for item in self:
        if item.type in roots:
            item = cast('Try|If', item)
            steps.extend(item.body)
        else:
            steps.append(item)
    return steps