Robot Framework
robot.reporting.outputwriter.OutputWriter Class Reference
Inheritance diagram for robot.reporting.outputwriter.OutputWriter:
robot.output.xmllogger.XmlLogger robot.result.visitor.ResultVisitor robot.model.visitor.SuiteVisitor

Public Member Functions

def __init__ (self, output, rpa=False)
 
def close (self)
 
def end_result (self, result)
 
def start_message (self, msg)
 Called when a message starts. More...
 
- Public Member Functions inherited from robot.output.xmllogger.XmlLogger
def __init__ (self, path, log_level='TRACE', rpa=False, generator='Robot')
 
def end_break (self, break_)
 Called when a BREAK element ends. More...
 
def end_continue (self, continue_)
 Called when a CONTINUE element ends. More...
 
def end_errors (self, errors=None)
 
def end_for (self, for_)
 Called when a FOR loop ends. More...
 
def end_for_iteration (self, iteration)
 Called when a FOR loop iteration ends. More...
 
def end_if (self, if_)
 Called when an IF/ELSE structure ends. More...
 
def end_if_branch (self, branch)
 Called when an IF/ELSE branch ends. More...
 
def end_keyword (self, kw)
 Called when a keyword ends. More...
 
def end_return (self, return_)
 Called when a RETURN element ends. More...
 
def end_statistics (self, stats)
 
def end_suite (self, suite)
 Called when a suite ends. More...
 
def end_suite_statistics (self, tag_stats)
 
def end_tag_statistics (self, tag_stats)
 
def end_test (self, test)
 Called when a test ends. More...
 
def end_total_statistics (self, total_stats)
 
def end_try (self, root)
 Called when a TRY/EXCEPT structure ends. More...
 
def end_try_branch (self, branch)
 Called when TRY, EXCEPT, ELSE and FINALLY branches end. More...
 
def end_while (self, while_)
 Called when a WHILE loop ends. More...
 
def end_while_iteration (self, iteration)
 Called when a WHILE loop iteration ends. More...
 
def log_message (self, msg)
 
def message (self, msg)
 
def set_log_level (self, level)
 
def start_break (self, break_)
 Called when a BREAK element starts. More...
 
def start_continue (self, continue_)
 Called when a CONTINUE element starts. More...
 
def start_errors (self, errors=None)
 
def start_for (self, for_)
 Called when a FOR loop starts. More...
 
def start_for_iteration (self, iteration)
 Called when a FOR loop iteration starts. More...
 
def start_if (self, if_)
 Called when an IF/ELSE structure starts. More...
 
def start_if_branch (self, branch)
 Called when an IF/ELSE branch starts. More...
 
def start_keyword (self, kw)
 Called when a keyword starts. More...
 
def start_return (self, return_)
 Called when a RETURN element starts. More...
 
def start_statistics (self, stats)
 
def start_suite (self, suite)
 Called when a suite starts. More...
 
def start_suite_statistics (self, tag_stats)
 
def start_tag_statistics (self, tag_stats)
 
def start_test (self, test)
 Called when a test starts. More...
 
def start_total_statistics (self, total_stats)
 
def start_try (self, root)
 Called when a TRY/EXCEPT structure starts. More...
 
def start_try_branch (self, branch)
 Called when TRY, EXCEPT, ELSE or FINALLY branches start. More...
 
def start_while (self, while_)
 Called when a WHILE loop starts. More...
 
def start_while_iteration (self, iteration)
 Called when a WHILE loop iteration starts. More...
 
def visit_stat (self, stat)
 
- Public Member Functions inherited from robot.result.visitor.ResultVisitor
def end_stat (self, stat)
 
def start_result (self, result)
 
def start_stat (self, stat)
 
def visit_errors (self, errors)
 
def visit_result (self, result)
 
def visit_statistics (self, stats)
 
def visit_suite_statistics (self, stats)
 
def visit_tag_statistics (self, stats)
 
def visit_total_statistics (self, stats)
 
- Public Member Functions inherited from robot.model.visitor.SuiteVisitor
def end_body_item (self, item)
 Called, by default, when keywords, messages or control structures end. More...
 
def end_message (self, msg)
 Called when a message ends. More...
 
def start_body_item (self, item)
 Called, by default, when keywords, messages or control structures start. More...
 
def visit_break (self, break_)
 Visits BREAK elements. More...
 
def visit_continue (self, continue_)
 Visits CONTINUE elements. More...
 
def visit_for (self, for_)
 Implements traversing through FOR loops. More...
 
def visit_for_iteration (self, iteration)
 Implements traversing through single FOR loop iteration. More...
 
def visit_if (self, if_)
 Implements traversing through IF/ELSE structures. More...
 
def visit_if_branch (self, branch)
 Implements traversing through single IF/ELSE branch. More...
 
def visit_keyword (self, kw)
 Implements traversing through keywords. More...
 
def visit_message (self, msg)
 Implements visiting messages. More...
 
def visit_return (self, return_)
 Visits a RETURN elements. More...
 
def visit_suite (self, suite)
 Implements traversing through suites. More...
 
def visit_test (self, test)
 Implements traversing through tests. More...
 
def visit_try (self, try_)
 Implements traversing through TRY/EXCEPT structures. More...
 
def visit_try_branch (self, branch)
 Visits individual TRY, EXCEPT, ELSE and FINALLY branches. More...
 
def visit_while (self, while_)
 Implements traversing through WHILE loops. More...
 
def visit_while_iteration (self, iteration)
 Implements traversing through single WHILE loop iteration. More...
 

Detailed Description

Definition at line 19 of file outputwriter.py.

Constructor & Destructor Documentation

◆ __init__()

def robot.reporting.outputwriter.OutputWriter.__init__ (   self,
  output,
  rpa = False 
)

Definition at line 21 of file outputwriter.py.

Member Function Documentation

◆ close()

def robot.reporting.outputwriter.OutputWriter.close (   self)

Reimplemented from robot.output.xmllogger.XmlLogger.

Definition at line 27 of file outputwriter.py.

◆ end_result()

def robot.reporting.outputwriter.OutputWriter.end_result (   self,
  result 
)

Reimplemented from robot.result.visitor.ResultVisitor.

Definition at line 31 of file outputwriter.py.

◆ start_message()

def robot.reporting.outputwriter.OutputWriter.start_message (   self,
  msg 
)

Called when a message starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.

Reimplemented from robot.model.visitor.SuiteVisitor.

Definition at line 24 of file outputwriter.py.


The documentation for this class was generated from the following file: