robot.conf package¶
Implements settings for both test execution and output processing.
This package implements RobotSettings
and
RebotSettings
classes used internally by
the framework. There should be no need to use these classes externally.
This package can be considered relatively stable. Aforementioned classes are likely to be rewritten at some point to be more convenient to use. Instantiating them is not likely to change, though.
Submodules¶
robot.conf.gatherfailed module¶
-
class
robot.conf.gatherfailed.
GatherFailedTests
[source]¶ Bases:
robot.model.visitor.SuiteVisitor
-
visit_test
(test)[source]¶ Implements traversing through tests.
Can be overridden to allow modifying the passed in
test
without callingstart_test()
orend_test()
nor visiting keywords.
-
visit_keyword
(kw)[source]¶ Implements traversing through keywords.
Can be overridden to allow modifying the passed in
kw
without callingstart_keyword()
orend_keyword()
nor visiting child keywords.
-
end_for
(for_)¶ Called when FOR loop ends. Default implementation does nothing.
-
end_for_iteration
(iteration)¶ Called when FOR loop iteration ends. Default implementation does nothing.
-
end_if
(if_)¶ Called when IF/ELSE structure ends. Default implementation does nothing.
-
end_if_branch
(branch)¶ Called when IF/ELSE branch ends. Default implementation does nothing.
-
end_keyword
(keyword)¶ Called when keyword ends. Default implementation does nothing.
-
end_message
(msg)¶ Called when message ends. Default implementation does nothing.
-
end_suite
(suite)¶ Called when suite ends. Default implementation does nothing.
-
end_test
(test)¶ Called when test ends. Default implementation does nothing.
-
start_for
(for_)¶ Called when FOR loop starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_for_iteration
(iteration)¶ Called when FOR loop iteration starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_if
(if_)¶ Called when IF/ELSE structure starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_if_branch
(branch)¶ Called when IF/ELSE branch starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_keyword
(keyword)¶ Called when keyword starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_message
(msg)¶ Called when message starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_suite
(suite)¶ Called when suite starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_test
(test)¶ Called when test starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
visit_for
(for_)¶ Implements traversing through FOR loops.
Can be overridden to allow modifying the passed in
for_
without callingstart_for()
orend_for()
nor visiting body.
-
visit_for_iteration
(iteration)¶ 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 callingstart_for_iteration()
orend_for_iteration()
nor visiting body.
-
visit_if
(if_)¶ Implements traversing through IF/ELSE structures.
Notice that
if_
does not have any data directly. Actual IF/ELSE branches are in itsbody
and visited usingvisit_if_branch()
.Can be overridden to allow modifying the passed in
if_
without callingstart_if()
orend_if()
nor visiting branches.
-
visit_if_branch
(branch)¶ Implements traversing through single IF/ELSE branch.
Can be overridden to allow modifying the passed in
branch
without callingstart_if_branch()
orend_if_branch()
nor visiting body.
-
visit_message
(msg)¶ Implements visiting messages.
Can be overridden to allow modifying the passed in
msg
without callingstart_message()
orend_message()
.
-
visit_suite
(suite)¶ Implements traversing through suites.
Can be overridden to allow modifying the passed in
suite
without callingstart_suite()
orend_suite()
nor visiting child suites, tests or keywords (setup and teardown) at all.
-
-
class
robot.conf.gatherfailed.
GatherFailedSuites
[source]¶ Bases:
robot.model.visitor.SuiteVisitor
-
start_suite
(suite)[source]¶ Called when suite starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
visit_test
(test)[source]¶ Implements traversing through tests.
Can be overridden to allow modifying the passed in
test
without callingstart_test()
orend_test()
nor visiting keywords.
-
visit_keyword
(kw)[source]¶ Implements traversing through keywords.
Can be overridden to allow modifying the passed in
kw
without callingstart_keyword()
orend_keyword()
nor visiting child keywords.
-
end_for
(for_)¶ Called when FOR loop ends. Default implementation does nothing.
-
end_for_iteration
(iteration)¶ Called when FOR loop iteration ends. Default implementation does nothing.
-
end_if
(if_)¶ Called when IF/ELSE structure ends. Default implementation does nothing.
-
end_if_branch
(branch)¶ Called when IF/ELSE branch ends. Default implementation does nothing.
-
end_keyword
(keyword)¶ Called when keyword ends. Default implementation does nothing.
-
end_message
(msg)¶ Called when message ends. Default implementation does nothing.
-
end_suite
(suite)¶ Called when suite ends. Default implementation does nothing.
-
end_test
(test)¶ Called when test ends. Default implementation does nothing.
-
start_for
(for_)¶ Called when FOR loop starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_for_iteration
(iteration)¶ Called when FOR loop iteration starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_if
(if_)¶ Called when IF/ELSE structure starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_if_branch
(branch)¶ Called when IF/ELSE branch starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_keyword
(keyword)¶ Called when keyword starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_message
(msg)¶ Called when message starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_test
(test)¶ Called when test starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
visit_for
(for_)¶ Implements traversing through FOR loops.
Can be overridden to allow modifying the passed in
for_
without callingstart_for()
orend_for()
nor visiting body.
-
visit_for_iteration
(iteration)¶ 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 callingstart_for_iteration()
orend_for_iteration()
nor visiting body.
-
visit_if
(if_)¶ Implements traversing through IF/ELSE structures.
Notice that
if_
does not have any data directly. Actual IF/ELSE branches are in itsbody
and visited usingvisit_if_branch()
.Can be overridden to allow modifying the passed in
if_
without callingstart_if()
orend_if()
nor visiting branches.
-
visit_if_branch
(branch)¶ Implements traversing through single IF/ELSE branch.
Can be overridden to allow modifying the passed in
branch
without callingstart_if_branch()
orend_if_branch()
nor visiting body.
-
visit_message
(msg)¶ Implements visiting messages.
Can be overridden to allow modifying the passed in
msg
without callingstart_message()
orend_message()
.
-
visit_suite
(suite)¶ Implements traversing through suites.
Can be overridden to allow modifying the passed in
suite
without callingstart_suite()
orend_suite()
nor visiting child suites, tests or keywords (setup and teardown) at all.
-
robot.conf.settings module¶
-
class
robot.conf.settings.
RobotSettings
(options=None, **extra_options)[source]¶ Bases:
robot.conf.settings._BaseSettings
-
listeners
¶
-
debug_file
¶
-
suite_config
¶
-
randomize_seed
¶
-
randomize_suites
¶
-
randomize_tests
¶
-
dry_run
¶
-
exit_on_failure
¶
-
exit_on_error
¶
-
skip_on_failure
¶
-
skip_teardown_on_exit
¶
-
console_output_config
¶
-
console_type
¶
-
console_width
¶
-
console_markers
¶
-
max_error_lines
¶
-
pre_run_modifiers
¶
-
run_empty_suite
¶
-
variables
¶
-
variable_files
¶
-
extension
¶
-
console_colors
¶
-
flatten_keywords
¶
-
log
¶
-
log_level
¶
-
output
¶
-
output_directory
¶
-
pre_rebot_modifiers
¶
-
remove_keywords
¶
-
report
¶
-
rpa
¶
-
split_log
¶
-
statistics_config
¶
-
status_rc
¶
-
xunit
¶
-
-
class
robot.conf.settings.
RebotSettings
(options=None, **extra_options)[source]¶ Bases:
robot.conf.settings._BaseSettings
-
suite_config
¶
-
log_config
¶
-
report_config
¶
-
merge
¶
-
console_output_config
¶
-
console_colors
¶
-
flatten_keywords
¶
-
log
¶
-
log_level
¶
-
output
¶
-
output_directory
¶
-
pre_rebot_modifiers
¶
-
process_empty_suite
¶
-
remove_keywords
¶
-
report
¶
-
rpa
¶
-
split_log
¶
-
statistics_config
¶
-
status_rc
¶
-
xunit
¶
-
expand_keywords
¶
-