robot.model package — Robot Framework 7.0.1 documentation (original) (raw)

Package with generic, reusable and extensible model classes.

This package contains, for example, TestSuite,TestCase, Keywordand SuiteVisitor base classes. These classes are extended both by executionand result related model objects and used also elsewhere.

This package is considered stable.

Submodules

robot.model.body module

class robot.model.body.BodyItem[source]

Bases: ModelObject

KEYWORD = 'KEYWORD'

SETUP = 'SETUP'

TEARDOWN = 'TEARDOWN'

FOR = 'FOR'

ITERATION = 'ITERATION'

IF_ELSE_ROOT = 'IF/ELSE ROOT'

IF = 'IF'

ELSE_IF = 'ELSE IF'

ELSE = 'ELSE'

TRY_EXCEPT_ROOT = 'TRY/EXCEPT ROOT'

TRY = 'TRY'

EXCEPT = 'EXCEPT'

FINALLY = 'FINALLY'

WHILE = 'WHILE'

VAR = 'VAR'

RETURN = 'RETURN'

CONTINUE = 'CONTINUE'

BREAK = 'BREAK'

ERROR = 'ERROR'

MESSAGE = 'MESSAGE'

KEYWORD_TYPES = ('KEYWORD', 'SETUP', 'TEARDOWN')

type = None

property id_: str | None_

Item id in format like s1-t3-k1.

See 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 If and Tryinstances representing IF/TRY structure roots.

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

parent

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

Base class for Body and Branches objects.

keyword_class

alias of type

for_class

alias of type

while_class

alias of type

if_class

alias of type

try_class

alias of type

var_class

alias of type

return_class

alias of type

continue_class

alias of type

break_class

alias of type

message_class

alias of type

error_class

alias of type

classmethod register(item_class: Type[BI]) → Type[BI][source]

Returns the subclass, to allow usage as a class decorator.

property create

Create a new item using the provided arguments.

create_keyword(*args, **kwargs) → type[source]

create_for(*args, **kwargs) → type[source]

create_if(*args, **kwargs) → type[source]

create_try(*args, **kwargs) → type[source]

create_while(*args, **kwargs) → type[source]

create_var(*args, **kwargs) → type[source]

create_return(*args, **kwargs) → type[source]

create_continue(*args, **kwargs) → type[source]

create_break(*args, **kwargs) → type[source]

create_message(*args, **kwargs) → type[source]

create_error(*args, **kwargs) → type[source]

filter(keywords: bool | None = None, messages: bool | None = None, predicate: Callable[[T], bool] | None = None)[source]

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

To include or exclude items based on types, give matching argumentsTrue or False values. For example, to include only keywords, use body.filter(keywords=True) and to exclude messages usebody.filter(messages=False). Including and excluding by types at the same time is not supported and filtering my messagesis 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, usebody.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.

flatten() → list[BodyItem][source]

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.

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.

break_class

alias of Break

continue_class

alias of Continue

error_class

alias of Error

for_class

alias of For

if_class

alias of If

keyword_class

alias of Keyword

return_class

alias of Return

try_class

alias of Try

var_class

alias of Var

while_class

alias of While

class robot.model.body.BranchType[source]

Bases: Generic[IT]

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

A list-like object representing IF and TRY branches.

branch_type

alias of type

branch_class

create_branch(*args, **kwargs) → IT[source]

class robot.model.body.IterationType[source]

Bases: Generic[FW]

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

iteration_type

alias of type

iteration_class

create_iteration(*args, **kwargs) → FW[source]

robot.model.configurer module

class robot.model.configurer.SuiteConfigurer(name=None, doc=None, metadata=None, set_tags=None, include_tags=None, exclude_tags=None, include_suites=None, include_tests=None, empty_suite_ok=False)[source]

Bases: SuiteVisitor

property add_tags

property remove_tags

visit_suite(suite)[source]

Implements traversing through suites.

Can be overridden to allow modifying the passed in suite without calling start_suite() or end_suite() nor visiting child suites, tests or setup and teardown at all.

robot.model.control module

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

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

Bases: BodyItem

Represents one FOR loop iteration.

type = 'ITERATION'

body_class

alias of Body

repr_args = ('assign',)

assign

property variables_: Mapping[str, str]_

Deprecated since Robot Framework 7.0. Use assign instead.

body

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

message

status

Bases: BodyItem

Represents FOR loops.

type = 'FOR'

body_class

alias of Body

repr_args = ('assign', 'flavor', 'values', 'start', 'mode', 'fill')

assign

flavor

values

start

mode

fill

property variables_: tuple[str, ...]_

Deprecated since Robot Framework 7.0. Use assign instead.

body

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

Represents one WHILE loop iteration.

type = 'ITERATION'

body_class

alias of Body

body

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

Represents WHILE loops.

type = 'WHILE'

body_class

alias of Body

repr_args = ('condition', 'limit', 'on_limit', 'on_limit_message')

condition

on_limit

limit

on_limit_message

body

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

Represents individual IF, ELSE IF or ELSE branch.

body_class

alias of Body

repr_args = ('type', 'condition')

type

condition

body

property id_: str_

Branch id omits IF/ELSE root from the parent id part.

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

IF/ELSE structure root. Branches are stored in body.

type = 'IF/ELSE ROOT'

branch_class

alias of IfBranch

branches_class

alias of Branches[IfBranch]

body

property id_: None_

Root IF/ELSE id is always None.

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

Represents individual TRY, EXCEPT, ELSE or FINALLY branch.

body_class

alias of Body

repr_args = ('type', 'patterns', 'pattern_type', 'assign')

type

patterns

pattern_type

assign

property variable_: str | None_

Deprecated since Robot Framework 7.0. Use assign instead.

body

property id_: str_

Branch id omits TRY/EXCEPT root from the parent id part.

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

TRY/EXCEPT structure root. Branches are stored in body.

type = 'TRY/EXCEPT ROOT'

branch_class

alias of TryBranch

branches_class

alias of Branches[TryBranch]

body

property try_branch_: TryBranch_

property except_branches_: list[TryBranch]_

property else_branch_: TryBranch | None_

property finally_branch_: TryBranch | None_

property id_: None_

Root TRY/EXCEPT id is always None.

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

Represents VAR.

type = 'VAR'

repr_args = ('name', 'value', 'scope', 'separator')

name

value

scope

separator

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

Represents RETURN.

type = 'RETURN'

repr_args = ('values',)

values

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

Represents CONTINUE.

type = 'CONTINUE'

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

Represents BREAK.

type = 'BREAK'

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

Bases: BodyItem

Represents syntax error in data.

For example, an invalid setting like [Setpu] or END in wrong place.

type = 'ERROR'

repr_args = ('values',)

values

visit(visitor: SuiteVisitor)[source]

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

robot.model.filter module

class robot.model.filter.EmptySuiteRemover(preserve_direct_children: bool = False)[source]

Bases: SuiteVisitor

end_suite(suite: TestSuite)[source]

Called when a suite ends. Default implementation does nothing.

visit_test(test: TestCase)[source]

Implements traversing through tests.

Can be overridden to allow modifying the passed in test without callingstart_test() or end_test() nor visiting the body of the test.

visit_keyword(keyword: Keyword)[source]

Implements traversing through keywords.

Can be overridden to allow modifying the passed in kw without calling start_keyword() or end_keyword() nor visiting the body of the keyword

Bases: EmptySuiteRemover

include_suites

include_tests

include_tags

exclude_tags

start_suite(suite: TestSuite)[source]

Called when a suite starts. Default implementation does nothing.

Can return explicit False to stop visiting.

robot.model.fixture module

Create or configure a fixture_class instance.

robot.model.itemlist module

class robot.model.itemlist.ItemList(item_class: Type[T], common_attrs: dict[str, Any] | None = None, items: Iterable[T | Dict[str, Any]] = ())[source]

Bases: MutableSequence[T]

List of items of a certain enforced type.

New items can be created using the create() method and existing items added using the common list methods like append() or insert(). In addition to the common type, items can have certain common and automatically assigned attributes.

Starting from Robot Framework 6.1, items can be added as dictionaries and actual items are generated based on them automatically. If the type has a from_dict class method, it is used, and otherwise dictionary data is passed to the type as keyword arguments.

item_type

alias of type

create(*args, **kwargs) → T[source]

Create a new item using the provided arguments.

append(item: T | Dict[str, Any]) → T[source]

S.append(value) – append value to the end of the sequence

extend(items: Iterable[T | Dict[str, Any]])[source]

S.extend(iterable) – extend sequence by appending elements from the iterable

insert(index: int, item: T | Dict[str, Any])[source]

S.insert(index, value) – insert value before index

index(_value_[, _start_[, _stop_]]) → integer -- return first index of value.[source]

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

clear() → None -- remove all items from S[source]

visit(visitor: SuiteVisitor)[source]

count(value) → integer -- return number of occurrences of value[source]

sort(**config)[source]

reverse()[source]

S.reverse() – reverse IN PLACE

to_dicts() → list[Dict[str, Any]][source]

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.

robot.model.keyword module

Bases: BodyItem

Base model for a single keyword.

Extended by robot.running.model.Keyword androbot.result.model.Keyword.

repr_args = ('name', 'args', 'assign')

name

args

assign

type

property id_: str | None_

Item id in format like s1-t3-k1.

See 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 If and Tryinstances representing IF/TRY structure roots.

visit(visitor: SuiteVisitor)[source]

Visitor interface entry-point.

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

robot.model.message module

class robot.model.message.Message(message: str = '', level: Literal['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FAIL', 'SKIP'] = 'INFO', html: bool = False, timestamp: datetime | str | None = None, parent: BodyItem | None = None)[source]

Bases: BodyItem

A message created during the test execution.

Can be a log message triggered by a keyword, or a warning or an error that occurred during parsing or test execution.

type = 'MESSAGE'

repr_args = ('message', 'level')

message

level

html

timestamp

property html_message

Returns the message content as HTML.

property id

Item id in format like s1-t3-k1.

See 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 If and Tryinstances representing IF/TRY structure roots.

visit(visitor)[source]

Visitor interface entry-point.

class robot.model.message.Messages(message_class=<class 'robot.model.message.Message'>, parent=None, messages=None)[source]

Bases: ItemList

robot.model.metadata module

class robot.model.metadata.Metadata(initial: Mapping[str, str] | Iterable[tuple[str, str]] | None = None)[source]

Bases: NormalizedDict[str]

Free suite metadata as a mapping.

Keys are case, space, and underscore insensitive.

Initialized with possible initial value and normalizing spec.

Initial values can be either a dictionary or an iterable of name/value pairs.

Normalizing spec has exact same semantics as with the normalize()function.

robot.model.modelobject module

class robot.model.modelobject.ModelObject[source]

Bases: object

repr_args = ()

classmethod from_dict(data: Dict[str, Any]) → T[source]

Create this object based on data in a dictionary.

Data can be got from the 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.

classmethod from_json(source: str | bytes | TextIO | Path) → T[source]

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 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.

to_dict() → Dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

to_json(file: None = None, *, ensure_ascii: bool = False, indent: int = 0, separators: tuple[str, str] = (',', ':')) → str[source]

to_json(file: TextIO | Path | str, *, ensure_ascii: bool = False, indent: int = 0, separators: tuple[str, str] = (',', ':')) → None

Serialize this object into JSON.

The object is first converted to a Python dictionary using theto_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.

config(**attributes) → T[source]

Configure model object with given attributes.

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

New in Robot Framework 4.0.

copy(**attributes) → T[source]

Return a shallow copy of this object.

Parameters:

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

See also deepcopy(). The difference between copy anddeepcopy is the same as with the methods having same names in the copy module.

deepcopy(**attributes) → T[source]

Return a deep copy of this object.

Parameters:

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

See also copy(). The difference between deepcopy andcopy is the same as with the methods having same names in the copy module.

robot.model.modelobject.full_name(obj_or_cls)[source]

class robot.model.modelobject.JsonLoader[source]

Bases: object

load(source: str | bytes | TextIO | Path) → Dict[str, Any][source]

class robot.model.modelobject.JsonDumper(**config)[source]

Bases: object

dump(data: Dict[str, Any], output: None = None) → str[source]

dump(data: Dict[str, Any], output: TextIO | Path | str) → None

robot.model.modifier module

class robot.model.modifier.ModelModifier(visitors, empty_suite_ok, logger)[source]

Bases: SuiteVisitor

visit_suite(suite)[source]

Implements traversing through suites.

Can be overridden to allow modifying the passed in suite without calling start_suite() or end_suite() nor visiting child suites, tests or setup and teardown at all.

robot.model.namepatterns module

class robot.model.namepatterns.NamePatterns(patterns: Sequence[str] = (), ignore: Sequence[str] = '_')[source]

Bases: Iterable[str]

match(name: str, full_name: str | None = None) → bool[source]

robot.model.statistics module

class robot.model.statistics.Statistics(suite, suite_stat_level=-1, tag_stat_include=None, tag_stat_exclude=None, tag_stat_combine=None, tag_doc=None, tag_stat_link=None, rpa=False)[source]

Bases: object

Container for total, suite and tag statistics.

Accepted parameters have the same semantics as the matching command line options.

total

Instance of TotalStatistics.

suite

Instance of SuiteStatistics.

tags

Instance of TagStatistics.

visit(visitor)[source]

class robot.model.statistics.StatisticsBuilder(total_builder, suite_builder, tag_builder)[source]

Bases: SuiteVisitor

start_suite(suite)[source]

Called when a suite starts. Default implementation does nothing.

Can return explicit False to stop visiting.

end_suite(suite)[source]

Called when a suite ends. Default implementation does nothing.

visit_test(test)[source]

Implements traversing through tests.

Can be overridden to allow modifying the passed in test without callingstart_test() or end_test() nor visiting the body of the test.

visit_keyword(kw)[source]

Implements traversing through keywords.

Can be overridden to allow modifying the passed in kw without calling start_keyword() or end_keyword() nor visiting the body of the keyword

robot.model.stats module

class robot.model.stats.Stat(name)[source]

Bases: Sortable

Generic statistic object used for storing all the statistic values.

name

Human readable identifier of the object these statistics belong to. All Tests forTotalStatistics, long name of the suite forSuiteStatisticsor name of the tag forTagStatistics

get_attributes(include_label=False, include_elapsed=False, exclude_empty=True, values_as_strings=False, html_escape=False)[source]

property total

add_test(test)[source]

visit(visitor)[source]

class robot.model.stats.TotalStat(name)[source]

Bases: Stat

Stores statistic values for a test run.

type = 'total'

class robot.model.stats.SuiteStat(suite)[source]

Bases: Stat

Stores statistics values for a single suite.

type = 'suite'

add_stat(other)[source]

class robot.model.stats.TagStat(name, doc='', links=None, combined=None)[source]

Bases: Stat

Stores statistic values for a single tag.

type = 'tag'

doc

Documentation of tag as a string.

links

List of tuples in which the first value is the link URL and the second is the link title. An empty list by default.

combined

Pattern as a string if the tag is combined, None otherwise.

property info

Returns additional information of the tag statistics are about. Either combined or an empty string.

class robot.model.stats.CombinedTagStat(pattern, name=None, doc='', links=None)[source]

Bases: TagStat

match(tags)[source]

robot.model.suitestatistics module

class robot.model.suitestatistics.SuiteStatistics(suite)[source]

Bases: object

Container for suite statistics.

stat

Instance of SuiteStat.

suites

List of TestSuite objects.

visit(visitor)[source]

class robot.model.suitestatistics.SuiteStatisticsBuilder(suite_stat_level)[source]

Bases: object

property current

start_suite(suite)[source]

add_test(test)[source]

end_suite()[source]

robot.model.tags module

class robot.model.tags.Tags(tags: Iterable[str] = ())[source]

Bases: Sequence[str]

robot(name: str) → bool[source]

Check do tags contain a reserved tag in format robot:.

This is same as ‘robot:’ in tags but considerably faster.

add(tags: Iterable[str])[source]

remove(tags: Iterable[str])[source]

match(tags: Iterable[str]) → bool[source]

class robot.model.tags.TagPatterns(patterns: Iterable[str] = ())[source]

Bases: Sequence[TagPattern]

match(tags: Iterable[str]) → bool[source]

class robot.model.tags.TagPattern[source]

Bases: ABC

classmethod from_string(pattern: str) → TagPattern [source]

abstract match(tags: Iterable[str]) → bool[source]

class robot.model.tags.SingleTagPattern(pattern: str)[source]

Bases: TagPattern

match(tags: Iterable[str]) → bool[source]

class robot.model.tags.AndTagPattern(patterns: Iterable[str])[source]

Bases: TagPattern

match(tags: Iterable[str]) → bool[source]

class robot.model.tags.OrTagPattern(patterns: Iterable[str])[source]

Bases: TagPattern

match(tags: Iterable[str]) → bool[source]

class robot.model.tags.NotTagPattern(must_match: str, must_not_match: Iterable[str])[source]

Bases: TagPattern

match(tags: Iterable[str]) → bool[source]

robot.model.tags.normalize_tags(tags: Iterable[str]) → Iterable[str][source]

Performance optimization to normalize tags only once.

class robot.model.tags.NormalizedTags(iterable=(), /)[source]

Bases: list

robot.model.tagsetter module

class robot.model.tagsetter.TagSetter(add: Sequence[str] | str = (), remove: Sequence[str] | str = ())[source]

Bases: SuiteVisitor

start_suite(suite: TestSuite)[source]

Called when a suite starts. Default implementation does nothing.

Can return explicit False to stop visiting.

visit_test(test: TestCase)[source]

Implements traversing through tests.

Can be overridden to allow modifying the passed in test without callingstart_test() or end_test() nor visiting the body of the test.

visit_keyword(keyword: Keyword)[source]

Implements traversing through keywords.

Can be overridden to allow modifying the passed in kw without calling start_keyword() or end_keyword() nor visiting the body of the keyword

robot.model.tagstatistics module

class robot.model.tagstatistics.TagStatistics(combined_stats)[source]

Bases: object

Container for tag statistics.

tags

Dictionary, where key is the name of the tag as a string and value is an instance of TagStat.

combined

List of CombinedTagStat objects.

visit(visitor)[source]

class robot.model.tagstatistics.TagStatisticsBuilder(included=None, excluded=None, combined=None, docs=None, links=None)[source]

Bases: object

add_test(test)[source]

class robot.model.tagstatistics.TagStatInfo(docs=None, links=None)[source]

Bases: object

get_stat(tag)[source]

get_combined_stats(combined=None)[source]

get_doc(tag)[source]

get_links(tag)[source]

class robot.model.tagstatistics.TagStatDoc(pattern, doc)[source]

Bases: object

match(tag)[source]

class robot.model.tagstatistics.TagStatLink(pattern, link, title)[source]

Bases: object

match(tag)[source]

get_link(tag)[source]

robot.model.testcase module

class robot.model.testcase.TestCase(name: str = '', doc: str = '', tags: Tags | Sequence[str] = (), timeout: str | None = None, lineno: int | None = None, parent: TestSuite[KW, TestCase[KW]] | None = None)[source]

Bases: ModelObject, Generic[KW]

Base model for a single test case.

Extended by robot.running.model.TestCase androbot.result.model.TestCase.

body_class

alias of Body

fixture_class

alias of Keyword

repr_args = ('name',)

name

doc

timeout

lineno

parent

body

Test body as a Body object.

tags

Test tags as a Tags object.

property setup_: KW_

Test setup as a Keyword object.

This attribute is a Keyword object also when a test has no setup but in that case its truth value is False.

Setup can be modified by setting attributes directly:

test.setup.name = 'Example' test.setup.args = ('First', 'Second')

Alternatively the config() method can be used to set multiple attributes in one call:

test.setup.config(name='Example', args=('First', 'Second'))

The easiest way to reset the whole setup is setting it to None. It will automatically recreate the underlying Keyword object:

New in Robot Framework 4.0. Earlier setup was accessed liketest.keywords.setup.

property has_setup_: bool_

Check does a suite have a setup without creating a setup object.

A difference between using if test.has_setup: and if test.setup:is that accessing the setup attribute creates a Keywordobject representing the setup even when the test actually does not have one. This typically does not matter, but with bigger suite structures containing a huge about of tests it can have an effect on memory usage.

New in Robot Framework 5.0.

property teardown_: KW_

Test teardown as a Keyword object.

See setup for more information.

property has_teardown_: bool_

Check does a test have a teardown without creating a teardown object.

See has_setup for more information.

New in Robot Framework 5.0.

property id_: str_

Test case id in format like s1-t3.

See TestSuite.id for more information.

property full_name_: str_

Test name prefixed with the full name of the parent suite.

property longname_: str_

Deprecated since Robot Framework 7.0. Use full_name instead.

property source_: Path | None_

visit(visitor: SuiteVisitor)[source]

Visitor interface entry-point.

to_dict() → dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

class robot.model.testcase.TestCases(test_class: ~typing.Type[~robot.model.testcase.TC] = <class 'robot.model.testcase.TestCase'>, parent: TestSuite|None = None, tests: Sequence[TC|DataDict] = ())[source]

Bases: ItemList[TC]

robot.model.testsuite module

Bases: ModelObject, Generic[KW, TC]

Base model for single suite.

Extended by robot.running.model.TestSuite androbot.result.model.TestSuite.

fixture_class

alias of Keyword

test_class

alias of TestCase

repr_args = ('name',)

doc

parent

rpa

static name_from_source(source: Path | str | None, extension: Sequence[str] = ()) → str[source]

Create suite name based on the given source.

This method is used by Robot Framework itself when it builds suites. External parsers and other tools that want to produce suites with names matching names created by Robot Framework can use this method as well. This method is also used if name is not set and someone accesses it.

The algorithm is as follows:

If the source is None or empty, return an empty string.
Get the base name of the source. Read more below.
Remove possible prefix separated with __.
Convert underscores to spaces.
If the name is all lower case, title case it.

The base name of files is got by calling Path.stem that drops the file extension. It typically works fine, but gives wrong result if the extension has multiple parts like in tests.robot.zip. That problem can be avoided by giving valid file extension or extensions as the optional extension argument.

Examples:

TestSuite.name_from_source(source) TestSuite.name_from_source(source, extension='.robot.zip') TestSuite.name_from_source(source, ('.robot', '.robot.zip'))

property name_: str_

Suite name.

If name is not set, it is constructed from source. If source is not set, name is constructed from child suite names by concatenating them with `` & ``. If there are no child suites, name is an empty string.

source

adjust_source(relative_to: Path | str | None = None, root: Path | str | None = None)[source]

Adjust suite source and child suite sources, recursively.

Parameters:

relative_to – Make suite source relative to the given path. Callspathlib.Path.relative_to() internally. Raises ValueErrorif creating a relative path is not possible.
root – Make given path a new root directory for the source. RaisesValueError if suite source is absolute.

Adjusting the source is especially useful when moving data around as JSON:

from robot.api import TestSuite

Create a suite, adjust source and convert to JSON.

suite = TestSuite.from_file_system('/path/to/data') suite.adjust_source(relative_to='/path/to') suite.to_json('data.rbt')

Recreate suite elsewhere and adjust source accordingly.

suite = TestSuite.from_json('data.rbt') suite.adjust_source(root='/new/path/to')

New in Robot Framework 6.1.

property full_name_: str_

Suite name prefixed with the full name of the possible parent suite.

Just name of the suite if it has no parent.

property longname_: str_

Deprecated since Robot Framework 7.0. Use full_name instead.

metadata

Free suite metadata as a Metadata object.

validate_execution_mode() → bool | None[source]

Validate that suite execution mode is set consistently.

Raise an exception if the execution mode is not set (i.e. the rpaattribute is None) and child suites have conflicting execution modes.

The execution mode is returned. New in RF 6.1.1.

suites

tests

property setup_: KW_

Suite setup.

This attribute is a Keyword object also when a suite has no setup but in that case its truth value is False. The preferred way to check does a suite have a setup is using has_setup.

Setup can be modified by setting attributes directly:

suite.setup.name = 'Example' suite.setup.args = ('First', 'Second')

Alternatively the config() method can be used to set multiple attributes in one call:

suite.setup.config(name='Example', args=('First', 'Second'))

The easiest way to reset the whole setup is setting it to None. It will automatically recreate the underlying Keyword object:

New in Robot Framework 4.0. Earlier setup was accessed likesuite.keywords.setup.

property has_setup_: bool_

Check does a suite have a setup without creating a setup object.

A difference between using if suite.has_setup: and if suite.setup:is that accessing the setup attribute creates a Keywordobject representing the setup even when the suite actually does not have one. This typically does not matter, but with bigger suite structures it can have some effect on memory usage.

New in Robot Framework 5.0.

property teardown_: KW_

Suite teardown.

See setup for more information.

property has_teardown_: bool_

Check does a suite have a teardown without creating a teardown object.

See has_setup for more information.

New in Robot Framework 5.0.

property id_: str_

An automatically generated unique id.

The root suite has id s1, its child suites have ids s1-s1,s1-s2, …, their child suites get ids s1-s1-s1, s1-s1-s2, …, s1-s2-s1, …, and so on.

The first test in a suite has an id like s1-t1, the second has an id s1-t2, and so on. Similarly, keywords in suites (setup/teardown) and in tests get ids like s1-k1, s1-t1-k1, and s1-s4-t2-k5.

property all_tests_: Iterator[TestCase]_

Yields all tests this suite and its child suites contain.

New in Robot Framework 6.1.

property test_count_: int_

Total number of the tests in this suite and in its child suites.

property has_tests_: bool_

set_tags(add: Sequence[str] = (), remove: Sequence[str] = (), persist: bool = False)[source]

Add and/or remove specified tags to the tests in this suite.

Parameters:

add – Tags to add as a list or, if adding only one, as a single string.
remove – Tags to remove as a list or as a single string. Can be given as patterns where * and ? work as wildcards.
persist – Add/remove specified tags also to new tests added to this suite in the future.

filter(included_suites: Sequence[str] | None = None, included_tests: Sequence[str] | None = None, included_tags: Sequence[str] | None = None, excluded_tags: Sequence[str] | None = None)[source]

Select test cases and remove others from this suite.

Parameters have the same semantics as --suite, --test,--include, and --exclude command line options. All of them can be given as a list of strings, or when selecting only one, as a single string.

Child suites that contain no tests after filtering are automatically removed.

Example:

suite.filter(included_tests=['Test 1', '* Example'], included_tags='priority-1')

configure(**options)[source]

A shortcut to configure a suite using one method call.

Can only be used with the root test suite.

Parameters:

options – Passed toSuiteConfigurer that will then set suite attributes, call filter(), etc. as needed.

Not to be confused with config() method that suites, tests, and keywords have to make it possible to set multiple attributes in one call.

remove_empty_suites(preserve_direct_children: bool = False)[source]

Removes all child suites not containing any tests, recursively.

visit(visitor: SuiteVisitor)[source]

Visitor interface entry-point.

to_dict() → dict[str, Any][source]

Serialize this object into a dictionary.

The object can be later restored by using the from_dict() method.

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

class robot.model.testsuite.TestSuites(suite_class: ~typing.Type[~robot.model.testsuite.TS] = <class 'robot.model.testsuite.TestSuite'>, parent: ~robot.model.testsuite.TS | None = None, suites: ~typing.Sequence[~robot.model.testsuite.TS | ~typing.Dict[str, ~typing.Any]] = ())[source]

Bases: ItemList[TS]

robot.model.totalstatistics module

class robot.model.totalstatistics.TotalStatistics(rpa: bool = False)[source]

Bases: object

Container for total statistics.

visit(visitor)[source]

property total_: int_

property passed_: int_

property skipped_: int_

property failed_: int_

add_test(test)[source]

property message_: str_

String representation of the statistics.

For example::

2 tests, 1 passed, 1 failed

class robot.model.totalstatistics.TotalStatisticsBuilder(suite=None, rpa=False)[source]

Bases: SuiteVisitor

add_test(test)[source]

visit_test(test)[source]

Implements traversing through tests.

Can be overridden to allow modifying the passed in test without callingstart_test() or end_test() nor visiting the body of the test.

visit_keyword(kw)[source]

Implements traversing through keywords.

Can be overridden to allow modifying the passed in kw without calling start_keyword() or end_keyword() nor visiting the body of the keyword

robot.model.visitor module

Interface to ease traversing through a test suite structure.

Visitors make it easy to modify test suite structures or to collect information from them. They work both with the executable modeland the result model, but the objects passed to the visitor methods are slightly different depending on the model they are used with. The main differences are that on the execution side keywords do not have child keywords nor messages, and that only the result objects have status related attributes like status and start_time.

This module contains SuiteVisitor that implements the core logic to visit a test suite structure, and the result package containsResultVisitor that supports visiting the whole test execution result structure. Both of these visitors should be imported via the robot.api package when used by external code.

Visitor algorithm

All suite, test, keyword and message objects have a visit() method that accepts a visitor instance. These methods will then call the correct visitor method visit_suite(), visit_test(),visit_keyword() or visit_message(), depending on the instance where the visit() method exists.

The recommended and definitely the easiest way to implement a visitor is extending the SuiteVisitor base class. The default implementation of itsvisit_x() methods take care of traversing child elements of the objectx recursively. A visit_x() method first calls a correspondingstart_x() method (e.g. visit_suite() calls start_suite()), then calls visit() for all child objects of the x object, and finally calls the corresponding end_x() method. The default implementations of start_x() and end_x() do nothing.

All items that can appear inside tests have their own visit methods. These include visit_keyword(), visit_message() (only applicable with results, not with executable data), visit_for(), visit_if(), and so on, as well as their appropriate start/end methods like start_keyword()and end_for(). If there is a need to visit all these items, it is possible to implement only start_body_item() and end_body_item() methods that are, by default, called by the appropriate start/end methods. These generic methods are new in Robot Framework 5.0.

Visitors extending the SuiteVisitor can stop visiting at a certain level either by overriding suitable visit_x() method or by returning an explicit False from any start_x() method.

Examples

The following example visitor modifies the test suite structure it visits. It could be used, for example, with Robot Framework’s --prerunmodifieroption to modify test data before execution.

"""Pre-run modifier that selects only every Xth test for execution.

Starts from the first test by default. Tests are selected per suite. """

from robot.api import SuiteVisitor

class SelectEveryXthTest(SuiteVisitor):

def __init__(self, x: int, start: int = 0):
    self.x = x
    self.start = start

def start_suite(self, suite):
    """Modify suite's tests to contain only every Xth."""
    suite.tests = suite.tests[self.start::self.x]

def end_suite(self, suite):
    """Remove suites that are empty after removing tests."""
    suite.suites = [s for s in suite.suites if s.test_count > 0]

def visit_test(self, test):
    """Avoid visiting tests and their keywords to save a little time."""
    pass

For more examples it is possible to look at the source code of visitors used internally by Robot Framework itself. Some good examples areTagSetter andkeyword removers.

Type hints

Visitor methods have type hints to give more information about the model objects they receive to editors. Because visitors can be used with both running and result models, the types that are used as type hints are base classes from therobot.model module. Actual visitor implementations can import appropriate types from the robot.running or the robot.result module instead. For example, this visitor uses the result side model objects:

from robot.api import SuiteVisitor from robot.result import TestCase, TestSuite

class FailurePrinter(SuiteVisitor):

def start_suite(self, suite: TestSuite):
    print(f"{suite.full_name}: {suite.statistics.failed} failed")

def visit_test(self, test: TestCase):
    if test.failed:
        print(f'- {test.name}: {test.message}')

Type hints were added in Robot Framework 6.1. They are optional and can be removed altogether if they get in the way.

class robot.model.visitor.SuiteVisitor[source]

Bases: object

Abstract class to ease traversing through the suite structure.

See the module level documentation for more information and an example.

visit_suite(suite: TestSuite)[source]

Implements traversing through suites.

Can be overridden to allow modifying the passed in suite without calling start_suite() or end_suite() nor visiting child suites, tests or setup and teardown at all.

start_suite(suite: TestSuite) → bool | None[source]

Called when a suite starts. Default implementation does nothing.

Can return explicit False to stop visiting.

end_suite(suite: TestSuite)[source]

Called when a suite ends. Default implementation does nothing.

visit_test(test: TestCase)[source]

Implements traversing through tests.

Can be overridden to allow modifying the passed in test without callingstart_test() or end_test() nor visiting the body of the test.

start_test(test: TestCase) → bool | None[source]

Called when a test starts. Default implementation does nothing.

Can return explicit False to stop visiting.

end_test(test: TestCase)[source]

Called when a test ends. Default implementation does nothing.

visit_keyword(keyword: Keyword)[source]

Implements traversing through keywords.

Can be overridden to allow modifying the passed in kw without calling start_keyword() or end_keyword() nor visiting the body of the keyword

start_keyword(keyword: Keyword) → bool | None[source]

Called when a keyword starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_keyword(keyword: Keyword)[source]

Called when a keyword ends.

By default, calls end_body_item() which, by default, does nothing.

visit_for(for_: For)[source]

Implements traversing through FOR loops.

Can be overridden to allow modifying the passed in for_ without calling start_for() or end_for() nor visiting body.

start_for(for_: For) → bool | None[source]

Called when a FOR loop starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_for(for_: For)[source]

Called when a FOR loop ends.

By default, calls end_body_item() which, by default, does nothing.

visit_for_iteration(iteration: ForIteration)[source]

Implements traversing through single FOR loop iteration.

This is only used with the result side model because on the running side there are no iterations.

Can be overridden to allow modifying the passed in iteration without calling start_for_iteration() or end_for_iteration() nor visiting body.

start_for_iteration(iteration: ForIteration) → bool | None[source]

Called when a FOR loop iteration starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_for_iteration(iteration: ForIteration)[source]

Called when a FOR loop iteration ends.

By default, calls end_body_item() which, by default, does nothing.

visit_if(if_: If)[source]

Implements traversing through IF/ELSE structures.

Notice that if_ does not have any data directly. Actual IF/ELSE branches are in its body and they are visited separately usingvisit_if_branch().

Can be overridden to allow modifying the passed in if_ without calling start_if() or end_if() nor visiting branches.

start_if(if_: If) → bool | None[source]

Called when an IF/ELSE structure starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_if(if_: If)[source]

Called when an IF/ELSE structure ends.

By default, calls end_body_item() which, by default, does nothing.

visit_if_branch(branch: IfBranch)[source]

Implements traversing through single IF/ELSE branch.

Can be overridden to allow modifying the passed in branch without calling start_if_branch() or end_if_branch() nor visiting body.

start_if_branch(branch: IfBranch) → bool | None[source]

Called when an IF/ELSE branch starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_if_branch(branch: IfBranch)[source]

Called when an IF/ELSE branch ends.

By default, calls end_body_item() which, by default, does nothing.

visit_try(try_: Try)[source]

Implements traversing through TRY/EXCEPT structures.

This method is used with the TRY/EXCEPT root element. Actual TRY, EXCEPT, ELSE and FINALLY branches are visited separately using visit_try_branch().

start_try(try_: Try) → bool | None[source]

Called when a TRY/EXCEPT structure starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_try(try_: Try)[source]

Called when a TRY/EXCEPT structure ends.

By default, calls end_body_item() which, by default, does nothing.

visit_try_branch(branch: TryBranch)[source]

Visits individual TRY, EXCEPT, ELSE and FINALLY branches.

start_try_branch(branch: TryBranch) → bool | None[source]

Called when TRY, EXCEPT, ELSE or FINALLY branches start.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_try_branch(branch: TryBranch)[source]

Called when TRY, EXCEPT, ELSE and FINALLY branches end.

By default, calls end_body_item() which, by default, does nothing.

visit_while(while_: While)[source]

Implements traversing through WHILE loops.

Can be overridden to allow modifying the passed in while_ without calling start_while() or end_while() nor visiting body.

start_while(while_: While) → bool | None[source]

Called when a WHILE loop starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_while(while_: While)[source]

Called when a WHILE loop ends.

By default, calls end_body_item() which, by default, does nothing.

visit_while_iteration(iteration: WhileIteration)[source]

Implements traversing through single WHILE loop iteration.

This is only used with the result side model because on the running side there are no iterations.

Can be overridden to allow modifying the passed in iteration without calling start_while_iteration() or end_while_iteration() nor visiting body.

start_while_iteration(iteration: WhileIteration) → bool | None[source]

Called when a WHILE loop iteration starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_while_iteration(iteration: WhileIteration)[source]

Called when a WHILE loop iteration ends.

By default, calls end_body_item() which, by default, does nothing.

visit_var(var: Var)[source]

Visits a VAR elements.

start_var(var: Var) → bool | None[source]

Called when a VAR element starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_var(var: Var)[source]

Called when a VAR element ends.

By default, calls end_body_item() which, by default, does nothing.

visit_return(return_: Return)[source]

Visits a RETURN elements.

start_return(return_: Return) → bool | None[source]

Called when a RETURN element starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_return(return_: Return)[source]

Called when a RETURN element ends.

By default, calls end_body_item() which, by default, does nothing.

visit_continue(continue_: Continue)[source]

Visits CONTINUE elements.

start_continue(continue_: Continue) → bool | None[source]

Called when a CONTINUE element starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_continue(continue_: Continue)[source]

Called when a CONTINUE element ends.

By default, calls end_body_item() which, by default, does nothing.

visit_break(break_: Break)[source]

Visits BREAK elements.

start_break(break_: Break) → bool | None[source]

Called when a BREAK element starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_break(break_: Break)[source]

Called when a BREAK element ends.

By default, calls end_body_item() which, by default, does nothing.

visit_error(error: Error)[source]

Visits body items resulting from invalid syntax.

Examples include syntax like END or ELSE in wrong place and invalid setting like [Invalid].

start_error(error: Error) → bool | None[source]

Called when a ERROR element starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_error(error: Error)[source]

Called when a ERROR element ends.

By default, calls end_body_item() which, by default, does nothing.

visit_message(message: Message)[source]

Implements visiting messages.

Can be overridden to allow modifying the passed in msg without calling start_message() or end_message().

start_message(message: Message) → bool | None[source]

Called when a message starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_message(message: Message)[source]

Called when a message ends.

By default, calls end_body_item() which, by default, does nothing.

start_body_item(item: BodyItem) → bool | None[source]

Called, by default, when keywords, messages or control structures start.

More specific start_keyword(), start_message(), :meth:`start_for, etc. can be implemented to visit only keywords, messages or specific control structures.

Can return explicit False to stop visiting. Default implementation does nothing.

end_body_item(item: BodyItem)[source]

Called, by default, when keywords, messages or control structures end.

More specific end_keyword(), end_message(), :meth:`end_for, etc. can be implemented to visit only keywords, messages or specific control structures.

Default implementation does nothing.