Config
[profile].description
Type: Optional[str]
Description of the profile.
[profile].detached
Type: Optional[bool]
The profile should be detached. Detached means it is not inherited from the
main profile.
[profile].enabled
Type: Union[bool, Condition, None]
If enabled the profile is used. You can also use and if condition to calculate the enabled state.
Examples:
# alway disabled
enabled = false
# enabled if TEST_VAR is set
enabled = { if = 'environ.get("CI") == "true"' }
[profile].precedence
Type: Optional[int]
Precedence of the profile. Lower values are executed first. If not set the
order is undefined.
args
Type: Optional[List[str]]
Arguments to be passed to robot.
Examples:
args = ["-t", "abc"]
console
Type: Optional[Literal['verbose', 'dotted', 'skipped', 'quiet', 'none']]
How to report execution on the console. verbose: report every suite and test
(default) dotted: only show . for passed test, s for skipped tests, and F for
failed tests quiet: no output except for errors and warnings none: no
output whatsoever
corresponds to the --console type option of robot
console-colors
Type: Optional[Literal['auto', 'on', 'ansi', 'off']]
Use colors on console output or not. auto: use colors when output not
redirected (default) on: always use colors ansi: like on but use ANSI colors
also on Windows off: disable colors altogether
corresponds to the -C --consolecolors auto|on|ansi|off option of robot
console-markers
Type: Optional[Literal['auto', 'on', 'off']]
Show markers on the console when top level keywords in a test case end. Values have same semantics as with --consolecolors.
corresponds to the -K --consolemarkers auto|on|off option of robot
console-width
Type: Optional[int]
Width of the console output. Default is 78.
corresponds to the -W --consolewidth chars option of robot
debug-file
Type: Union[str, StringExpression, None]
Debug file written during execution. Not created unless this option is
specified.
corresponds to the -b --debugfile file option of robot
default-profiles
Type: Union[str, List[str], None]
Selects the Default profile if no profile is given at command line.
Examples:
default_profiles = "default"
default_profiles = ["default", "Firefox"]
doc
Type: Union[str, StringExpression, None]
Set the documentation of the top level suite. Simple formatting is supported
(e.g. bold). If the documentation contains spaces, it must be quoted. If the
value is path to an existing file, actual documentation is read from that file.
Examples:
--doc "Very good example"
--doc doc_from_file.txt
corresponds to the -D --doc documentation option of robot
dotted
Type: Union[bool, Flag, None]
Shortcut for --console dotted.
corresponds to the -. --dotted option of robot
dry-run
Type: Union[bool, Flag, None]
Verifies test data and runs tests so that library keywords are not executed.
corresponds to the --dryrun option of robot
env
Type: Optional[Dict[str, str]]
Define environment variables to be set before running tests.
Examples:
[env]
TEST_VAR = "test"
SECRET = "password"
excludes
Type: Optional[List[Union[str, StringExpression]]]
Select test cases not to run by tag. These tests are not run even if included
with --include. Tags are matched using same rules as with --include.
corresponds to the -e --exclude tag * option of robot
exit-on-error
Type: Union[bool, Flag, None]
Stops test execution if any error occurs when parsing test data, importing
libraries, and so on.
corresponds to the --exitonerror option of robot
exit-on-failure
Type: Union[bool, Flag, None]
Stops test execution if any test fails.
corresponds to the -X --exitonfailure option of robot
expand-keywords
Type: Optional[List[Union[str, NamePattern, TagPattern]]]
Matching keywords will be automatically expanded in the log file. Matching
against keyword name or tags work using same rules as with --removekeywords.
Examples:
--expandkeywords name:BuiltIn.Log
--expandkeywords tag:expand
corresponds to the --expandkeywords name:
robot
extend-args
Type: Optional[List[str]]
Append extra arguments to be passed to robot.
extend-env
Type: Optional[Dict[str, str]]
Append extra environment variables to be set before tests.
extend-excludes
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --exclude option.
Select test cases not to run by tag. These tests are not run even if included
with --include. Tags are matched using same rules as with --include.
corresponds to the -e --exclude tag * option of robot
extend-expand-keywords
Type: Optional[List[Union[str, NamePattern, TagPattern]]]
Appends entries to the --expandkeywords option.
Matching keywords will be automatically expanded in the log file. Matching
against keyword name or tags work using same rules as with --removekeywords.
Examples:
--expandkeywords name:BuiltIn.Log
--expandkeywords tag:expand
corresponds to the --expandkeywords name:
robot
extend-flatten-keywords
Type: Optional[List[Union[str, Literal['for', 'while', 'iteration'],
NamePattern, TagPattern]]]
Appends entries to the --flattenkeywords option.
Flattens matching keywords in the generated log file. Matching keywords get all
log messages from their child keywords and children are discarded otherwise.
for: flatten FOR loops fully while: flatten WHILE loops fully iteration:
flatten FOR/WHILE loop iterations foritem: deprecated alias for iteration
name:: flatten matched keywords using same matching rules as with
--removekeywords name:
matching rules as with --removekeywords tag:
corresponds to the --flattenkeywords
for|while|iteration|name:
extend-includes
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --include option.
Select tests by tag. Similarly as name with --test, tag is case and space
insensitive and it is possible to use patterns with *, ? and [] as wildcards.
Tags and patterns can also be combined together with AND, OR, and NOT
operators.
Examples:
--include foo --include bar*
--include fooANDbar*
corresponds to the -i --include tag * option of robot
extend-languages
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --language option.
Activate localization. lang can be a name or a code of a built-in language, or a path or a module name of a custom language file.
corresponds to the --language lang * option of rebot
extend-listeners
Type: Optional[Dict[str, List[Union[str, StringExpression]]]]
Appends entries to the --listener option.
Class or module for monitoring test execution. Gets notifications e.g. when
tests start and end. Arguments to the listener class can be given after the
name using a colon or a semicolon as a separator.
Examples:
--listener MyListener
--listener path/to/Listener.py:arg1:arg2
corresponds to the --listener listener * option of rebot
extend-metadata
Type: Optional[Dict[str, Union[str, StringExpression]]]
Appends entries to the --metadata option.
Set metadata of the top level suite. Value can contain formatting and be read
from a file similarly as --doc. Example: --metadata Version:1.2
corresponds to the -M --metadata name:value * option of robot
extend-parse-include
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --parseinclude option.
Parse only files matching pattern. It can be:
ò a file name or pattern like example.robot or *.robot to parse all files
matching that name,
ò a file path like path/to/example.robot, or
ò a directory path like path/to/example to parse all files in that directory,
recursively.
corresponds to the -I --parseinclude pattern * option of robot
extend-parsers
Type: Optional[Dict[str, List[Union[str, StringExpression]]]]
Appends entries to the --parser option.
Custom parser class or module. Parser classes accept arguments the same way as with --listener.
corresponds to the --parser parser * option of rebot
extend-paths
Type: Union[str, List[str], None]
Append extra entries to the paths argument.
Examples:
paths = ["tests"]
extend-pre-rebot-modifiers
Type: Optional[Dict[str, List[Union[str, StringExpression]]]]
Appends entries to the --prerebotmodifier option.
Class to programmatically modify the result model before creating reports and
logs. Accepts arguments the same way as with --listener.
corresponds to the --prerebotmodifier modifier * option of robot
extend-pre-run-modifiers
Type: Optional[Dict[str, List[Union[str, StringExpression]]]]
Appends entries to the --prerunmodifier option.
Class to programmatically modify the suite structure before execution. Accepts arguments the same way as with --listener.
corresponds to the --prerunmodifier modifier * option of rebot
extend-profiles
Type: Optional[Dict[str, RobotProfile]]
Extra execution profiles.
extend-python-path
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --pythonpath option.
Additional locations (directories, ZIPs) where to search libraries and other
extensions when they are imported. Multiple paths can be given by separating
them with a colon (:) or by using this option several times. Given path can
also be a glob pattern matching multiple paths.
Examples:
--pythonpath libs/
--pythonpath /opt/libs:libraries.zip
corresponds to the -P --pythonpath path * option of robot
extend-remove-keywords
Type: Optional[List[Union[str, Literal['all', 'passed', 'for', 'wuks'],
NamePattern, TagPattern]]]
Appends entries to the --removekeywords option.
Remove keyword data from the generated log file. Keywords containing warnings
are not removed except in the all mode. all: remove data from all keywords
passed: remove data only from keywords in passed test cases and suites for:
remove passed iterations from for loops while: remove passed iterations from
while loops wuks: remove all but the last failing keyword inside
BuiltIn.Wait Until Keyword Succeeds name:: remove data from keywords that
match the given pattern. The pattern is matched against the full name of the
keyword (e.g. 'MyLib.Keyword', 'resource.Second Keyword'), is case, space, and
underscore insensitive, and may contain *, ? and [] wildcards.
Examples:
--removekeywords name:Lib.HugeKw
--removekeywords name:myresource.*
tag:: remove data from keywords that match the given pattern. Tags are case
and space insensitive and patterns can contain *, ? and [] wildcards. Tags and
patterns can also be combined together with AND, OR, and NOT operators.
Examples:
--removekeywords foo
--removekeywords fooANDbar*
corresponds to the --removekeywords
all|passed|for|wuks|name:
extend-set-tag
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --settag option.
Sets given tag(s) to all executed tests.
corresponds to the -G --settag tag * option of robot
extend-skip
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --skip option.
Tests having given tag will be skipped. Tag can be a pattern.
corresponds to the --skip tag * option of rebot
extend-skip-on-failure
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --skiponfailure option.
Tests having given tag will be skipped if they fail. Tag can be a pattern
corresponds to the --skiponfailure tag * option of rebot
extend-suites
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --suite option.
Select suites by name. When this option is used with --test, --include or
--exclude, only tests in matching suites and also matching other filtering
criteria are selected. Name can be a simple pattern similarly as with --test
and it can contain parent name separated with a dot. For example, -s X.Y
selects suite Y only if its parent is X.
corresponds to the -s --suite name * option of robot
extend-tag-doc
Type: Optional[Dict[str, Union[str, StringExpression]]]
Appends entries to the --tagdoc option.
Add documentation to tags matching the given pattern. Documentation is shown in
Test Details and also as a tooltip in Statistics by Tag. Pattern can use *, ?
and [] as wildcards like --test. Documentation can contain formatting like
--doc.
Examples:
--tagdoc mytag:Example
--tagdoc "owner-*:Original author"
corresponds to the --tagdoc pattern:doc * option of robot
extend-tag-stat-combine
Type: Optional[List[Union[str, Dict[str, str]]]]
Appends entries to the --tagstatcombine option.
Create combined statistics based on tags. These statistics are added into
Statistics by Tag. If the optional name is not given, name of the combined tag
is got from the specified tags. Tags are matched using the same rules as with
--include.
Examples:
--tagstatcombine requirement-*
--tagstatcombine tag1ANDtag2:My_name
corresponds to the --tagstatcombine tags:name * option of robot
extend-tag-stat-exclude
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --tagstatexclude option.
Exclude matching tags from Statistics by Tag. This option can be used with
--tagstatinclude similarly as --exclude is used with --include.
corresponds to the --tagstatexclude tag * option of robot
extend-tag-stat-include
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --tagstatinclude option.
Include only matching tags in Statistics by Tag in log and report. By default
all tags are shown. Given tag can be a pattern like with --include.
corresponds to the --tagstatinclude tag * option of robot
extend-tag-stat-link
Type: Optional[Dict[str, Union[str, StringExpression]]]
Appends entries to the --tagstatlink option.
Add external links into Statistics by Tag. Pattern can use *, ? and [] as
wildcards like --test. Characters matching to * and ? wildcards can be used in
link and title with syntax %N, where N is index of the match (starting from 1).
Examples:
--tagstatlink mytag:http://my.domain:Title
--tagstatlink "bug-*:http://url/id=%1:Issue Tracker"
corresponds to the --tagstatlink pattern
title * option of robot
extend-tasks
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --task option.
Alias to --test. Especially applicable with --rpa.
corresponds to the --task name * option of robot
extend-tests
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --test option.
Select tests by name or by long name containing also parent suite name like
Parent.Test. Name is case and space insensitive and it can also be a simple
pattern where * matches anything, ? matches any single character, and [chars]
matches one character in brackets.
corresponds to the -t --test name * option of robot
extend-variable-files
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --variablefile option.
Python or YAML file file to read variables from. Possible arguments to the
variable file can be given after the path using colon or semicolon as
separator.
Examples:
--variablefile path/vars.yaml
--variablefile environment.py:testing
corresponds to the -V --variablefile path * option of rebot
extend-variables
Type: Optional[Dict[str, Union[str, StringExpression]]]
Appends entries to the --variable option.
Set variables in the test data. Only scalar variables with string value are
supported and name is given without ${}. See --variablefile for a more powerful
variable setting mechanism.
Examples:
--variable name:Robot => ${name} = Robot
-v "hello:Hello world" => ${hello} = Hello world
-v x: -v y:42 => ${x} = `, ${y} =42`
corresponds to the -v --variable name:value * option of rebot
extensions
Type: Union[str, StringExpression, None]
Parse only files with this extension when executing a directory. Has no effect
when running individual files or when using resource files. If more than one
extension is needed, separate them with a colon.
Examples:
--extension txt, --extension robot:txt
Only *.robot files are parsed by default.
corresponds to the -F --extension value option of robot
flatten-keywords
Type: Optional[List[Union[str, Literal['for', 'while', 'iteration'],
NamePattern, TagPattern]]]
Flattens matching keywords in the generated log file. Matching keywords get all
log messages from their child keywords and children are discarded otherwise.
for: flatten FOR loops fully while: flatten WHILE loops fully iteration:
flatten FOR/WHILE loop iterations foritem: deprecated alias for iteration
name:: flatten matched keywords using same matching rules as with
--removekeywords name:
matching rules as with --removekeywords tag:
corresponds to the --flattenkeywords
for|while|iteration|name:
includes
Type: Optional[List[Union[str, StringExpression]]]
Select tests by tag. Similarly as name with --test, tag is case and space
insensitive and it is possible to use patterns with *, ? and [] as wildcards.
Tags and patterns can also be combined together with AND, OR, and NOT
operators.
Examples:
--include foo --include bar*
--include fooANDbar*
corresponds to the -i --include tag * option of robot
languages
Type: Optional[List[Union[str, StringExpression]]]
Activate localization. lang can be a name or a code of a built-in language, or a path or a module name of a custom language file.
corresponds to the --language lang * option of robot
libdoc
Type: Optional[LibDocProfile]
Options to be passed to libdoc.
libdoc.doc-format
Type: Optional[Literal['ROBOT', 'HTML', 'TEXT', 'REST']]
Specifies the source documentation format. Possible values are Robot
Framework's documentation format, HTML, plain text, and reStructuredText. The
default value can be specified in library source code and the initial default
value is ROBOT.
corresponds to the -F --docformat ROBOT|HTML|TEXT|REST option of libdoc
libdoc.extend-python-path
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --pythonpath option.
Additional locations where to search for libraries and resources.
corresponds to the -P --pythonpath path * option of libdoc
libdoc.format
Type: Optional[Literal['HTML', 'XML', 'JSON', 'LIBSPEC']]
Specifies whether to generate an HTML output for humans or a machine readable
spec file in XML or JSON format. The LIBSPEC format means XML spec with
documentations converted to HTML. The default format is got from the output
file extension.
corresponds to the -f --format HTML|XML|JSON|LIBSPEC option of libdoc
libdoc.name
Type: Union[str, StringExpression, None]
Sets the name of the documented library or resource.
corresponds to the -n --name name option of libdoc
libdoc.python-path
Type: Optional[List[Union[str, StringExpression]]]
Additional locations where to search for libraries and resources.
corresponds to the -P --pythonpath path * option of libdoc
libdoc.quiet
Type: Union[bool, Flag, None]
Do not print the path of the generated output file to the console. New in RF
4.0.
corresponds to the --quiet option of libdoc
libdoc.spec-doc-format
Type: Optional[Literal['RAW', 'HTML']]
Specifies the documentation format used with XML and JSON spec files. RAW means
preserving the original documentation format and HTML means converting
documentation to HTML. The default is RAW with XML spec files and HTML with
JSON specs and when using the special LIBSPEC format. New in RF 4.0.
corresponds to the -s --specdocformat RAW|HTML option of libdoc
libdoc.theme
Type: Optional[Literal['DARK', 'LIGHT', 'NONE']]
Use dark or light HTML theme. If this option is not used, or the value is NONE, the theme is selected based on the browser color scheme. New in RF 6.0.
corresponds to the --theme DARK|LIGHT|NONE option of libdoc
listeners
Type: Optional[Dict[str, List[Union[str, StringExpression]]]]
Class or module for monitoring test execution. Gets notifications e.g. when
tests start and end. Arguments to the listener class can be given after the
name using a colon or a semicolon as a separator.
Examples:
--listener MyListener
--listener path/to/Listener.py:arg1:arg2
corresponds to the --listener listener * option of robot
log
Type: Union[str, StringExpression, None]
HTML log file. Can be disabled by giving a special value NONE. Default:
log.html
Examples:
--log mylog.html, -l NONE
corresponds to the -l --log file option of robot
log-level
Type: Union[str, StringExpression, None]
Threshold level for logging. Available levels: TRACE, DEBUG, INFO (default),
WARN, NONE (no logging). Use syntax LOGLEVEL:DEFAULT to define the default
visible log level in log files.
Examples:
--loglevel DEBUG
--loglevel DEBUG:INFO
corresponds to the -L --loglevel level option of robot
log-title
Type: Union[str, StringExpression, None]
Title for the generated log file. The default title is
corresponds to the --logtitle title option of robot
max-assign-length
Type: Optional[int]
Maximum number of characters to show in log when variables are assigned. Zero
or negative values can be used to avoid showing assigned values at all. Default
is 200.
corresponds to the --maxassignlength characters option of robot
max-error-lines
Type: Optional[int]
Maximum number of error message lines to show in report when tests fail.
Default is 40, minimum is 10 and NONE can be used to show the full message.
corresponds to the --maxerrorlines lines option of robot
metadata
Type: Optional[Dict[str, Union[str, StringExpression]]]
Set metadata of the top level suite. Value can contain formatting and be read
from a file similarly as --doc. Example: --metadata Version:1.2
corresponds to the -M --metadata name:value * option of robot
name
Type: Union[str, StringExpression, None]
Set the name of the top level suite. By default the name is created based on
the executed file or directory.
corresponds to the -N --name name option of robot
no-status-rc
Type: Union[bool, Flag, None]
Sets the return code to zero regardless of failures in test cases. Error codes are returned normally.
corresponds to the --nostatusrc option of robot
output
Type: Union[str, StringExpression, None]
XML output file. Given path, similarly as paths given to --log, --report,
--xunit, and --debugfile, is relative to --outputdir unless given as an
absolute path. Other output files are created based on XML output files after
the test execution and XML outputs can also be further processed with Rebot
tool. Can be disabled by giving a special value NONE. Default: output.xml
corresponds to the -o --output file option of robot
output-dir
Type: Union[str, StringExpression, None]
Where to create output files. The default is the directory where tests are run from and the given path is considered relative to that unless it is absolute.
corresponds to the -d --outputdir dir option of robot
parse-include
Type: Optional[List[Union[str, StringExpression]]]
Parse only files matching pattern. It can be:
ò a file name or pattern like example.robot or *.robot to parse all files
matching that name,
ò a file path like path/to/example.robot, or
ò a directory path like path/to/example to parse all files in that directory,
recursively.
corresponds to the -I --parseinclude pattern * option of robot
parsers
Type: Optional[Dict[str, List[Union[str, StringExpression]]]]
Custom parser class or module. Parser classes accept arguments the same way as with --listener.
corresponds to the --parser parser * option of robot
paths
Type: Union[str, List[str], None]
Specifies the paths where robot/robotcode should discover tests. If no paths
are given at the command line this value is used.
Examples:
paths = ["tests"]
Corresponds to the paths argument of robot.
pre-rebot-modifiers
Type: Optional[Dict[str, List[Union[str, StringExpression]]]]
Class to programmatically modify the result model before creating reports and
logs. Accepts arguments the same way as with --listener.
corresponds to the --prerebotmodifier modifier * option of robot
pre-run-modifiers
Type: Optional[Dict[str, List[Union[str, StringExpression]]]]
Class to programmatically modify the suite structure before execution. Accepts arguments the same way as with --listener.
corresponds to the --prerunmodifier modifier * option of robot
profiles
Type: Optional[Dict[str, RobotProfile]]
Execution profiles.
python-path
Type: Optional[List[Union[str, StringExpression]]]
Additional locations (directories, ZIPs) where to search libraries and other
extensions when they are imported. Multiple paths can be given by separating
them with a colon (:) or by using this option several times. Given path can
also be a glob pattern matching multiple paths.
Examples:
--pythonpath libs/
--pythonpath /opt/libs:libraries.zip
corresponds to the -P --pythonpath path * option of robot
quiet
Type: Union[bool, Flag, None]
Shortcut for --console quiet.
corresponds to the --quiet option of robot
randomize
Type: Union[str, Literal['all', 'suites', 'tests', 'none'], None]
Randomizes the test execution order. all: randomizes both suites and tests
suites: randomizes suites tests: randomizes tests none: no randomization
(default) Use syntax VALUE:SEED to give a custom random seed. The seed must be
an integer.
Examples:
--randomize all
--randomize tests:1234
corresponds to the --randomize all|suites|tests|none option of robot
re-run-failed
Type: Union[str, StringExpression, None]
Select failed tests from an earlier output file to be re-executed. Equivalent
to selecting same tests individually using --test.
corresponds to the -R --rerunfailed output option of robot
re-run-failed-suites
Type: Union[str, StringExpression, None]
Select failed suites from an earlier output file to be re-executed.
corresponds to the -S --rerunfailedsuites output option of robot
rebot
Type: Optional[RebotProfile]
Options to be passed to rebot.
rebot.console-colors
Type: Optional[Literal['auto', 'on', 'ansi', 'off']]
Use colors on console output or not. auto: use colors when output not
redirected (default) on: always use colors ansi: like on but use ANSI colors
also on Windows off: disable colors altogether
corresponds to the -C --consolecolors auto|on|ansi|off option of robot
rebot.doc
Type: Union[str, StringExpression, None]
Set the documentation of the top level suite. Simple formatting is supported
(e.g. bold). If the documentation contains spaces, it must be quoted. If the
value is path to an existing file, actual documentation is read from that file.
Examples:
--doc "Very good example"
--doc doc_from_file.txt
corresponds to the -D --doc documentation option of robot
rebot.end-time
Type: Union[str, StringExpression, None]
Same as --starttime but for end time. If both options are used, elapsed time of
the suite is calculated based on them. For combined suites, it is otherwise
calculated by adding elapsed times of the combined suites together.
corresponds to the --endtime timestamp option of rebot
rebot.excludes
Type: Optional[List[Union[str, StringExpression]]]
Select test cases not to run by tag. These tests are not run even if included
with --include. Tags are matched using same rules as with --include.
corresponds to the -e --exclude tag * option of robot
rebot.expand-keywords
Type: Optional[List[Union[str, NamePattern, TagPattern]]]
Matching keywords will be automatically expanded in the log file. Matching
against keyword name or tags work using same rules as with --removekeywords.
Examples:
--expandkeywords name:BuiltIn.Log
--expandkeywords tag:expand
corresponds to the --expandkeywords name:
robot
rebot.extend-excludes
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --exclude option.
Select test cases not to run by tag. These tests are not run even if included
with --include. Tags are matched using same rules as with --include.
corresponds to the -e --exclude tag * option of robot
rebot.extend-expand-keywords
Type: Optional[List[Union[str, NamePattern, TagPattern]]]
Appends entries to the --expandkeywords option.
Matching keywords will be automatically expanded in the log file. Matching
against keyword name or tags work using same rules as with --removekeywords.
Examples:
--expandkeywords name:BuiltIn.Log
--expandkeywords tag:expand
corresponds to the --expandkeywords name:
robot
rebot.extend-flatten-keywords
Type: Optional[List[Union[str, Literal['for', 'while', 'iteration'],
NamePattern, TagPattern]]]
Appends entries to the --flattenkeywords option.
Flattens matching keywords in the generated log file. Matching keywords get all
log messages from their child keywords and children are discarded otherwise.
for: flatten FOR loops fully while: flatten WHILE loops fully iteration:
flatten FOR/WHILE loop iterations foritem: deprecated alias for iteration
name:: flatten matched keywords using same matching rules as with
--removekeywords name:
matching rules as with --removekeywords tag:
corresponds to the --flattenkeywords
for|while|iteration|name:
rebot.extend-includes
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --include option.
Select tests by tag. Similarly as name with --test, tag is case and space
insensitive and it is possible to use patterns with *, ? and [] as wildcards.
Tags and patterns can also be combined together with AND, OR, and NOT
operators.
Examples:
--include foo --include bar*
--include fooANDbar*
corresponds to the -i --include tag * option of robot
rebot.extend-metadata
Type: Optional[Dict[str, Union[str, StringExpression]]]
Appends entries to the --metadata option.
Set metadata of the top level suite. Value can contain formatting and be read
from a file similarly as --doc. Example: --metadata Version:1.2
corresponds to the -M --metadata name:value * option of robot
rebot.extend-parse-include
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --parseinclude option.
Parse only files matching pattern. It can be:
ò a file name or pattern like example.robot or *.robot to parse all files
matching that name,
ò a file path like path/to/example.robot, or
ò a directory path like path/to/example to parse all files in that directory,
recursively.
corresponds to the -I --parseinclude pattern * option of robot
rebot.extend-pre-rebot-modifiers
Type: Optional[Dict[str, List[Union[str, StringExpression]]]]
Appends entries to the --prerebotmodifier option.
Class to programmatically modify the result model before creating reports and
logs. Accepts arguments the same way as with --listener.
corresponds to the --prerebotmodifier modifier * option of robot
rebot.extend-python-path
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --pythonpath option.
Additional locations (directories, ZIPs) where to search libraries and other
extensions when they are imported. Multiple paths can be given by separating
them with a colon (:) or by using this option several times. Given path can
also be a glob pattern matching multiple paths.
Examples:
--pythonpath libs/
--pythonpath /opt/libs:libraries.zip
corresponds to the -P --pythonpath path * option of robot
rebot.extend-remove-keywords
Type: Optional[List[Union[str, Literal['all', 'passed', 'for', 'wuks'],
NamePattern, TagPattern]]]
Appends entries to the --removekeywords option.
Remove keyword data from the generated log file. Keywords containing warnings
are not removed except in the all mode. all: remove data from all keywords
passed: remove data only from keywords in passed test cases and suites for:
remove passed iterations from for loops while: remove passed iterations from
while loops wuks: remove all but the last failing keyword inside
BuiltIn.Wait Until Keyword Succeeds name:: remove data from keywords that
match the given pattern. The pattern is matched against the full name of the
keyword (e.g. 'MyLib.Keyword', 'resource.Second Keyword'), is case, space, and
underscore insensitive, and may contain *, ? and [] wildcards.
Examples:
--removekeywords name:Lib.HugeKw
--removekeywords name:myresource.*
tag:: remove data from keywords that match the given pattern. Tags are case
and space insensitive and patterns can contain *, ? and [] wildcards. Tags and
patterns can also be combined together with AND, OR, and NOT operators.
Examples:
--removekeywords foo
--removekeywords fooANDbar*
corresponds to the --removekeywords
all|passed|for|wuks|name:
rebot.extend-set-tag
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --settag option.
Sets given tag(s) to all executed tests.
corresponds to the -G --settag tag * option of robot
rebot.extend-suites
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --suite option.
Select suites by name. When this option is used with --test, --include or
--exclude, only tests in matching suites and also matching other filtering
criteria are selected. Name can be a simple pattern similarly as with --test
and it can contain parent name separated with a dot. For example, -s X.Y
selects suite Y only if its parent is X.
corresponds to the -s --suite name * option of robot
rebot.extend-tag-doc
Type: Optional[Dict[str, Union[str, StringExpression]]]
Appends entries to the --tagdoc option.
Add documentation to tags matching the given pattern. Documentation is shown in
Test Details and also as a tooltip in Statistics by Tag. Pattern can use *, ?
and [] as wildcards like --test. Documentation can contain formatting like
--doc.
Examples:
--tagdoc mytag:Example
--tagdoc "owner-*:Original author"
corresponds to the --tagdoc pattern:doc * option of robot
rebot.extend-tag-stat-combine
Type: Optional[List[Union[str, Dict[str, str]]]]
Appends entries to the --tagstatcombine option.
Create combined statistics based on tags. These statistics are added into
Statistics by Tag. If the optional name is not given, name of the combined tag
is got from the specified tags. Tags are matched using the same rules as with
--include.
Examples:
--tagstatcombine requirement-*
--tagstatcombine tag1ANDtag2:My_name
corresponds to the --tagstatcombine tags:name * option of robot
rebot.extend-tag-stat-exclude
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --tagstatexclude option.
Exclude matching tags from Statistics by Tag. This option can be used with
--tagstatinclude similarly as --exclude is used with --include.
corresponds to the --tagstatexclude tag * option of robot
rebot.extend-tag-stat-include
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --tagstatinclude option.
Include only matching tags in Statistics by Tag in log and report. By default
all tags are shown. Given tag can be a pattern like with --include.
corresponds to the --tagstatinclude tag * option of robot
rebot.extend-tag-stat-link
Type: Optional[Dict[str, Union[str, StringExpression]]]
Appends entries to the --tagstatlink option.
Add external links into Statistics by Tag. Pattern can use *, ? and [] as
wildcards like --test. Characters matching to * and ? wildcards can be used in
link and title with syntax %N, where N is index of the match (starting from 1).
Examples:
--tagstatlink mytag:http://my.domain:Title
--tagstatlink "bug-*:http://url/id=%1:Issue Tracker"
corresponds to the --tagstatlink patterntitle * option of robot
rebot.extend-tasks
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --task option.
Alias to --test. Especially applicable with --rpa.
corresponds to the --task name * option of robot
rebot.extend-tests
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --test option.
Select tests by name or by long name containing also parent suite name like
Parent.Test. Name is case and space insensitive and it can also be a simple
pattern where * matches anything, ? matches any single character, and [chars]
matches one character in brackets.
corresponds to the -t --test name * option of robot
rebot.flatten-keywords
Type: Optional[List[Union[str, Literal['for', 'while', 'iteration'],
NamePattern, TagPattern]]]
Flattens matching keywords in the generated log file. Matching keywords get all
log messages from their child keywords and children are discarded otherwise.
for: flatten FOR loops fully while: flatten WHILE loops fully iteration:
flatten FOR/WHILE loop iterations foritem: deprecated alias for iteration
name:: flatten matched keywords using same matching rules as with
--removekeywords name:
matching rules as with --removekeywords tag:
corresponds to the --flattenkeywords
for|while|iteration|name:
rebot.includes
Type: Optional[List[Union[str, StringExpression]]]
Select tests by tag. Similarly as name with --test, tag is case and space
insensitive and it is possible to use patterns with *, ? and [] as wildcards.
Tags and patterns can also be combined together with AND, OR, and NOT
operators.
Examples:
--include foo --include bar*
--include fooANDbar*
corresponds to the -i --include tag * option of robot
rebot.log
Type: Union[str, StringExpression, None]
HTML log file. Can be disabled by giving a special value NONE. Default:
log.html
Examples:
--log mylog.html, -l NONE
corresponds to the -l --log file option of robot
rebot.log-level
Type: Union[str, StringExpression, None]
Threshold for selecting messages. Available levels: TRACE (default), DEBUG,
INFO, WARN, NONE (no msgs). Use syntax LOGLEVEL:DEFAULT to define the default
visible log level in log files.
Examples:
--loglevel DEBUG
--loglevel DEBUG:INFO
corresponds to the -L --loglevel level option of rebot
rebot.log-title
Type: Union[str, StringExpression, None]
Title for the generated log file. The default title is
corresponds to the --logtitle title option of robot
rebot.merge
Type: Union[bool, Flag, None]
When combining results, merge outputs together instead of putting them under a new top level suite. Example: rebot --merge orig.xml rerun.xml
corresponds to the -R --merge option of rebot
rebot.metadata
Type: Optional[Dict[str, Union[str, StringExpression]]]
Set metadata of the top level suite. Value can contain formatting and be read
from a file similarly as --doc. Example: --metadata Version:1.2
corresponds to the -M --metadata name:value * option of robot
rebot.name
Type: Union[str, StringExpression, None]
Set the name of the top level suite. By default the name is created based on
the executed file or directory.
corresponds to the -N --name name option of robot
rebot.no-status-rc
Type: Union[bool, Flag, None]
Sets the return code to zero regardless of failures in test cases. Error codes are returned normally.
corresponds to the --nostatusrc option of robot
rebot.output
Type: Union[str, StringExpression, None]
XML output file. Not created unless this option is specified. Given path,
similarly as paths given to --log, --report and --xunit, is relative to
--outputdir unless given as an absolute path.
corresponds to the -o --output file option of rebot
rebot.output-dir
Type: Union[str, StringExpression, None]
Where to create output files. The default is the directory where tests are run from and the given path is considered relative to that unless it is absolute.
corresponds to the -d --outputdir dir option of robot
rebot.parse-include
Type: Optional[List[Union[str, StringExpression]]]
Parse only files matching pattern. It can be:
ò a file name or pattern like example.robot or *.robot to parse all files
matching that name,
ò a file path like path/to/example.robot, or
ò a directory path like path/to/example to parse all files in that directory,
recursively.
corresponds to the -I --parseinclude pattern * option of robot
rebot.pre-rebot-modifiers
Type: Optional[Dict[str, List[Union[str, StringExpression]]]]
Class to programmatically modify the result model before creating reports and
logs. Accepts arguments the same way as with --listener.
corresponds to the --prerebotmodifier modifier * option of robot
rebot.process-empty-suite
Type: Union[bool, Flag, None]
Processes output also if the top level suite is empty. Useful e.g. with
--include/--exclude when it is not an error that there are no matches. Use
--skiponfailure when starting execution instead.
corresponds to the --processemptysuite option of rebot
rebot.python-path
Type: Optional[List[Union[str, StringExpression]]]
Additional locations (directories, ZIPs) where to search libraries and other
extensions when they are imported. Multiple paths can be given by separating
them with a colon (:) or by using this option several times. Given path can
also be a glob pattern matching multiple paths.
Examples:
--pythonpath libs/
--pythonpath /opt/libs:libraries.zip
corresponds to the -P --pythonpath path * option of robot
rebot.remove-keywords
Type: Optional[List[Union[str, Literal['all', 'passed', 'for', 'wuks'],
NamePattern, TagPattern]]]
Remove keyword data from the generated log file. Keywords containing warnings
are not removed except in the all mode. all: remove data from all keywords
passed: remove data only from keywords in passed test cases and suites for:
remove passed iterations from for loops while: remove passed iterations from
while loops wuks: remove all but the last failing keyword inside
BuiltIn.Wait Until Keyword Succeeds name:: remove data from keywords that
match the given pattern. The pattern is matched against the full name of the
keyword (e.g. 'MyLib.Keyword', 'resource.Second Keyword'), is case, space, and
underscore insensitive, and may contain *, ? and [] wildcards.
Examples:
--removekeywords name:Lib.HugeKw
--removekeywords name:myresource.*
tag:: remove data from keywords that match the given pattern. Tags are case
and space insensitive and patterns can contain *, ? and [] wildcards. Tags and
patterns can also be combined together with AND, OR, and NOT operators.
Examples:
--removekeywords foo
--removekeywords fooANDbar*
corresponds to the --removekeywords
all|passed|for|wuks|name:
rebot.report
Type: Union[str, StringExpression, None]
HTML report file. Can be disabled with NONE similarly as --log. Default:
report.html
corresponds to the -r --report file option of robot
rebot.report-background
Type: Union[str, StringExpression, None]
Background colors to use in the report file. Given in format
passed:failed:skipped where the :skipped part can be omitted. Both color names
and codes work.
Examples:
--reportbackground green:red:yellow
--reportbackground #00E:#E00
corresponds to the --reportbackground colors option of robot
rebot.report-title
Type: Union[str, StringExpression, None]
Title for the generated report file. The default title is
corresponds to the --reporttitle title option of robot
rebot.rpa
Type: Union[bool, Flag, None]
Turn on the generic automation mode. Mainly affects terminology so that "test"
is replaced with "task" in logs and reports. By default the mode is got from
test/task header in data files.
corresponds to the --rpa option of robot
rebot.set-tag
Type: Optional[List[Union[str, StringExpression]]]
Sets given tag(s) to all executed tests.
corresponds to the -G --settag tag * option of robot
rebot.split-log
Type: Union[bool, Flag, None]
Split the log file into smaller pieces that open in browsers transparently.
corresponds to the --splitlog option of robot
rebot.start-time
Type: Union[str, StringExpression, None]
Set execution start time. Timestamp must be given in format 2007-10-01
15:12:42.268 where all separators are optional (e.g. 20071001151242268 is ok
too) and parts from milliseconds to hours can be omitted if they are zero (e.g.
2007-10-01). This can be used to override start time of a single suite or to
set start time for a combined suite, which would otherwise be N/A.
corresponds to the --starttime timestamp option of rebot
rebot.suite-stat-level
Type: Optional[int]
How many levels to show in Statistics by Suite in log and report. By default
all suite levels are shown. Example: --suitestatlevel 3
corresponds to the --suitestatlevel level option of robot
rebot.suites
Type: Optional[List[Union[str, StringExpression]]]
Select suites by name. When this option is used with --test, --include or
--exclude, only tests in matching suites and also matching other filtering
criteria are selected. Name can be a simple pattern similarly as with --test
and it can contain parent name separated with a dot. For example, -s X.Y
selects suite Y only if its parent is X.
corresponds to the -s --suite name * option of robot
rebot.tag-doc
Type: Optional[Dict[str, Union[str, StringExpression]]]
Add documentation to tags matching the given pattern. Documentation is shown in
Test Details and also as a tooltip in Statistics by Tag. Pattern can use *, ?
and [] as wildcards like --test. Documentation can contain formatting like
--doc.
Examples:
--tagdoc mytag:Example
--tagdoc "owner-*:Original author"
corresponds to the --tagdoc pattern:doc * option of robot
rebot.tag-stat-combine
Type: Optional[List[Union[str, Dict[str, str]]]]
Create combined statistics based on tags. These statistics are added into
Statistics by Tag. If the optional name is not given, name of the combined tag
is got from the specified tags. Tags are matched using the same rules as with
--include.
Examples:
--tagstatcombine requirement-*
--tagstatcombine tag1ANDtag2:My_name
corresponds to the --tagstatcombine tags:name * option of robot
rebot.tag-stat-exclude
Type: Optional[List[Union[str, StringExpression]]]
Exclude matching tags from Statistics by Tag. This option can be used with
--tagstatinclude similarly as --exclude is used with --include.
corresponds to the --tagstatexclude tag * option of robot
rebot.tag-stat-include
Type: Optional[List[Union[str, StringExpression]]]
Include only matching tags in Statistics by Tag in log and report. By default
all tags are shown. Given tag can be a pattern like with --include.
corresponds to the --tagstatinclude tag * option of robot
rebot.tag-stat-link
Type: Optional[Dict[str, Union[str, StringExpression]]]
Add external links into Statistics by Tag. Pattern can use *, ? and [] as
wildcards like --test. Characters matching to * and ? wildcards can be used in
link and title with syntax %N, where N is index of the match (starting from 1).
Examples:
--tagstatlink mytag:http://my.domain:Title
--tagstatlink "bug-*:http://url/id=%1:Issue Tracker"
corresponds to the --tagstatlink patterntitle * option of robot
rebot.tasks
Type: Optional[List[Union[str, StringExpression]]]
Alias to --test. Especially applicable with --rpa.
corresponds to the --task name * option of robot
rebot.tests
Type: Optional[List[Union[str, StringExpression]]]
Select tests by name or by long name containing also parent suite name like
Parent.Test. Name is case and space insensitive and it can also be a simple
pattern where * matches anything, ? matches any single character, and [chars]
matches one character in brackets.
corresponds to the -t --test name * option of robot
rebot.timestamp-outputs
Type: Union[bool, Flag, None]
When this option is used, timestamp in a format YYYYMMDD-hhmmss is added to all generated output files between their basename and extension. For example -T -o output.xml -r report.html -l none creates files like output-20070503-154410.xml and report-20070503-154410.html.
corresponds to the -T --timestampoutputs option of robot
rebot.xunit
Type: Union[str, StringExpression, None]
xUnit compatible result file. Not created unless this option is specified.
corresponds to the -x --xunit file option of robot
remove-keywords
Type: Optional[List[Union[str, Literal['all', 'passed', 'for', 'wuks'],
NamePattern, TagPattern]]]
Remove keyword data from the generated log file. Keywords containing warnings
are not removed except in the all mode. all: remove data from all keywords
passed: remove data only from keywords in passed test cases and suites for:
remove passed iterations from for loops while: remove passed iterations from
while loops wuks: remove all but the last failing keyword inside
BuiltIn.Wait Until Keyword Succeeds name:: remove data from keywords that
match the given pattern. The pattern is matched against the full name of the
keyword (e.g. 'MyLib.Keyword', 'resource.Second Keyword'), is case, space, and
underscore insensitive, and may contain *, ? and [] wildcards.
Examples:
--removekeywords name:Lib.HugeKw
--removekeywords name:myresource.*
tag:: remove data from keywords that match the given pattern. Tags are case
and space insensitive and patterns can contain *, ? and [] wildcards. Tags and
patterns can also be combined together with AND, OR, and NOT operators.
Examples:
--removekeywords foo
--removekeywords fooANDbar*
corresponds to the --removekeywords
all|passed|for|wuks|name:
report
Type: Union[str, StringExpression, None]
HTML report file. Can be disabled with NONE similarly as --log. Default:
report.html
corresponds to the -r --report file option of robot
report-background
Type: Union[str, StringExpression, None]
Background colors to use in the report file. Given in format
passed:failed:skipped where the :skipped part can be omitted. Both color names
and codes work.
Examples:
--reportbackground green:red:yellow
--reportbackground #00E:#E00
corresponds to the --reportbackground colors option of robot
report-title
Type: Union[str, StringExpression, None]
Title for the generated report file. The default title is
corresponds to the --reporttitle title option of robot
rpa
Type: Union[bool, Flag, None]
Turn on the generic automation mode. Mainly affects terminology so that "test"
is replaced with "task" in logs and reports. By default the mode is got from
test/task header in data files.
corresponds to the --rpa option of robot
run-empty-suite
Type: Union[bool, Flag, None]
Executes suite even if it contains no tests. Useful e.g. with
--include/--exclude when it is not an error that no test matches the condition.
corresponds to the --runemptysuite option of robot
set-tag
Type: Optional[List[Union[str, StringExpression]]]
Sets given tag(s) to all executed tests.
corresponds to the -G --settag tag * option of robot
skip
Type: Optional[List[Union[str, StringExpression]]]
Tests having given tag will be skipped. Tag can be a pattern.
corresponds to the --skip tag * option of robot
skip-on-failure
Type: Optional[List[Union[str, StringExpression]]]
Tests having given tag will be skipped if they fail. Tag can be a pattern
corresponds to the --skiponfailure tag * option of robot
skip-teardown-on-exit
Type: Union[bool, Flag, None]
Causes teardowns to be skipped if test execution is stopped prematurely.
corresponds to the --skipteardownonexit option of robot
split-log
Type: Union[bool, Flag, None]
Split the log file into smaller pieces that open in browsers transparently.
corresponds to the --splitlog option of robot
suite-stat-level
Type: Optional[int]
How many levels to show in Statistics by Suite in log and report. By default
all suite levels are shown. Example: --suitestatlevel 3
corresponds to the --suitestatlevel level option of robot
suites
Type: Optional[List[Union[str, StringExpression]]]
Select suites by name. When this option is used with --test, --include or
--exclude, only tests in matching suites and also matching other filtering
criteria are selected. Name can be a simple pattern similarly as with --test
and it can contain parent name separated with a dot. For example, -s X.Y
selects suite Y only if its parent is X.
corresponds to the -s --suite name * option of robot
tag-doc
Type: Optional[Dict[str, Union[str, StringExpression]]]
Add documentation to tags matching the given pattern. Documentation is shown in
Test Details and also as a tooltip in Statistics by Tag. Pattern can use *, ?
and [] as wildcards like --test. Documentation can contain formatting like
--doc.
Examples:
--tagdoc mytag:Example
--tagdoc "owner-*:Original author"
corresponds to the --tagdoc pattern:doc * option of robot
tag-stat-combine
Type: Optional[List[Union[str, Dict[str, str]]]]
Create combined statistics based on tags. These statistics are added into
Statistics by Tag. If the optional name is not given, name of the combined tag
is got from the specified tags. Tags are matched using the same rules as with
--include.
Examples:
--tagstatcombine requirement-*
--tagstatcombine tag1ANDtag2:My_name
corresponds to the --tagstatcombine tags:name * option of robot
tag-stat-exclude
Type: Optional[List[Union[str, StringExpression]]]
Exclude matching tags from Statistics by Tag. This option can be used with
--tagstatinclude similarly as --exclude is used with --include.
corresponds to the --tagstatexclude tag * option of robot
tag-stat-include
Type: Optional[List[Union[str, StringExpression]]]
Include only matching tags in Statistics by Tag in log and report. By default
all tags are shown. Given tag can be a pattern like with --include.
corresponds to the --tagstatinclude tag * option of robot
tag-stat-link
Type: Optional[Dict[str, Union[str, StringExpression]]]
Add external links into Statistics by Tag. Pattern can use *, ? and [] as
wildcards like --test. Characters matching to * and ? wildcards can be used in
link and title with syntax %N, where N is index of the match (starting from 1).
Examples:
--tagstatlink mytag:http://my.domain:Title
--tagstatlink "bug-*:http://url/id=%1:Issue Tracker"
corresponds to the --tagstatlink patterntitle * option of robot
tasks
Type: Optional[List[Union[str, StringExpression]]]
Alias to --test. Especially applicable with --rpa.
corresponds to the --task name * option of robot
testdoc
Type: Optional[TestDocProfile]
Options to be passed to testdoc.
testdoc.doc
Type: Union[str, StringExpression, None]
Override the documentation of the top level suite.
corresponds to the -D --doc document option of testdoc
testdoc.excludes
Type: Optional[List[Union[str, StringExpression]]]
Exclude tests by tags.
corresponds to the -e --exclude tag * option of testdoc
testdoc.extend-excludes
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --exclude option.
Exclude tests by tags.
corresponds to the -e --exclude tag * option of testdoc
testdoc.extend-includes
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --include option.
Include tests by tags.
corresponds to the -i --include tag * option of testdoc
testdoc.extend-metadata
Type: Optional[Dict[str, Union[str, StringExpression]]]
Appends entries to the --metadata option.
Set/override metadata of the top level suite.
corresponds to the -M --metadata name:value * option of testdoc
testdoc.extend-set-tag
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --settag option.
Set given tag(s) to all test cases.
corresponds to the -G --settag tag * option of testdoc
testdoc.extend-suites
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --suite option.
Include suites by name.
corresponds to the -s --suite name * option of testdoc
testdoc.extend-tests
Type: Optional[List[Union[str, StringExpression]]]
Appends entries to the --test option.
Include tests by name.
corresponds to the -t --test name * option of testdoc
testdoc.includes
Type: Optional[List[Union[str, StringExpression]]]
Include tests by tags.
corresponds to the -i --include tag * option of testdoc
testdoc.metadata
Type: Optional[Dict[str, Union[str, StringExpression]]]
Set/override metadata of the top level suite.
corresponds to the -M --metadata name:value * option of testdoc
testdoc.name
Type: Union[str, StringExpression, None]
Override the name of the top level suite.
corresponds to the -N --name name option of testdoc
testdoc.set-tag
Type: Optional[List[Union[str, StringExpression]]]
Set given tag(s) to all test cases.
corresponds to the -G --settag tag * option of testdoc
testdoc.suites
Type: Optional[List[Union[str, StringExpression]]]
Include suites by name.
corresponds to the -s --suite name * option of testdoc
testdoc.tests
Type: Optional[List[Union[str, StringExpression]]]
Include tests by name.
corresponds to the -t --test name * option of testdoc
testdoc.title
Type: Union[str, StringExpression, None]
Set the title of the generated documentation. Underscores in the title are
converted to spaces. The default title is the name of the top level suite.
corresponds to the -T --title title option of testdoc
tests
Type: Optional[List[Union[str, StringExpression]]]
Select tests by name or by long name containing also parent suite name like
Parent.Test. Name is case and space insensitive and it can also be a simple
pattern where * matches anything, ? matches any single character, and [chars]
matches one character in brackets.
corresponds to the -t --test name * option of robot
timestamp-outputs
Type: Union[bool, Flag, None]
When this option is used, timestamp in a format YYYYMMDD-hhmmss is added to all generated output files between their basename and extension. For example -T -o output.xml -r report.html -l none creates files like output-20070503-154410.xml and report-20070503-154410.html.
corresponds to the -T --timestampoutputs option of robot
tool
Type: Any
Tool configurations.
tool.robotcode-analyze.extend-ignore
Type: Optional[List[str]]
Ignores which rules are run.
tool.robotcode-analyze.extend-select
Type: Optional[List[Union[str, robotcode.analyze.config.Dummy]]]
Selects which rules are run.
tool.robotcode-analyze.ignore
Type: Optional[List[str]]
Ignores which rules are run.
tool.robotcode-analyze.select
Type: Optional[List[Union[str, robotcode.analyze.config.Dummy]]]
Selects which rules are run.
variable-files
Type: Optional[List[Union[str, StringExpression]]]
Python or YAML file file to read variables from. Possible arguments to the
variable file can be given after the path using colon or semicolon as
separator.
Examples:
--variablefile path/vars.yaml
--variablefile environment.py:testing
corresponds to the -V --variablefile path * option of robot
variables
Type: Optional[Dict[str, Union[str, StringExpression]]]
Set variables in the test data. Only scalar variables with string value are
supported and name is given without ${}. See --variablefile for a more powerful
variable setting mechanism.
Examples:
--variable name:Robot => ${name} = Robot
-v "hello:Hello world" => ${hello} = Hello world
-v x: -v y:42 => ${x} = `, ${y} =42`
corresponds to the -v --variable name:value * option of robot
xunit
Type: Union[str, StringExpression, None]
xUnit compatible result file. Not created unless this option is specified.
corresponds to the -x --xunit file option of robot