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

• robot.parsing.lexer package
  • Submodules
  • robot.parsing.lexer.blocklexers module
  • robot.parsing.lexer.context module
  • robot.parsing.lexer.lexer module
  • robot.parsing.lexer.settings module
  • robot.parsing.lexer.statementlexers module
  • robot.parsing.lexer.tokenizer module
  • robot.parsing.lexer.tokens module
• robot.parsing.model package
  • Submodules
  • robot.parsing.model.blocks module
  • robot.parsing.model.statements module
  • robot.parsing.model.visitor module
• robot.parsing.parser package
  • Submodules
  • robot.parsing.parser.blockparsers module
  • robot.parsing.parser.fileparser module
  • robot.parsing.parser.parser module

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)

Bases: ABC

source: Path | None

init_file: Path | None

children: list[SuiteStructure] | None

property extension: str | None

abstract visit(visitor: SuiteStructureVisitor)

class robot.parsing.suitestructure.SuiteFile(extensions: ValidExtensions, source: Path)

Bases: SuiteStructure

source: Path

visit(visitor: SuiteStructureVisitor)

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

Bases: SuiteStructure

children: list[SuiteStructure]

property is_multi_source: bool

add(child: SuiteStructure)

visit(visitor: SuiteStructureVisitor)

class robot.parsing.suitestructure.SuiteStructureVisitor

Bases: object

visit_file(structure: SuiteFile)

visit_directory(structure: SuiteDirectory)

start_directory(structure: SuiteDirectory)

end_directory(structure: SuiteDirectory)

class robot.parsing.suitestructure.SuiteStructureBuilder(extensions: Sequence[str] = ('.robot', '.rbt', '.robot.rst'), included_files: Sequence[str] = ())

Bases: object

ignored_prefixes = ('_', '.')

ignored_dirs = ('CVS',)

build(*paths: Path) → SuiteStructure

class robot.parsing.suitestructure.ValidExtensions(extensions: Sequence[str], included_files: Sequence[str] = ())

Bases: object

match(path: Path) → bool

get_extension(path: Path) → str

class robot.parsing.suitestructure.IncludedFiles(patterns: Sequence[str | Path] = ())

Bases: object

match(path: Path) → bool