robot.output.console package

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

Submodules

robot.output.console.dotted module

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

Bases: LoggerApi

start_suite(data, result)[source]
end_test(data, result)[source]
end_suite(data, result)[source]
message(msg)[source]
result_file(kind, path)[source]

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.

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

Bases: SuiteVisitor

report(suite: TestSuite)[source]
visit_test(test: TestCase)[source]

Implements traversing through tests.

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

robot.output.console.highlighting module

class robot.output.console.highlighting.HighlightingStream(stream, colors='AUTO', links='AUTO')[source]

Bases: object

write(text, flush=True)[source]
flush()[source]
highlight(text, status=None, flush=True)[source]
error(message, level)[source]
result_file(kind, path)[source]
class robot.output.console.highlighting.NullStream[source]

Bases: object

write(text)[source]
flush()[source]
robot.output.console.highlighting.Highlighter(stream, links=True)[source]
class robot.output.console.highlighting.AnsiHighlighter(stream, links=True)[source]

Bases: object

GREEN = '\x1b[32m'
RED = '\x1b[31m'
YELLOW = '\x1b[33m'
RESET = '\x1b[0m'
green()[source]
red()[source]
yellow()[source]
reset()[source]
class robot.output.console.highlighting.NoHighlighting(stream=None, links=True)[source]

Bases: AnsiHighlighter

class robot.output.console.highlighting.DosHighlighter(stream)[source]

Bases: object

FOREGROUND_GREEN = 2
FOREGROUND_RED = 4
FOREGROUND_YELLOW = 6
FOREGROUND_GREY = 7
FOREGROUND_INTENSITY = 8
BACKGROUND_MASK = 240
green()[source]
red()[source]
yellow()[source]
reset()[source]
robot.output.console.highlighting.get_std_handle(stream)[source]
robot.output.console.highlighting.virtual_terminal_enabled(stream)[source]

robot.output.console.quiet module

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

Bases: LoggerApi

message(msg)[source]
class robot.output.console.quiet.NoOutput[source]

Bases: LoggerApi

robot.output.console.verbose module

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

Bases: LoggerApi

start_suite(data, result)[source]
end_suite(data, result)[source]
start_test(data, result)[source]
end_test(data, result)[source]
start_body_item(data, result)[source]
end_body_item(data, result)[source]
message(msg)[source]
result_file(kind, path)[source]

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.

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

Bases: object

info(name, doc, start_suite=False)[source]
suite_separator()[source]
test_separator()[source]
status(status, clear=False)[source]
message(message)[source]
keyword_marker(status)[source]
error(message, level, clear=False)[source]
result_file(kind, path)[source]
class robot.output.console.verbose.KeywordMarker(highlighter, markers)[source]

Bases: object

mark(status)[source]
reset_count()[source]