robot.output.console package

robot.output.console.ConsoleOutput(type='verbose', width=78, colors='AUTO', markers='AUTO', stdout=None, stderr=None)

Submodules

robot.output.console.dotted module

class robot.output.console.dotted.DottedOutput(width=78, colors='AUTO', stdout=None, stderr=None)

Bases: object

start_suite(suite)

end_test(test)

end_suite(suite)

message(msg)

output_file(name, path)

class robot.output.console.dotted.StatusReporter(stream, width)

Bases: robot.model.visitor.SuiteVisitor

report(suite)

visit_test(test)

Implements traversing through the test and its keywords.

Can be overridden to allow modifying the passed in test without calling start_test() or end_test() nor visiting keywords.

end_keyword(keyword)

Called when keyword ends. Default implementation does nothing.

end_message(msg)

Called when message ends. Default implementation does nothing.

end_suite(suite)

Called when suite ends. Default implementation does nothing.

end_test(test)

Called when test ends. Default implementation does nothing.

start_keyword(keyword)

Called when keyword starts. Default implementation does nothing.

Can return explicit False to stop visiting.

start_message(msg)

Called when message starts. Default implementation does nothing.

Can return explicit False to stop visiting.

start_suite(suite)

Called when suite starts. Default implementation does nothing.

Can return explicit False to stop visiting.

start_test(test)

Called when test starts. Default implementation does nothing.

Can return explicit False to stop visiting.

visit_keyword(kw)

Implements traversing through the keyword and its child keywords.

Can be overridden to allow modifying the passed in kw without calling start_keyword() or end_keyword() nor visiting child keywords.

visit_message(msg)

Implements visiting the message.

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

visit_suite(suite)

Implements traversing through the suite and its direct children.

Can be overridden to allow modifying the passed in suite without calling start_suite() or end_suite() nor visiting child suites, tests or keywords (setup and teardown) at all.

robot.output.console.highlighting module

class robot.output.console.highlighting.HighlightingStream(stream, colors='AUTO')

Bases: object

write(text, flush=True)

flush()

highlight(text, status=None, flush=True)

error(message, level)

robot.output.console.highlighting.Highlighter(stream)

class robot.output.console.highlighting.AnsiHighlighter(stream)

Bases: object

green()

red()

yellow()

reset()

class robot.output.console.highlighting.NoHighlighting(stream)

Bases: robot.output.console.highlighting.AnsiHighlighter

green()

red()

reset()

yellow()

class robot.output.console.highlighting.DosHighlighter(stream)

Bases: object

green()

red()

yellow()

reset()

robot.output.console.quiet module

class robot.output.console.quiet.QuietOutput(colors='AUTO', stderr=None)

Bases: object

message(msg)

class robot.output.console.quiet.NoOutput

Bases: object

robot.output.console.verbose module

class robot.output.console.verbose.VerboseOutput(width=78, colors='AUTO', markers='AUTO', stdout=None, stderr=None)

Bases: object

start_suite(suite)

end_suite(suite)

start_test(test)

end_test(test)

start_keyword(kw)

end_keyword(kw)

message(msg)

output_file(name, path)

class robot.output.console.verbose.VerboseWriter(width=78, colors='AUTO', markers='AUTO', stdout=None, stderr=None)

Bases: object

info(name, doc, start_suite=False)

suite_separator()

test_separator()

status(status, clear=False)

message(message)

keyword_marker(status)

error(message, level, clear=False)

output(name, path)

class robot.output.console.verbose.KeywordMarker(highlighter, markers)

Bases: object

mark(status)

reset_count()