robot.output package¶
Package for internal logging and other output.
Not part of the public API, and also subject to change in the future when test execution is refactored.
Subpackages¶
Submodules¶
robot.output.filelogger module¶
robot.output.librarylogger module¶
Implementation of the public logging API for libraries.
This is exposed via robot.api.logger
. Implementation must reside
here to avoid cyclic imports.
robot.output.listenerarguments module¶
-
class
robot.output.listenerarguments.
MessageArguments
(arguments)[source]¶ Bases:
robot.output.listenerarguments.ListenerArguments
-
classmethod
by_method_name
(name, arguments)¶
-
get_arguments
(version)¶
-
classmethod
-
class
robot.output.listenerarguments.
StartSuiteArguments
(arguments)[source]¶ Bases:
robot.output.listenerarguments._ListenerArgumentsFromItem
-
classmethod
by_method_name
(name, arguments)¶
-
get_arguments
(version)¶
-
classmethod
-
class
robot.output.listenerarguments.
EndSuiteArguments
(arguments)[source]¶ Bases:
robot.output.listenerarguments.StartSuiteArguments
-
classmethod
by_method_name
(name, arguments)¶
-
get_arguments
(version)¶
-
classmethod
-
class
robot.output.listenerarguments.
StartTestArguments
(arguments)[source]¶ Bases:
robot.output.listenerarguments._ListenerArgumentsFromItem
-
classmethod
by_method_name
(name, arguments)¶
-
get_arguments
(version)¶
-
classmethod
-
class
robot.output.listenerarguments.
EndTestArguments
(arguments)[source]¶ Bases:
robot.output.listenerarguments.StartTestArguments
-
classmethod
by_method_name
(name, arguments)¶
-
get_arguments
(version)¶
-
classmethod
-
class
robot.output.listenerarguments.
StartKeywordArguments
(arguments)[source]¶ Bases:
robot.output.listenerarguments._ListenerArgumentsFromItem
-
classmethod
by_method_name
(name, arguments)¶
-
get_arguments
(version)¶
-
classmethod
-
class
robot.output.listenerarguments.
EndKeywordArguments
(arguments)[source]¶ Bases:
robot.output.listenerarguments.StartKeywordArguments
-
classmethod
by_method_name
(name, arguments)¶
-
get_arguments
(version)¶
-
classmethod
robot.output.listenermethods module¶
robot.output.listeners module¶
robot.output.logger module¶
-
class
robot.output.logger.
Logger
(register_console_logger=True)[source]¶ Bases:
robot.output.loggerhelper.AbstractLogger
A global logger proxy to delegating messages to registered loggers.
Whenever something is written to LOGGER in code, all registered loggers are notified. Messages are also cached and cached messages written to new loggers when they are registered.
NOTE: This API is likely to change in future versions.
-
start_loggers
¶
-
end_loggers
¶
-
register_console_logger
(type='verbose', width=78, colors='AUTO', markers='AUTO', stdout=None, stderr=None)[source]¶
-
cache_only
¶
-
delayed_logging
¶
-
log_message
(msg)¶ Messages about what the framework is doing, warnings, errors, …
-
debug
(msg)¶
-
error
(msg)¶
-
fail
(msg)¶
-
info
(msg)¶
-
set_level
(level)¶
-
skip
(msg)¶
-
trace
(msg)¶
-
warn
(msg)¶
-
write
(message, level, html=False)¶
-
robot.output.loggerhelper module¶
-
class
robot.output.loggerhelper.
Message
(message, level='INFO', html=False, timestamp=None)[source]¶ Bases:
robot.model.message.Message
-
message
¶
-
BREAK
= 'BREAK'¶
-
CONTINUE
= 'CONTINUE'¶
-
ELSE
= 'ELSE'¶
-
ELSE_IF
= 'ELSE IF'¶
-
ERROR
= 'ERROR'¶
-
EXCEPT
= 'EXCEPT'¶
-
FINALLY
= 'FINALLY'¶
-
FOR
= 'FOR'¶
-
IF
= 'IF'¶
-
IF_ELSE_ROOT
= 'IF/ELSE ROOT'¶
-
ITERATION
= 'ITERATION'¶
-
KEYWORD
= 'KEYWORD'¶
-
MESSAGE
= 'MESSAGE'¶
-
RETURN
= 'RETURN'¶
-
SETUP
= 'SETUP'¶
-
TEARDOWN
= 'TEARDOWN'¶
-
TRY
= 'TRY'¶
-
TRY_EXCEPT_ROOT
= 'TRY/EXCEPT ROOT'¶
-
WHILE
= 'WHILE'¶
-
config
(**attributes) → T¶ Configure model object with given attributes.
obj.config(name='Example', doc='Something')
is equivalent to settingobj.name = 'Example'
andobj.doc = 'Something'
.New in Robot Framework 4.0.
-
copy
(**attributes) → T¶ Return a shallow copy of this object.
Parameters: attributes – Attributes to be set to the returned copy. For example, obj.copy(name='New name')
.See also
deepcopy()
. The difference betweencopy
anddeepcopy
is the same as with the methods having same names in the copy module.
-
deepcopy
(**attributes) → T¶ Return a deep copy of this object.
Parameters: attributes – Attributes to be set to the returned copy. For example, obj.deepcopy(name='New name')
.See also
copy()
. The difference betweendeepcopy
andcopy
is the same as with the methods having same names in the copy module.
-
classmethod
from_dict
(data: Dict[str, Any]) → T¶ Create this object based on data in a dictionary.
Data can be got from the
to_dict()
method or created externally.
-
classmethod
from_json
(source: str | bytes | typing.TextIO | pathlib.Path[str, bytes, TextIO, pathlib.Path]) → T¶ Create this object based on JSON data.
The data is given as the
source
parameter. It can be:- a string (or bytes) containing the data directly,
- an open file object where to read the data, or
- a path (
pathlib.Path
or string) to a UTF-8 encoded file to read.
The JSON data is first converted to a Python dictionary and the object created using the
from_dict()
method.Notice that the
source
is considered to be JSON data if it is a string and contains{
. If you need to use{
in a file system path, pass it in as apathlib.Path
instance.
-
html
¶
-
html_message
¶ Returns the message content as HTML.
-
id
¶ Item id in format like
s1-t3-k1
.See
TestSuite.id
for more information.id
isNone
only in these special cases:
-
level
¶
-
parent
¶
-
repr_args
= ('message', 'level')¶
-
timestamp
¶
-
to_dict
() → Dict[str, Any]¶ Serialize this object into a dictionary.
The object can be later restored by using the
from_dict()
method.
-
to_json
(file: None | typing.TextIO | pathlib.Path | str[None, TextIO, pathlib.Path, str] = None, *, ensure_ascii: bool = False, indent: int = 0, separators: tuple = (', ', ':')) → None | str[None, str]¶ Serialize this object into JSON.
The object is first converted to a Python dictionary using the
to_dict()
method and then the dictionary is converted to JSON.The
file
parameter controls what to do with the resulting JSON data. It can be:None
(default) to return the data as a string,- an open file object where to write the data, or
- a path (
pathlib.Path
or string) to a file where to write the data using UTF-8 encoding.
JSON formatting can be configured using optional parameters that are passed directly to the underlying json module. Notice that the defaults differ from what
json
uses.
-
type
= 'MESSAGE'¶
-
visit
(visitor)[source]¶ Visitor interface
entry-point.
-
robot.output.output module¶
robot.output.pyloggingconf module¶
-
class
robot.output.pyloggingconf.
RobotHandler
(level=0, library_logger=<module 'robot.output.librarylogger' from '/home/docs/checkouts/readthedocs.org/user_builds/robot-framework/checkouts/stable/src/robot/output/librarylogger.py'>)[source]¶ Bases:
logging.Handler
-
emit
(record)[source]¶ Do whatever it takes to actually log the specified logging record.
This version is intended to be implemented by subclasses and so raises a NotImplementedError.
-
acquire
()¶ Acquire the I/O thread lock.
-
addFilter
(filter)¶ Add the specified filter to this handler.
-
close
()¶ Tidy up any resources used by the handler.
This version removes the handler from an internal map of handlers, _handlers, which is used for handler lookup by name. Subclasses should ensure that this gets called from overridden close() methods.
-
createLock
()¶ Acquire a thread lock for serializing access to the underlying I/O.
-
filter
(record)¶ Determine if a record is loggable by consulting all the filters.
The default is to allow the record to be logged; any filter can veto this and the record is then dropped. Returns a zero value if a record is to be dropped, else non-zero.
Changed in version 3.2: Allow filters to be just callables.
-
flush
()¶ Ensure all logging output has been flushed.
This version does nothing and is intended to be implemented by subclasses.
-
format
(record)¶ Format the specified record.
If a formatter is set, use it. Otherwise, use the default formatter for the module.
-
get_name
()¶
-
handle
(record)¶ Conditionally emit the specified logging record.
Emission depends on filters which may have been added to the handler. Wrap the actual emission of the record with acquisition/release of the I/O thread lock. Returns whether the filter passed the record for emission.
-
handleError
(record)¶ Handle errors which occur during an emit() call.
This method should be called from handlers when an exception is encountered during an emit() call. If raiseExceptions is false, exceptions get silently ignored. This is what is mostly wanted for a logging system - most users will not care about errors in the logging system, they are more interested in application errors. You could, however, replace this with a custom handler if you wish. The record which was being processed is passed in to this method.
-
name
¶
-
release
()¶ Release the I/O thread lock.
-
removeFilter
(filter)¶ Remove the specified filter from this handler.
-
setFormatter
(fmt)¶ Set the formatter for this handler.
-
setLevel
(level)¶ Set the logging level of this handler. level must be an int or a str.
-
set_name
(name)¶
-
robot.output.stdoutlogsplitter module¶
robot.output.xmllogger module¶
-
class
robot.output.xmllogger.
XmlLogger
(path, log_level='TRACE', rpa=False, generator='Robot')[source]¶ Bases:
robot.result.visitor.ResultVisitor
-
start_keyword
(kw)[source]¶ Called when a keyword starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_keyword
(kw)[source]¶ Called when a keyword ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_if
(if_)[source]¶ Called when an IF/ELSE structure starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_if
(if_)[source]¶ Called when an IF/ELSE structure ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_if_branch
(branch)[source]¶ Called when an IF/ELSE branch starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_if_branch
(branch)[source]¶ Called when an IF/ELSE branch ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_for
(for_)[source]¶ Called when a FOR loop starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_for
(for_)[source]¶ Called when a FOR loop ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_for_iteration
(iteration)[source]¶ Called when a FOR loop iteration starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_for_iteration
(iteration)[source]¶ Called when a FOR loop iteration ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_try
(root)[source]¶ Called when a TRY/EXCEPT structure starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_try
(root)[source]¶ Called when a TRY/EXCEPT structure ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_try_branch
(branch)[source]¶ Called when TRY, EXCEPT, ELSE or FINALLY branches start.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_try_branch
(branch)[source]¶ Called when TRY, EXCEPT, ELSE and FINALLY branches end.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_while
(while_)[source]¶ Called when a WHILE loop starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_while
(while_)[source]¶ Called when a WHILE loop ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_while_iteration
(iteration)[source]¶ Called when a WHILE loop iteration starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_while_iteration
(iteration)[source]¶ Called when a WHILE loop iteration ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_return
(return_)[source]¶ Called when a RETURN element starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_return
(return_)[source]¶ Called when a RETURN element ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_continue
(continue_)[source]¶ Called when a CONTINUE element starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_continue
(continue_)[source]¶ Called when a CONTINUE element ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_break
(break_)[source]¶ Called when a BREAK element starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_break
(break_)[source]¶ Called when a BREAK element ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_error
(error)[source]¶ Called when a ERROR element starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_error
(error)[source]¶ Called when a ERROR element ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_test
(test)[source]¶ Called when a test starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_suite
(suite)[source]¶ Called when a suite starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
end_body_item
(item: BodyItem)¶ Called, by default, when keywords, messages or control structures end.
More specific
end_keyword()
,end_message()
, :meth:`end_for, etc. can be implemented to visit only keywords, messages or specific control structures.Default implementation does nothing.
-
end_message
(message: Message)¶ Called when a message ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
end_result
(result)¶
-
end_stat
(stat)¶
-
start_body_item
(item: BodyItem) → bool|None¶ Called, by default, when keywords, messages or control structures start.
More specific
start_keyword()
,start_message()
, :meth:`start_for, etc. can be implemented to visit only keywords, messages or specific control structures.Can return explicit
False
to stop visiting. Default implementation does nothing.
-
start_message
(message: Message) → bool|None¶ Called when a message starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
start_result
(result)¶
-
start_stat
(stat)¶
-
visit_break
(break_: Break)¶ Visits BREAK elements.
-
visit_continue
(continue_: Continue)¶ Visits CONTINUE elements.
-
visit_error
(error: Error)¶ Visits body items resulting from invalid syntax.
Examples include syntax like
END
orELSE
in wrong place and invalid setting like[Invalid]
.
-
visit_errors
(errors)¶
-
visit_for
(for_: For)¶ Implements traversing through FOR loops.
Can be overridden to allow modifying the passed in
for_
without callingstart_for()
orend_for()
nor visiting body.
-
visit_for_iteration
(iteration: ForIteration)¶ Implements traversing through single FOR loop iteration.
This is only used with the result side model because on the running side there are no iterations.
Can be overridden to allow modifying the passed in
iteration
without callingstart_for_iteration()
orend_for_iteration()
nor visiting body.
-
visit_if
(if_: If)¶ Implements traversing through IF/ELSE structures.
Notice that
if_
does not have any data directly. Actual IF/ELSE branches are in itsbody
and they are visited separately usingvisit_if_branch()
.Can be overridden to allow modifying the passed in
if_
without callingstart_if()
orend_if()
nor visiting branches.
-
visit_if_branch
(branch: IfBranch)¶ Implements traversing through single IF/ELSE branch.
Can be overridden to allow modifying the passed in
branch
without callingstart_if_branch()
orend_if_branch()
nor visiting body.
-
visit_keyword
(keyword: Keyword)¶ Implements traversing through keywords.
Can be overridden to allow modifying the passed in
kw
without callingstart_keyword()
orend_keyword()
nor visiting the body of the keyword
-
visit_message
(message: Message)¶ Implements visiting messages.
Can be overridden to allow modifying the passed in
msg
without callingstart_message()
orend_message()
.
-
visit_result
(result)¶
-
visit_return
(return_: Return)¶ Visits a RETURN elements.
-
visit_statistics
(stats)¶
-
visit_suite
(suite: TestSuite)¶ Implements traversing through suites.
Can be overridden to allow modifying the passed in
suite
without callingstart_suite()
orend_suite()
nor visiting child suites, tests or setup and teardown at all.
-
visit_suite_statistics
(stats)¶
-
visit_tag_statistics
(stats)¶
-
visit_test
(test: TestCase)¶ Implements traversing through tests.
Can be overridden to allow modifying the passed in
test
without callingstart_test()
orend_test()
nor visiting the body of the test.
-
visit_total_statistics
(stats)¶
-
visit_try
(try_: Try)¶ Implements traversing through TRY/EXCEPT structures.
This method is used with the TRY/EXCEPT root element. Actual TRY, EXCEPT, ELSE and FINALLY branches are visited separately using
visit_try_branch()
.
-
visit_try_branch
(branch: TryBranch)¶ Visits individual TRY, EXCEPT, ELSE and FINALLY branches.
-
visit_while
(while_: While)¶ Implements traversing through WHILE loops.
Can be overridden to allow modifying the passed in
while_
without callingstart_while()
orend_while()
nor visiting body.
-
visit_while_iteration
(iteration: WhileIteration)¶ Implements traversing through single WHILE loop iteration.
This is only used with the result side model because on the running side there are no iterations.
Can be overridden to allow modifying the passed in
iteration
without callingstart_while_iteration()
orend_while_iteration()
nor visiting body.
-
-
class
robot.output.xmllogger.
FlatXmlLogger
(real_xml_logger)[source]¶ Bases:
robot.output.xmllogger.XmlLogger
-
start_keyword
(kw)[source]¶ Called when a keyword starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_keyword
(kw)[source]¶ Called when a keyword ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_for
(for_)[source]¶ Called when a FOR loop starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_for
(for_)[source]¶ Called when a FOR loop ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_for_iteration
(iteration)[source]¶ Called when a FOR loop iteration starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_for_iteration
(iteration)[source]¶ Called when a FOR loop iteration ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_if
(if_)[source]¶ Called when an IF/ELSE structure starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_if
(if_)[source]¶ Called when an IF/ELSE structure ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_if_branch
(branch)[source]¶ Called when an IF/ELSE branch starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_if_branch
(branch)[source]¶ Called when an IF/ELSE branch ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_try
(root)[source]¶ Called when a TRY/EXCEPT structure starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_try
(root)[source]¶ Called when a TRY/EXCEPT structure ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_try_branch
(branch)[source]¶ Called when TRY, EXCEPT, ELSE or FINALLY branches start.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_try_branch
(branch)[source]¶ Called when TRY, EXCEPT, ELSE and FINALLY branches end.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_while
(while_)[source]¶ Called when a WHILE loop starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_while
(while_)[source]¶ Called when a WHILE loop ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_while_iteration
(iteration)[source]¶ Called when a WHILE loop iteration starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_while_iteration
(iteration)[source]¶ Called when a WHILE loop iteration ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_break
(break_)[source]¶ Called when a BREAK element starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_break
(break_)[source]¶ Called when a BREAK element ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_continue
(continue_)[source]¶ Called when a CONTINUE element starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_continue
(continue_)[source]¶ Called when a CONTINUE element ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_return
(return_)[source]¶ Called when a RETURN element starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_return
(return_)[source]¶ Called when a RETURN element ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
start_error
(error)[source]¶ Called when a ERROR element starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
end_error
(error)[source]¶ Called when a ERROR element ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
close
()¶
-
end_body_item
(item: BodyItem)¶ Called, by default, when keywords, messages or control structures end.
More specific
end_keyword()
,end_message()
, :meth:`end_for, etc. can be implemented to visit only keywords, messages or specific control structures.Default implementation does nothing.
-
end_errors
(errors=None)¶
-
end_message
(message: Message)¶ Called when a message ends.
By default, calls
end_body_item()
which, by default, does nothing.
-
end_result
(result)¶
-
end_stat
(stat)¶
-
end_statistics
(stats)¶
-
end_suite
(suite)¶ Called when a suite ends. Default implementation does nothing.
-
end_suite_statistics
(tag_stats)¶
-
end_tag_statistics
(tag_stats)¶
-
end_test
(test)¶ Called when a test ends. Default implementation does nothing.
-
end_total_statistics
(total_stats)¶
-
log_message
(msg)¶
-
message
(msg)¶
-
set_log_level
(level)¶
-
start_body_item
(item: BodyItem) → bool|None¶ Called, by default, when keywords, messages or control structures start.
More specific
start_keyword()
,start_message()
, :meth:`start_for, etc. can be implemented to visit only keywords, messages or specific control structures.Can return explicit
False
to stop visiting. Default implementation does nothing.
-
start_errors
(errors=None)¶
-
start_message
(message: Message) → bool|None¶ Called when a message starts.
By default, calls
start_body_item()
which, by default, does nothing.Can return explicit
False
to stop visiting.
-
start_result
(result)¶
-
start_stat
(stat)¶
-
start_statistics
(stats)¶
-
start_suite
(suite)¶ Called when a suite starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_suite_statistics
(tag_stats)¶
-
start_tag_statistics
(tag_stats)¶
-
start_test
(test)¶ Called when a test starts. Default implementation does nothing.
Can return explicit
False
to stop visiting.
-
start_total_statistics
(total_stats)¶
-
visit_break
(break_: Break)¶ Visits BREAK elements.
-
visit_continue
(continue_: Continue)¶ Visits CONTINUE elements.
-
visit_error
(error: Error)¶ Visits body items resulting from invalid syntax.
Examples include syntax like
END
orELSE
in wrong place and invalid setting like[Invalid]
.
-
visit_errors
(errors)¶
-
visit_for
(for_: For)¶ Implements traversing through FOR loops.
Can be overridden to allow modifying the passed in
for_
without callingstart_for()
orend_for()
nor visiting body.
-
visit_for_iteration
(iteration: ForIteration)¶ Implements traversing through single FOR loop iteration.
This is only used with the result side model because on the running side there are no iterations.
Can be overridden to allow modifying the passed in
iteration
without callingstart_for_iteration()
orend_for_iteration()
nor visiting body.
-
visit_if
(if_: If)¶ Implements traversing through IF/ELSE structures.
Notice that
if_
does not have any data directly. Actual IF/ELSE branches are in itsbody
and they are visited separately usingvisit_if_branch()
.Can be overridden to allow modifying the passed in
if_
without callingstart_if()
orend_if()
nor visiting branches.
-
visit_if_branch
(branch: IfBranch)¶ Implements traversing through single IF/ELSE branch.
Can be overridden to allow modifying the passed in
branch
without callingstart_if_branch()
orend_if_branch()
nor visiting body.
-
visit_keyword
(keyword: Keyword)¶ Implements traversing through keywords.
Can be overridden to allow modifying the passed in
kw
without callingstart_keyword()
orend_keyword()
nor visiting the body of the keyword
-
visit_message
(message: Message)¶ Implements visiting messages.
Can be overridden to allow modifying the passed in
msg
without callingstart_message()
orend_message()
.
-
visit_result
(result)¶
-
visit_return
(return_: Return)¶ Visits a RETURN elements.
-
visit_stat
(stat)¶
-
visit_statistics
(stats)¶
-
visit_suite
(suite: TestSuite)¶ Implements traversing through suites.
Can be overridden to allow modifying the passed in
suite
without callingstart_suite()
orend_suite()
nor visiting child suites, tests or setup and teardown at all.
-
visit_suite_statistics
(stats)¶
-
visit_tag_statistics
(stats)¶
-
visit_test
(test: TestCase)¶ Implements traversing through tests.
Can be overridden to allow modifying the passed in
test
without callingstart_test()
orend_test()
nor visiting the body of the test.
-
visit_total_statistics
(stats)¶
-
visit_try
(try_: Try)¶ Implements traversing through TRY/EXCEPT structures.
This method is used with the TRY/EXCEPT root element. Actual TRY, EXCEPT, ELSE and FINALLY branches are visited separately using
visit_try_branch()
.
-
visit_try_branch
(branch: TryBranch)¶ Visits individual TRY, EXCEPT, ELSE and FINALLY branches.
-
visit_while
(while_: While)¶ Implements traversing through WHILE loops.
Can be overridden to allow modifying the passed in
while_
without callingstart_while()
orend_while()
nor visiting body.
-
visit_while_iteration
(iteration: WhileIteration)¶ Implements traversing through single WHILE loop iteration.
This is only used with the result side model because on the running side there are no iterations.
Can be overridden to allow modifying the passed in
iteration
without callingstart_while_iteration()
orend_while_iteration()
nor visiting body.
-