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

• robot.output.console package
  • ConsoleOutput()
  • Submodules
  • robot.output.console.dotted module
  • robot.output.console.highlighting module
  • robot.output.console.quiet module
  • robot.output.console.verbose module

Submodules

robot.output.debugfile module

robot.output.debugfile.DebugFile(path)

robot.output.filelogger module

class robot.output.filelogger.FileLogger(path, level)

Bases: AbstractLogger, LoggerApi

set_level(level)

message(msg)

start_suite(data, result)

end_suite(data, result)

start_test(data, result)

end_test(data, result)

start_body_item(data, result)

end_body_item(data, result)

result_file(kind, path)

Called when any result file is closed by default.

kind specifies the file type. This method is not called if a result file specific method like output_file() is implemented.

close()

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.librarylogger.write(msg: Any, level: str, html: bool = False)

robot.output.librarylogger.trace(msg, html=False)

robot.output.librarylogger.debug(msg, html=False)

robot.output.librarylogger.info(msg, html=False, also_console=False)

robot.output.librarylogger.warn(msg, html=False)

robot.output.librarylogger.error(msg, html=False)

robot.output.librarylogger.console(msg: str, newline: bool = True, stream: str = 'stdout')

robot.output.listeners module

class robot.output.listeners.Listeners(listeners: Iterable[str | Any] = (), log_level: LogLevel | str = 'INFO')

Bases: object

property listeners

class robot.output.listeners.LibraryListeners(log_level: LogLevel | str = 'INFO')

Bases: Listeners

property listeners

new_suite_scope()

discard_suite_scope()

register(library)

unregister(library, close=False)

class robot.output.listeners.ListenerFacade(listener, name, log_level, library=None)

Bases: LoggerApi, ABC

class robot.output.listeners.ListenerV3Facade(listener, name, log_level, library=None)

Bases: ListenerFacade

start_user_keyword(data, implementation, result)

end_user_keyword(data, implementation, result)

start_library_keyword(data, implementation, result)

end_library_keyword(data, implementation, result)

start_invalid_keyword(data, implementation, result)

end_invalid_keyword(data, implementation, result)

log_message(message)

class robot.output.listeners.ListenerV2Facade(listener, name, log_level, library=None)

Bases: ListenerFacade

start_suite(data, result)

end_suite(data, result)

start_test(data, result)

end_test(data, result)

start_keyword(data, result)

end_keyword(data, result)

start_for(data, result)

end_for(data, result)

start_for_iteration(data, result)

end_for_iteration(data, result)

start_while(data, result)

end_while(data, result)

start_while_iteration(data, result)

end_while_iteration(data, result)

start_group(data, result)

end_group(data, result)

start_if_branch(data, result)

end_if_branch(data, result)

start_try_branch(data, result)

end_try_branch(data, result)

start_return(data, result)

end_return(data, result)

start_continue(data, result)

end_continue(data, result)

start_break(data, result)

end_break(data, result)

start_error(data, result)

end_error(data, result)

start_var(data, result)

end_var(data, result)

log_message(message)

message(message)

library_import(library, importer)

resource_import(resource, importer)

variables_import(attrs: dict, importer)

output_file(path: Path)

Called when XML output file is closed.

Calls result_file() by default.

report_file(path: Path)

Called when report file is closed.

Calls result_file() by default.

log_file(path: Path)

Called when log file is closed.

Calls result_file() by default.

xunit_file(path: Path)

Called when xunit file is closed.

Calls result_file() by default.

debug_file(path: Path)

Called when debug file is closed.

Calls result_file() by default.

close()

class robot.output.listeners.ListenerMethod(method, name)

Bases: object

robot.output.logger module

robot.output.logger.start_body_item(method)

robot.output.logger.end_body_item(method)

class robot.output.logger.Logger(register_console_logger=True)

Bases: 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.

property start_loggers

property end_loggers

register_console_logger(type='verbose', width=78, colors='AUTO', links='AUTO', markers='AUTO', stdout=None, stderr=None)

unregister_console_logger()

register_syslog(path=None, level='INFO')

register_output_file(logger)

unregister_output_file()

register_listeners(listeners, library_listeners)

register_logger(*loggers)

unregister_logger(*loggers)

disable_message_cache()

register_error_listener(listener)

message(msg)

Messages about what the framework is doing, warnings, errors, …

property cache_only

property delayed_logging

log_message(msg, no_cache=False)

log_output(output)

enable_library_import_logging()

disable_library_import_logging()

start_suite(data, result)

end_suite(data, result)

start_test(data, result)

end_test(data, result)

start_keyword(*args)

end_keyword(*args)

start_user_keyword(*args)

end_user_keyword(*args)

start_library_keyword(*args)

end_library_keyword(*args)

start_invalid_keyword(*args)

end_invalid_keyword(*args)

start_for(*args)

end_for(*args)

start_for_iteration(*args)

end_for_iteration(*args)

start_while(*args)

end_while(*args)

start_while_iteration(*args)

end_while_iteration(*args)

start_group(*args)

end_group(*args)

start_if(*args)

end_if(*args)

start_if_branch(*args)

end_if_branch(*args)

start_try(*args)

end_try(*args)

start_try_branch(*args)

end_try_branch(*args)

start_var(*args)

end_var(*args)

start_break(*args)

end_break(*args)

start_continue(*args)

end_continue(*args)

start_return(*args)

end_return(*args)

start_error(*args)

end_error(*args)

library_import(library, importer)

resource_import(resource, importer)

variables_import(variables, importer)

output_file(path)

report_file(path)

log_file(path)

xunit_file(path)

debug_file(path)

result_file(kind, path)

close()

robot.output.loggerapi module

class robot.output.loggerapi.LoggerApi

Bases: object

start_suite(data: running.TestSuite, result: result.TestSuite)

end_suite(data: running.TestSuite, result: result.TestSuite)

start_test(data: running.TestCase, result: result.TestCase)

end_test(data: running.TestCase, result: result.TestCase)

start_keyword(data: running.Keyword, result: result.Keyword)

end_keyword(data: running.Keyword, result: result.Keyword)

start_user_keyword(data: running.Keyword, implementation: running.UserKeyword, result: result.Keyword)

end_user_keyword(data: running.Keyword, implementation: running.UserKeyword, result: result.Keyword)

start_library_keyword(data: running.Keyword, implementation: running.LibraryKeyword, result: result.Keyword)

end_library_keyword(data: running.Keyword, implementation: running.LibraryKeyword, result: result.Keyword)

start_invalid_keyword(data: running.Keyword, implementation: running.KeywordImplementation, result: result.Keyword)

end_invalid_keyword(data: running.Keyword, implementation: running.KeywordImplementation, result: result.Keyword)

start_for(data: running.For, result: result.For)

end_for(data: running.For, result: result.For)

start_for_iteration(data: running.ForIteration, result: result.ForIteration)

end_for_iteration(data: running.ForIteration, result: result.ForIteration)

start_while(data: running.While, result: result.While)

end_while(data: running.While, result: result.While)

start_while_iteration(data: running.WhileIteration, result: result.WhileIteration)

end_while_iteration(data: running.WhileIteration, result: result.WhileIteration)

start_group(data: running.Group, result: result.Group)

end_group(data: running.Group, result: result.Group)

start_if(data: running.If, result: result.If)

end_if(data: running.If, result: result.If)

start_if_branch(data: running.IfBranch, result: result.IfBranch)

end_if_branch(data: running.IfBranch, result: result.IfBranch)

start_try(data: running.Try, result: result.Try)

end_try(data: running.Try, result: result.Try)

start_try_branch(data: running.TryBranch, result: result.TryBranch)

end_try_branch(data: running.TryBranch, result: result.TryBranch)

start_var(data: running.Var, result: result.Var)

end_var(data: running.Var, result: result.Var)

start_break(data: running.Break, result: result.Break)

end_break(data: running.Break, result: result.Break)

start_continue(data: running.Continue, result: result.Continue)

end_continue(data: running.Continue, result: result.Continue)

start_return(data: running.Return, result: result.Return)

end_return(data: running.Return, result: result.Return)

start_error(data: running.Error, result: result.Error)

end_error(data: running.Error, result: result.Error)

start_body_item(data, result)

end_body_item(data, result)

log_message(message: model.Message)

message(message: model.Message)

output_file(path: Path)

Called when XML output file is closed.

Calls result_file() by default.

report_file(path: Path)

Called when report file is closed.

Calls result_file() by default.

log_file(path: Path)

Called when log file is closed.

Calls result_file() by default.

xunit_file(path: Path)

Called when xunit file is closed.

Calls result_file() by default.

debug_file(path: Path)

Called when debug file is closed.

Calls result_file() by default.

result_file(kind: Literal['Output', 'Report', 'Log', 'XUnit', 'Debug'], path: Path)

Called when any result file is closed by default.

kind specifies the file type. This method is not called if a result file specific method like output_file() is implemented.

imported(import_type: str, name: str, attrs)

library_import(library: running.TestLibrary, importer: running.Import)

resource_import(resource: running.ResourceFile, importer: running.Import)

variables_import(attrs: dict, importer: running.Import)

close()

robot.output.loggerhelper module

robot.output.loggerhelper.write_to_console(msg, newline=True, stream='stdout')

class robot.output.loggerhelper.AbstractLogger

Bases: object

trace(msg)

debug(msg)

info(msg)

warn(msg)

fail(msg)

skip(msg)

error(msg)

write(message, level, html=False)

message(msg)

class robot.output.loggerhelper.Message(message: str | None | Callable[[], str | None] = '', level: Literal['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FAIL', 'SKIP', 'HTML', 'CONSOLE'] = 'INFO', html: bool = False, timestamp: datetime | str | None = None)

Bases: Message

Represents message logged during execution.

Most messages are logged by libraries. They typically log strings, but possible non-string items have been converted to strings already before they end up here.

In addition to strings, Robot Framework itself logs also callables to make constructing messages that are not typically needed lazy. Such messages are resolved when they are accessed.

Listeners can remove messages by setting the message attribute to None. These messages are not written to the output.xml at all.

property message: str | None

resolve_delayed_message()

robot.output.output module

class robot.output.output.Output(settings)

Bases: AbstractLogger, LoggerApi

property initial_log_level

register_error_listener(listener)

property delayed_logging

close(result)

start_suite(data, result)

end_suite(data, result)

start_test(data, result)

end_test(data, result)

start_keyword(data, result)

end_keyword(data, result)

start_user_keyword(data, implementation, result)

end_user_keyword(data, implementation, result)

start_library_keyword(data, implementation, result)

end_library_keyword(data, implementation, result)

start_invalid_keyword(data, implementation, result)

end_invalid_keyword(data, implementation, result)

start_for(data, result)

end_for(data, result)

start_for_iteration(data, result)

end_for_iteration(data, result)

start_while(data, result)

end_while(data, result)

start_while_iteration(data, result)

end_while_iteration(data, result)

start_group(data, result)

end_group(data, result)

start_if(data, result)

end_if(data, result)

start_if_branch(data, result)

end_if_branch(data, result)

start_try(data, result)

end_try(data, result)

start_try_branch(data, result)

end_try_branch(data, result)

start_var(data, result)

end_var(data, result)

start_break(data, result)

end_break(data, result)

start_continue(data, result)

end_continue(data, result)

start_return(data, result)

end_return(data, result)

start_error(data, result)

end_error(data, result)

message(msg)

trace(msg, write_if_flat=True)

set_log_level(level)

robot.output.pyloggingconf module

robot.output.pyloggingconf.robot_handler_enabled(level)

robot.output.pyloggingconf.set_level(level)

class robot.output.pyloggingconf.RobotHandler(level=0, library_logger=<module 'robot.output.librarylogger' from '/home/docs/checkouts/readthedocs.org/user_builds/robot-framework/checkouts/master/src/robot/output/librarylogger.py'>)

Bases: Handler

Initializes the instance - basically setting the formatter to None and the filter list to empty.

emit(record)

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.

robot.output.stdoutlogsplitter module

class robot.output.stdoutlogsplitter.StdoutLogSplitter(output)

Bases: object

Splits messages logged through stdout (or stderr) into Message objects

robot.output.xmllogger module

class robot.output.xmllogger.XmlLogger(output, rpa=False, suite_only=False)

Bases: ResultVisitor

generator = 'Robot'

close()

visit_message(msg)

Implements visiting messages.

Can be overridden to allow modifying the passed in msg without calling start_message() or end_message().

message(msg)

start_keyword(kw)

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)

Called when a keyword ends.

By default, calls end_body_item() which, by default, does nothing.

start_if(if_)

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_)

Called when an IF/ELSE structure ends.

By default, calls end_body_item() which, by default, does nothing.

start_if_branch(branch)

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)

Called when an IF/ELSE branch ends.

By default, calls end_body_item() which, by default, does nothing.

start_for(for_)

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_)

Called when a FOR loop ends.

By default, calls end_body_item() which, by default, does nothing.

start_for_iteration(iteration)

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)

Called when a FOR loop iteration ends.

By default, calls end_body_item() which, by default, does nothing.

start_try(root)

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)

Called when a TRY/EXCEPT structure ends.

By default, calls end_body_item() which, by default, does nothing.

start_try_branch(branch)

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)

Called when TRY, EXCEPT, ELSE and FINALLY branches end.

By default, calls end_body_item() which, by default, does nothing.

start_while(while_)

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_)

Called when a WHILE loop ends.

By default, calls end_body_item() which, by default, does nothing.

start_while_iteration(iteration)

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)

Called when a WHILE loop iteration ends.

By default, calls end_body_item() which, by default, does nothing.

start_group(group)

Called when a GROUP element starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_group(group)

Called when a GROUP element ends.

By default, calls end_body_item() which, by default, does nothing.

start_var(var)

Called when a VAR element starts.

By default, calls start_body_item() which, by default, does nothing.

Can return explicit False to stop visiting.

end_var(var)

Called when a VAR element ends.

By default, calls end_body_item() which, by default, does nothing.

start_return(return_)

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_)

Called when a RETURN element ends.

By default, calls end_body_item() which, by default, does nothing.

start_continue(continue_)

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_)

Called when a CONTINUE element ends.

By default, calls end_body_item() which, by default, does nothing.

start_break(break_)

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_)

Called when a BREAK element ends.

By default, calls end_body_item() which, by default, does nothing.

start_error(error)

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)

Called when a ERROR element ends.

By default, calls end_body_item() which, by default, does nothing.

start_test(test)

Called when a test starts. Default implementation does nothing.

Can return explicit False to stop visiting.

end_test(test)

Called when a test ends. Default implementation does nothing.

start_suite(suite)

Called when a suite starts. Default implementation does nothing.

Can return explicit False to stop visiting.

end_suite(suite)

Called when a suite ends. Default implementation does nothing.

statistics(stats)

start_statistics(stats)

end_statistics(stats)

start_total_statistics(total_stats)

end_total_statistics(total_stats)

start_tag_statistics(tag_stats)

end_tag_statistics(tag_stats)

start_suite_statistics(tag_stats)

end_suite_statistics(tag_stats)

visit_stat(stat)

errors(errors)

start_errors(errors)

end_errors(errors)

class robot.output.xmllogger.LegacyXmlLogger(output, rpa=False, suite_only=False)

Bases: XmlLogger

class robot.output.xmllogger.NullLogger

Bases: XmlLogger