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

Bases: robot.model.visitor.SuiteVisitor

visit_test(test)

Implements traversing through the test and its keywords.

Can be overridden to allow modifying the passed in test without calling start_test() or end_test() nor visiting keywords.

visit_keyword(kw)

Implements traversing through the keyword and its child keywords.

Can be overridden to allow modifying the passed in kw without calling start_keyword() or end_keyword() nor visiting child keywords.

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_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_message(msg)

Implements visiting the message.

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

visit_suite(suite)

Implements traversing through the suite and its direct children.

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

class robot.conf.gatherfailed.GatherFailedSuites

Bases: robot.model.visitor.SuiteVisitor

start_suite(suite)

Called when suite starts. Default implementation does nothing.

Can return explicit False to stop visiting.

visit_test(test)

Implements traversing through the test and its keywords.

Can be overridden to allow modifying the passed in test without calling start_test() or end_test() nor visiting keywords.

visit_keyword(kw)

Implements traversing through the keyword and its child keywords.

Can be overridden to allow modifying the passed in kw without calling start_keyword() or end_keyword() nor visiting child keywords.

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_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_message(msg)

Implements visiting the message.

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

visit_suite(suite)

Implements traversing through the suite and its direct children.

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

robot.conf.gatherfailed.gather_failed_tests(output)

robot.conf.gatherfailed.gather_failed_suites(output)

robot.conf.settings module

class robot.conf.settings.RobotSettings(options=None, **extra_options)

Bases: robot.conf.settings._BaseSettings

get_rebot_settings()

listeners

debug_file

suite_config

randomize_seed

randomize_suites

randomize_tests

dry_run

exit_on_failure

exit_on_error

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

critical_tags

flatten_keywords

log

log_level

non_critical_tags

output

output_directory

pre_rebot_modifiers

remove_keywords

report

rpa

split_log

statistics_config

status_rc

xunit

xunit_skip_noncritical

class robot.conf.settings.RebotSettings(options=None, **extra_options)

Bases: robot.conf.settings._BaseSettings

suite_config

log_config

report_config

merge

console_colors

console_output_config

critical_tags

flatten_keywords

log

log_level

non_critical_tags

output

output_directory

pre_rebot_modifiers

remove_keywords

report

rpa

split_log

statistics_config

status_rc

xunit

xunit_skip_noncritical

process_empty_suite