robot.parsing package

Module implementing test data parsing.

Public API is exposed via the robot.api.parsing module. See its documentation for more information and examples. If external code needs to import something from this module directly, issue should be submitted about exposing it explicitly via robot.api.parsing.

Subpackages

Submodules

robot.parsing.suitestructure module

class robot.parsing.suitestructure.SuiteStructure(extensions: ValidExtensions, source: Path | None, init_file: Path | None = None, children: Sequence[SuiteStructure] | None = None)[source]

Bases: ABC

source: Path | None
init_file: Path | None
children: list[SuiteStructure] | None
property extension: str | None
abstract visit(visitor: SuiteStructureVisitor)[source]
class robot.parsing.suitestructure.SuiteFile(extensions: ValidExtensions, source: Path)[source]

Bases: SuiteStructure

source: Path
visit(visitor: SuiteStructureVisitor)[source]
class robot.parsing.suitestructure.SuiteDirectory(extensions: ValidExtensions, source: Path | None = None, init_file: Path | None = None, children: Sequence[SuiteStructure] = ())[source]

Bases: SuiteStructure

children: list[SuiteStructure]
property is_multi_source: bool
add(child: SuiteStructure)[source]
visit(visitor: SuiteStructureVisitor)[source]
class robot.parsing.suitestructure.SuiteStructureVisitor[source]

Bases: object

visit_file(structure: SuiteFile)[source]
visit_directory(structure: SuiteDirectory)[source]
start_directory(structure: SuiteDirectory)[source]
end_directory(structure: SuiteDirectory)[source]
class robot.parsing.suitestructure.SuiteStructureBuilder(extensions: Sequence[str] = ('.robot', '.rbt', '.robot.rst'), included_files: Sequence[str] = ())[source]

Bases: object

ignored_prefixes = ('_', '.')
ignored_dirs = ('CVS',)
build(*paths: Path) SuiteStructure[source]
class robot.parsing.suitestructure.ValidExtensions(extensions: Sequence[str], included_files: Sequence[str] = ())[source]

Bases: object

match(path: Path) bool[source]
get_extension(path: Path) str[source]
class robot.parsing.suitestructure.IncludedFiles(patterns: Sequence[str | Path] = ())[source]

Bases: object

match(path: Path) bool[source]