robot.parsing.lexer package

Submodules

robot.parsing.lexer.blocklexers module

class robot.parsing.lexer.blocklexers.BlockLexer(ctx: LexingContext)

Bases: Lexer, ABC

accepts_more(statement: List[Token]) → bool

input(statement: List[Token])

lexer_for(statement: List[Token]) → Lexer

lexer_classes() → tuple[type[Lexer], ...]

lex()

class robot.parsing.lexer.blocklexers.FileLexer(ctx: LexingContext)

Bases: BlockLexer

lex()

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.SectionLexer(ctx: LexingContext)

Bases: BlockLexer, ABC

ctx: FileContext

accepts_more(statement: List[Token]) → bool

class robot.parsing.lexer.blocklexers.SettingSectionLexer(ctx: LexingContext)

Bases: SectionLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.VariableSectionLexer(ctx: LexingContext)

Bases: SectionLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.TestCaseSectionLexer(ctx: LexingContext)

Bases: SectionLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.TaskSectionLexer(ctx: LexingContext)

Bases: SectionLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.KeywordSectionLexer(ctx: LexingContext)

Bases: SettingSectionLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.CommentSectionLexer(ctx: LexingContext)

Bases: SectionLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.ImplicitCommentSectionLexer(ctx: LexingContext)

Bases: SectionLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.InvalidSectionLexer(ctx: LexingContext)

Bases: SectionLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.TestOrKeywordLexer(ctx: LexingContext)

Bases: BlockLexer, ABC

name_type: str

accepts_more(statement: List[Token]) → bool

input(statement: List[Token])

class robot.parsing.lexer.blocklexers.TestCaseLexer(ctx: SuiteFileContext)

Bases: TestOrKeywordLexer

name_type: str = 'TESTCASE NAME'

lex()

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.KeywordLexer(ctx: FileContext)

Bases: TestOrKeywordLexer

name_type: str = 'KEYWORD NAME'

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.NestedBlockLexer(ctx: TestCaseContext | KeywordContext)

Bases: BlockLexer, ABC

ctx: TestCaseContext | KeywordContext

accepts_more(statement: List[Token]) → bool

input(statement: List[Token])

class robot.parsing.lexer.blocklexers.ForLexer(ctx: TestCaseContext | KeywordContext)

Bases: NestedBlockLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.WhileLexer(ctx: TestCaseContext | KeywordContext)

Bases: NestedBlockLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.TryLexer(ctx: TestCaseContext | KeywordContext)

Bases: NestedBlockLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.GroupLexer(ctx: TestCaseContext | KeywordContext)

Bases: NestedBlockLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.IfLexer(ctx: TestCaseContext | KeywordContext)

Bases: NestedBlockLexer

handles(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

class robot.parsing.lexer.blocklexers.InlineIfLexer(ctx: TestCaseContext | KeywordContext)

Bases: NestedBlockLexer

handles(statement: List[Token]) → bool

accepts_more(statement: List[Token]) → bool

lexer_classes() → tuple[type[Lexer], ...]

input(statement: List[Token])

robot.parsing.lexer.context module

class robot.parsing.lexer.context.LexingContext(settings: Settings, languages: Languages)

Bases: object

lex_setting(statement: List[Token])

class robot.parsing.lexer.context.FileContext(lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None)

Bases: LexingContext

settings: FileSettings

add_language(lang: Language | str | Path)

keyword_context() → KeywordContext

setting_section(statement: List[Token]) → bool

variable_section(statement: List[Token]) → bool

test_case_section(statement: List[Token]) → bool

task_section(statement: List[Token]) → bool

keyword_section(statement: List[Token]) → bool

comment_section(statement: List[Token]) → bool

lex_invalid_section(statement: List[Token])

class robot.parsing.lexer.context.SuiteFileContext(lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None)

Bases: FileContext

settings: SuiteFileSettings

test_case_context() → TestCaseContext

test_case_section(statement: List[Token]) → bool

task_section(statement: List[Token]) → bool

class robot.parsing.lexer.context.ResourceFileContext(lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None)

Bases: FileContext

settings: ResourceFileSettings

class robot.parsing.lexer.context.InitFileContext(lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None)

Bases: FileContext

settings: InitFileSettings

class robot.parsing.lexer.context.TestCaseContext(settings: TestCaseSettings)

Bases: LexingContext

settings: TestCaseSettings

property template_set: bool

class robot.parsing.lexer.context.KeywordContext(settings: KeywordSettings)

Bases: LexingContext

settings: KeywordSettings

property template_set: bool

robot.parsing.lexer.lexer module

robot.parsing.lexer.lexer.get_tokens(source: Path | str | TextIO, data_only: bool = False, tokenize_variables: bool = False, lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None) → Iterator[Token]

Parses the given source to tokens.

Parameters:

• source – The source where to read the data. Can be a path to a source file as a string or as pathlib.Path object, an already opened file object, or Unicode text containing the date directly. Source files must be UTF-8 encoded.

• data_only – When False (default), returns all tokens. When set to True, omits separators, comments, continuation markers, and other non-data tokens.

• tokenize_variables – When True, possible variables in keyword arguments and elsewhere are tokenized. See the tokenize_variables() method for details.

• 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.

Returns a generator that yields Token instances.

robot.parsing.lexer.lexer.get_resource_tokens(source: Path | str | TextIO, data_only: bool = False, tokenize_variables: bool = False, lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None) → Iterator[Token]

Parses the given source to resource file tokens.

Same as get_tokens() otherwise, but the source is considered to be a resource file. This affects, for example, what settings are valid.

robot.parsing.lexer.lexer.get_init_tokens(source: Path | str | TextIO, data_only: bool = False, tokenize_variables: bool = False, lang: Languages | Language | str | Path | Iterable[Language | str | Path] | None = None) → Iterator[Token]

Parses the given source to init file tokens.

Same as get_tokens() otherwise, but the source is considered to be a suite initialization file. This affects, for example, what settings are valid.

class robot.parsing.lexer.lexer.Lexer(ctx: LexingContext, data_only: bool = False, tokenize_variables: bool = False)

Bases: object

input(source: Path | str | TextIO)

get_tokens() → Iterator[Token]

robot.parsing.lexer.settings module

class robot.parsing.lexer.settings.Settings(languages: Languages)

Bases: ABC

names: tuple[str, ...] = ()

aliases: dict[str, str] = {}

multi_use = ('Metadata', 'Library', 'Resource', 'Variables')

single_value = ('Resource', 'Test Timeout', 'Test Template', 'Timeout', 'Template', 'Name')

name_and_arguments = ('Metadata', 'Suite Setup', 'Suite Teardown', 'Test Setup', 'Test Teardown', 'Test Template', 'Setup', 'Teardown', 'Template', 'Resource', 'Variables')

name_arguments_and_with_name = ('Library',)

lex(statement: List[Token])

class robot.parsing.lexer.settings.FileSettings(languages: Languages)

Bases: Settings, ABC

class robot.parsing.lexer.settings.SuiteFileSettings(languages: Languages)

Bases: FileSettings

names: tuple[str, ...] = ('Documentation', 'Metadata', 'Name', 'Suite Setup', 'Suite Teardown', 'Test Setup', 'Test Teardown', 'Test Template', 'Test Timeout', 'Test Tags', 'Default Tags', 'Keyword Tags', 'Library', 'Resource', 'Variables')

aliases: dict[str, str] = {'Force Tags': 'Test Tags', 'Task Setup': 'Test Setup', 'Task Tags': 'Test Tags', 'Task Teardown': 'Test Teardown', 'Task Template': 'Test Template', 'Task Timeout': 'Test Timeout'}

class robot.parsing.lexer.settings.InitFileSettings(languages: Languages)

Bases: FileSettings

names: tuple[str, ...] = ('Documentation', 'Metadata', 'Name', 'Suite Setup', 'Suite Teardown', 'Test Setup', 'Test Teardown', 'Test Timeout', 'Test Tags', 'Keyword Tags', 'Library', 'Resource', 'Variables')

aliases: dict[str, str] = {'Force Tags': 'Test Tags', 'Task Setup': 'Test Setup', 'Task Tags': 'Test Tags', 'Task Teardown': 'Test Teardown', 'Task Timeout': 'Test Timeout'}

class robot.parsing.lexer.settings.ResourceFileSettings(languages: Languages)

Bases: FileSettings

names: tuple[str, ...] = ('Documentation', 'Keyword Tags', 'Library', 'Resource', 'Variables')

class robot.parsing.lexer.settings.TestCaseSettings(parent: SuiteFileSettings)

Bases: Settings

names: tuple[str, ...] = ('Documentation', 'Tags', 'Setup', 'Teardown', 'Template', 'Timeout')

property template_set: bool

class robot.parsing.lexer.settings.KeywordSettings(parent: FileSettings)

Bases: Settings

names: tuple[str, ...] = ('Documentation', 'Arguments', 'Setup', 'Teardown', 'Timeout', 'Tags', 'Return')

robot.parsing.lexer.statementlexers module

class robot.parsing.lexer.statementlexers.Lexer(ctx: LexingContext)

Bases: ABC

handles(statement: List[Token]) → bool

abstract accepts_more(statement: List[Token]) → bool

abstract input(statement: List[Token])

abstract lex()

class robot.parsing.lexer.statementlexers.StatementLexer(ctx: LexingContext)

Bases: Lexer, ABC

token_type: str

accepts_more(statement: List[Token]) → bool

input(statement: List[Token])

abstract lex()

class robot.parsing.lexer.statementlexers.SingleType(ctx: LexingContext)

Bases: StatementLexer, ABC

lex()

class robot.parsing.lexer.statementlexers.TypeAndArguments(ctx: LexingContext)

Bases: StatementLexer, ABC

lex()

class robot.parsing.lexer.statementlexers.SectionHeaderLexer(ctx: LexingContext)

Bases: SingleType, ABC

ctx: FileContext

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.SettingSectionHeaderLexer(ctx: LexingContext)

Bases: SectionHeaderLexer

token_type: str = 'SETTING HEADER'

class robot.parsing.lexer.statementlexers.VariableSectionHeaderLexer(ctx: LexingContext)

Bases: SectionHeaderLexer

token_type: str = 'VARIABLE HEADER'

class robot.parsing.lexer.statementlexers.TestCaseSectionHeaderLexer(ctx: LexingContext)

Bases: SectionHeaderLexer

token_type: str = 'TESTCASE HEADER'

class robot.parsing.lexer.statementlexers.TaskSectionHeaderLexer(ctx: LexingContext)

Bases: SectionHeaderLexer

token_type: str = 'TASK HEADER'

class robot.parsing.lexer.statementlexers.KeywordSectionHeaderLexer(ctx: LexingContext)

Bases: SectionHeaderLexer

token_type: str = 'KEYWORD HEADER'

class robot.parsing.lexer.statementlexers.CommentSectionHeaderLexer(ctx: LexingContext)

Bases: SectionHeaderLexer

token_type: str = 'COMMENT HEADER'

class robot.parsing.lexer.statementlexers.InvalidSectionHeaderLexer(ctx: LexingContext)

Bases: SectionHeaderLexer

token_type: str = 'INVALID HEADER'

lex()

class robot.parsing.lexer.statementlexers.CommentLexer(ctx: LexingContext)

Bases: SingleType

token_type: str = 'COMMENT'

class robot.parsing.lexer.statementlexers.ImplicitCommentLexer(ctx: LexingContext)

Bases: CommentLexer

ctx: FileContext

input(statement: List[Token])

lex()

class robot.parsing.lexer.statementlexers.SettingLexer(ctx: LexingContext)

Bases: StatementLexer

ctx: FileContext

lex()

class robot.parsing.lexer.statementlexers.TestCaseSettingLexer(ctx: LexingContext)

Bases: StatementLexer

ctx: TestCaseContext

lex()

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.KeywordSettingLexer(ctx: LexingContext)

Bases: StatementLexer

ctx: KeywordContext

lex()

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.VariableLexer(ctx: LexingContext)

Bases: TypeAndArguments

ctx: FileContext

token_type: str = 'VARIABLE'

lex()

class robot.parsing.lexer.statementlexers.KeywordCallLexer(ctx: LexingContext)

Bases: StatementLexer

ctx: TestCaseContext | KeywordContext

lex()

class robot.parsing.lexer.statementlexers.ForHeaderLexer(ctx: LexingContext)

Bases: StatementLexer

separators = ('IN', 'IN RANGE', 'IN ENUMERATE', 'IN ZIP')

handles(statement: List[Token]) → bool

lex()

class robot.parsing.lexer.statementlexers.IfHeaderLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'IF'

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.InlineIfHeaderLexer(ctx: LexingContext)

Bases: StatementLexer

token_type: str = 'INLINE IF'

handles(statement: List[Token]) → bool

lex()

class robot.parsing.lexer.statementlexers.ElseIfHeaderLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'ELSE IF'

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.ElseHeaderLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'ELSE'

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.TryHeaderLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'TRY'

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.ExceptHeaderLexer(ctx: LexingContext)

Bases: StatementLexer

token_type: str = 'EXCEPT'

handles(statement: List[Token]) → bool

lex()

class robot.parsing.lexer.statementlexers.FinallyHeaderLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'FINALLY'

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.WhileHeaderLexer(ctx: LexingContext)

Bases: StatementLexer

token_type: str = 'WHILE'

handles(statement: List[Token]) → bool

lex()

class robot.parsing.lexer.statementlexers.GroupHeaderLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'GROUP'

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.EndLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'END'

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.VarLexer(ctx: LexingContext)

Bases: StatementLexer

token_type: str = 'VAR'

handles(statement: List[Token]) → bool

lex()

class robot.parsing.lexer.statementlexers.ReturnLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'RETURN STATEMENT'

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.ContinueLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'CONTINUE'

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.BreakLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'BREAK'

handles(statement: List[Token]) → bool

class robot.parsing.lexer.statementlexers.SyntaxErrorLexer(ctx: LexingContext)

Bases: TypeAndArguments

token_type: str = 'ERROR'

handles(statement: List[Token]) → bool

lex()

robot.parsing.lexer.tokenizer module

class robot.parsing.lexer.tokenizer.Tokenizer

Bases: object

tokenize(data: str, data_only: bool = False) → Iterator[list[Token]]

robot.parsing.lexer.tokens module

class robot.parsing.lexer.tokens.Token(type: str | None = None, value: str | None = None, lineno: int = -1, col_offset: int = -1, error: str | None = None)

Bases: object

Token representing piece of Robot Framework data.

Each token has type, value, line number, column offset and end column offset in type, value, lineno, col_offset and end_col_offset attributes, respectively. Tokens representing error also have their error message in error attribute.

Token types are declared as class attributes such as SETTING_HEADER and EOL. Values of these constants have changed slightly in Robot Framework 4.0, and they may change again in the future. It is thus safer to use the constants, not their values, when types are needed. For example, use Token(Token.EOL) instead of Token('EOL') and token.type == Token.EOL instead of token.type == 'EOL'.

If value is not given and type is a special marker like IF or :attr:`EOL, the value is set automatically.

SETTING_HEADER = 'SETTING HEADER'

VARIABLE_HEADER = 'VARIABLE HEADER'

TESTCASE_HEADER = 'TESTCASE HEADER'

TASK_HEADER = 'TASK HEADER'

KEYWORD_HEADER = 'KEYWORD HEADER'

COMMENT_HEADER = 'COMMENT HEADER'

INVALID_HEADER = 'INVALID HEADER'

FATAL_INVALID_HEADER = 'FATAL INVALID HEADER'

TESTCASE_NAME = 'TESTCASE NAME'

KEYWORD_NAME = 'KEYWORD NAME'

SUITE_NAME = 'SUITE NAME'

DOCUMENTATION = 'DOCUMENTATION'

SUITE_SETUP = 'SUITE SETUP'

SUITE_TEARDOWN = 'SUITE TEARDOWN'

METADATA = 'METADATA'

TEST_SETUP = 'TEST SETUP'

TEST_TEARDOWN = 'TEST TEARDOWN'

TEST_TEMPLATE = 'TEST TEMPLATE'

TEST_TIMEOUT = 'TEST TIMEOUT'

TEST_TAGS = 'TEST TAGS'

FORCE_TAGS = 'TEST TAGS'

DEFAULT_TAGS = 'DEFAULT TAGS'

KEYWORD_TAGS = 'KEYWORD TAGS'

LIBRARY = 'LIBRARY'

RESOURCE = 'RESOURCE'

VARIABLES = 'VARIABLES'

SETUP = 'SETUP'

TEARDOWN = 'TEARDOWN'

TEMPLATE = 'TEMPLATE'

TIMEOUT = 'TIMEOUT'

TAGS = 'TAGS'

ARGUMENTS = 'ARGUMENTS'

RETURN = 'RETURN'

RETURN_SETTING = 'RETURN'

AS = 'AS'

WITH_NAME = 'AS'

NAME = 'NAME'

VARIABLE = 'VARIABLE'

ARGUMENT = 'ARGUMENT'

ASSIGN = 'ASSIGN'

KEYWORD = 'KEYWORD'

FOR = 'FOR'

FOR_SEPARATOR = 'FOR SEPARATOR'

END = 'END'

IF = 'IF'

INLINE_IF = 'INLINE IF'

ELSE_IF = 'ELSE IF'

ELSE = 'ELSE'

TRY = 'TRY'

EXCEPT = 'EXCEPT'

FINALLY = 'FINALLY'

WHILE = 'WHILE'

VAR = 'VAR'

RETURN_STATEMENT = 'RETURN STATEMENT'

CONTINUE = 'CONTINUE'

BREAK = 'BREAK'

OPTION = 'OPTION'

GROUP = 'GROUP'

SEPARATOR = 'SEPARATOR'

COMMENT = 'COMMENT'

CONTINUATION = 'CONTINUATION'

CONFIG = 'CONFIG'

EOL = 'EOL'

EOS = 'EOS'

ERROR = 'ERROR'

FATAL_ERROR = 'FATAL ERROR'

NON_DATA_TOKENS = frozenset({'COMMENT', 'CONTINUATION', 'EOL', 'EOS', 'SEPARATOR'})

SETTING_TOKENS = frozenset({'ARGUMENTS', 'DEFAULT TAGS', 'DOCUMENTATION', 'KEYWORD TAGS', 'LIBRARY', 'METADATA', 'RESOURCE', 'RETURN', 'SETUP', 'SUITE NAME', 'SUITE SETUP', 'SUITE TEARDOWN', 'TAGS', 'TEARDOWN', 'TEMPLATE', 'TEST SETUP', 'TEST TAGS', 'TEST TEARDOWN', 'TEST TEMPLATE', 'TEST TIMEOUT', 'TIMEOUT', 'VARIABLES'})

HEADER_TOKENS = frozenset({'COMMENT HEADER', 'INVALID HEADER', 'KEYWORD HEADER', 'SETTING HEADER', 'TASK HEADER', 'TESTCASE HEADER', 'VARIABLE HEADER'})

ALLOW_VARIABLES = frozenset({'ARGUMENT', 'KEYWORD NAME', 'NAME', 'TESTCASE NAME'})

type

value

lineno

col_offset

error

property end_col_offset: int

set_error(error: str)

tokenize_variables() → Iterator[Token]

Tokenizes possible variables in token value.

Yields the token itself if the token does not allow variables (see Token.ALLOW_VARIABLES) or its value does not contain variables. Otherwise, yields variable tokens as well as tokens before, after, or between variables so that they have the same type as the original token.

class robot.parsing.lexer.tokens.EOS(lineno: int = -1, col_offset: int = -1)

Bases: Token

Token representing end of a statement.

classmethod from_token(token: Token, before: bool = False) → EOS

class robot.parsing.lexer.tokens.END(lineno: int = -1, col_offset: int = -1, virtual: bool = False)

Bases: Token

Token representing END token used to signify block ending.

Virtual END tokens have ‘’ as their value, with “real” END tokens the value is ‘END’.

classmethod from_token(token: Token, virtual: bool = False) → END