robot.running.builder package

Submodules

robot.running.builder.builders module

class robot.running.builder.builders.TestSuiteBuilder(included_suites: str = 'DEPRECATED', included_extensions: Sequence[str] = ('.robot', '.rbt', '.robot.rst'), included_files: Sequence[str] = (), custom_parsers: Sequence[str] = (), defaults: TestDefaults | None = None, rpa: bool | None = None, lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None, allow_empty_suite: bool = False, process_curdir: bool = True)

Bases: object

Builder to construct TestSuite objects based on data on the disk.

The build() method constructs executable TestSuite objects based on test data files or directories. There are two main use cases for this API:

• Execute the created suite by using its run() method. The suite can be modified before execution if needed.

• Inspect the suite to see, for example, what tests it has or what tags tests have. This can be more convenient than using the lower level parsing APIs.

Both modifying the suite and inspecting what data it contains are easiest done by using the visitor interface.

This class is part of the public API and should be imported via the robot.api package. An alternative is using the TestSuite.from_file_system classmethod that uses this class internally.

Parameters:

• included_suites – This argument used to be used for limiting what suite file to parse. It is deprecated and has no effect starting from RF 6.1. Use the new included_files argument or filter the created suite after parsing instead.

• included_extensions – List of extensions of files to parse. Same as --extension.

• included_files – List of names, paths or directory paths of files to parse. All files are parsed by default. Same as –parse-include. New in RF 6.1.

• custom_parsers – Custom parsers as names or paths (same as --parser) or as parser objects. New in RF 6.1.

• defaults – Possible test specific defaults from suite initialization files. New in RF 6.1.

• rpa – Explicit execution mode. True for RPA and False for test automation. By default, mode is got from data file headers. Same as --rpa or --norpa.

• lang – Additional languages to be supported during parsing. Can be a string matching any of the supported language codes or names, an initialized Language subclass, a list containing such strings or instances, or a Languages instance.

• allow_empty_suite – Specify is it an error if the built suite contains no tests. Same as --runemptysuite.

• process_curdir – Control processing the special ${CURDIR} variable. It is resolved already at parsing time by default, but that can be changed by giving this argument False value.

build(*paths: Path | str) → TestSuite

Parameters:

paths – Paths to test data files or directories.

Returns:

TestSuite instance.

class robot.running.builder.builders.SuiteStructureParser(parsers: dict[str | None, Parser], defaults: TestDefaults | None = None, rpa: bool | None = None)

Bases: SuiteStructureVisitor

property parent_defaults: TestDefaults | None

parse(structure: SuiteStructure) → TestSuite

visit_file(structure: SuiteFile)

start_directory(structure: SuiteDirectory)

end_directory(structure: SuiteDirectory)

class robot.running.builder.builders.ResourceFileBuilder(lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None, process_curdir: bool = True)

Bases: object

build(source: Path) → ResourceFile

robot.running.builder.parsers module

class robot.running.builder.parsers.Parser

Bases: ABC

property name: str

parse_suite_file(source: Path, defaults: TestDefaults) → TestSuite

parse_init_file(source: Path, defaults: TestDefaults) → TestSuite

parse_resource_file(source: Path) → ResourceFile

class robot.running.builder.parsers.RobotParser(lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None, process_curdir: bool = True)

Bases: Parser

extensions = ()

parse_suite_file(source: Path, defaults: TestDefaults) → TestSuite

parse_init_file(source: Path, defaults: TestDefaults) → TestSuite

parse_model(model: File, defaults: TestDefaults | None = None) → TestSuite

parse_resource_file(source: Path) → ResourceFile

parse_resource_model(model: File) → ResourceFile

class robot.running.builder.parsers.RestParser(lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None, process_curdir: bool = True)

Bases: RobotParser

extensions = ('.robot.rst', '.rst', '.rest')

class robot.running.builder.parsers.JsonParser

Bases: Parser

parse_suite_file(source: Path, defaults: TestDefaults) → TestSuite

parse_init_file(source: Path, defaults: TestDefaults) → TestSuite

parse_resource_file(source: Path) → ResourceFile

class robot.running.builder.parsers.NoInitFileDirectoryParser

Bases: Parser

parse_init_file(source: Path, defaults: TestDefaults) → TestSuite

class robot.running.builder.parsers.CustomParser(parser)

Bases: Parser

property name: str

property extensions: tuple[str, ...]

parse_suite_file(source: Path, defaults: TestDefaults) → TestSuite

parse_init_file(source: Path, defaults: TestDefaults) → TestSuite

robot.running.builder.settings module

class robot.running.builder.settings.OptionalItems

Bases: TypedDict

args: Sequence[str]

lineno: int

class robot.running.builder.settings.FixtureDict

Bases: OptionalItems

Dictionary containing setup or teardown info.

args and lineno are optional.

name: str

args: Sequence[str]

lineno: int

class robot.running.builder.settings.TestDefaults(parent: TestDefaults | None = None, setup: FixtureDict | None = None, teardown: FixtureDict | None = None, tags: Sequence[str] = (), timeout: str | None = None)

Bases: object

Represents default values for test related settings set in init files.

Parsers parsing suite files can read defaults and parsers parsing init files can set them. The easiest way to set defaults to a test is using the set_to() method.

This class is part of the public parser API. When implementing parse or parse_init method so that they accept two arguments, the second is an instance of this class. If the class is needed as a type hint, it can be imported via robot.running or robot.api.interfaces.

property setup: FixtureDict | None

Default setup as a Keyword object or None when not set.

Can be set also using a dictionary.

property teardown: FixtureDict | None

Default teardown as a Keyword object or None when not set.

Can be set also using a dictionary.

property tags: tuple[str, ...]

Default tags. Can be set also as a sequence.

property timeout: str | None

Default timeout.

set_to(test: TestCase)

Sets defaults to the given test.

Tags are always added to the test. Setup, teardown and timeout are set only if the test does not have them set initially.

class robot.running.builder.settings.FileSettings(test_defaults: TestDefaults | None = None)

Bases: object

property test_setup: FixtureDict | None

property test_teardown: FixtureDict | None

property test_tags: tuple[str, ...]

property test_timeout: str | None

property test_template: str | None

property default_tags: tuple[str, ...]

property keyword_tags: tuple[str, ...]

class robot.running.builder.settings.InitFileSettings(test_defaults: TestDefaults | None = None)

Bases: FileSettings

property test_setup: FixtureDict | None

property test_teardown: FixtureDict | None

property test_tags: tuple[str, ...]

property test_timeout: str | None

robot.running.builder.transformers module

class robot.running.builder.transformers.SettingsBuilder(suite: TestSuite, settings: FileSettings)

Bases: ModelVisitor

visit_Documentation(node)

visit_Metadata(node)

visit_SuiteName(node)

visit_SuiteSetup(node)

visit_SuiteTeardown(node)

visit_TestSetup(node)

visit_TestTeardown(node)

visit_TestTimeout(node)

visit_DefaultTags(node)

visit_TestTags(node)

visit_KeywordTags(node)

visit_TestTemplate(node)

visit_LibraryImport(node)

visit_ResourceImport(node)

visit_VariablesImport(node)

visit_VariableSection(node)

visit_TestCaseSection(node)

visit_KeywordSection(node)

class robot.running.builder.transformers.SuiteBuilder(suite: TestSuite, settings: FileSettings)

Bases: ModelVisitor

build(model: File)

visit_SettingSection(node)

visit_Variable(node)

visit_TestCaseSection(node)

visit_TestCase(node)

visit_Keyword(node)

class robot.running.builder.transformers.ResourceBuilder(resource: ResourceFile)

Bases: ModelVisitor

build(model: File)

visit_Documentation(node)

visit_KeywordTags(node)

visit_LibraryImport(node)

visit_ResourceImport(node)

visit_VariablesImport(node)

visit_Variable(node)

visit_Keyword(node)

class robot.running.builder.transformers.BodyBuilder(model: TestCase | UserKeyword | For | If | Try | While | Group | None = None)

Bases: ModelVisitor

visit_For(node)

visit_While(node)

visit_Group(node)

visit_If(node)

visit_Try(node)

visit_KeywordCall(node)

visit_TemplateArguments(node)

visit_Var(node)

visit_Return(node)

visit_Continue(node)

visit_Break(node)

visit_Error(node)

class robot.running.builder.transformers.TestCaseBuilder(suite: TestSuite, settings: FileSettings)

Bases: BodyBuilder

model: TestCase

build(node)

visit_Documentation(node)

visit_Setup(node)

visit_Teardown(node)

visit_Timeout(node)

visit_Tags(node)

visit_Template(node)

class robot.running.builder.transformers.KeywordBuilder(resource: ResourceFile, settings: FileSettings, seen_keywords: NormalizedDict)

Bases: BodyBuilder

model: UserKeyword

build(node)

visit_Documentation(node)

visit_Arguments(node)

visit_Tags(node)

visit_ReturnSetting(node)

visit_Timeout(node)

visit_Setup(node)

visit_Teardown(node)

visit_KeywordCall(node)

class robot.running.builder.transformers.ForBuilder(parent: TestCase | UserKeyword | For | If | Try | While | Group)

Bases: BodyBuilder

model: For

build(node)

class robot.running.builder.transformers.IfBuilder(parent: TestCase | UserKeyword | For | If | Try | While | Group)

Bases: BodyBuilder

model: IfBranch | None

build(node)

class robot.running.builder.transformers.TryBuilder(parent: TestCase | UserKeyword | For | If | Try | While | Group)

Bases: BodyBuilder

model: TryBranch | None

build(node)

class robot.running.builder.transformers.WhileBuilder(parent: TestCase | UserKeyword | For | If | Try | While | Group)

Bases: BodyBuilder

model: While

build(node)

class robot.running.builder.transformers.GroupBuilder(parent: TestCase | UserKeyword | For | If | Try | While | Group)

Bases: BodyBuilder

model: Group

build(node)

robot.running.builder.transformers.format_error(errors)

class robot.running.builder.transformers.ErrorReporter(source, raise_on_invalid_header=False)

Bases: ModelVisitor

visit_TestCase(node)

visit_Keyword(node)

visit_ReturnSetting(node)

visit_SectionHeader(node)

visit_Error(node)

report_error(source, error=None, warn=False, throw=False)