Robot Framework Integrated Development Environment (RIDE)
robotide.lib.robot.output.xmllogger.XmlLogger Class Reference
Inheritance diagram for robotide.lib.robot.output.xmllogger.XmlLogger:
robotide.lib.robot.result.visitor.ResultVisitor robotide.lib.robot.model.visitor.SuiteVisitor robotide.lib.robot.reporting.outputwriter.OutputWriter

Public Member Functions

def __init__ (self, path, log_level='TRACE', rpa=False, generator='Robot')
 
def close (self)
 
def end_errors (self, errors=None)
 
def end_keyword (self, kw)
 Called when keyword ends. More...
 
def end_statistics (self, stats)
 
def end_suite (self, suite)
 Called when suite ends. More...
 
def end_suite_statistics (self, tag_stats)
 
def end_tag_statistics (self, tag_stats)
 
def end_test (self, test)
 Called when test ends. More...
 
def end_total_statistics (self, total_stats)
 
def log_message (self, msg)
 
def message (self, msg)
 
def set_log_level (self, level)
 
def start_errors (self, errors=None)
 
def start_keyword (self, kw)
 Called when keyword starts. More...
 
def start_statistics (self, stats)
 
def start_suite (self, suite)
 Called when suite starts. More...
 
def start_suite_statistics (self, tag_stats)
 
def start_tag_statistics (self, tag_stats)
 
def start_test (self, test)
 Called when test starts. More...
 
def start_total_statistics (self, total_stats)
 
def visit_stat (self, stat)
 
- Public Member Functions inherited from robotide.lib.robot.result.visitor.ResultVisitor
def end_result (self, result)
 
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 robotide.lib.robot.model.visitor.SuiteVisitor
def end_message (self, msg)
 Called when message ends. More...
 
def start_message (self, msg)
 Called when message starts. More...
 
def visit_keyword (self, kw)
 Implements traversing through the keyword and its child keywords. More...
 
def visit_message (self, msg)
 Implements visiting the message. More...
 
def visit_suite (self, suite)
 Implements traversing through the suite and its direct children. More...
 
def visit_test (self, test)
 Implements traversing through the test and its keywords. More...
 

Private Member Functions

def _get_writer (self, path, rpa, generator)
 
def _write_list (self, container_tag, item_tag, items)
 
def _write_message (self, msg)
 
def _write_metadata (self, metadata)
 
def _write_status (self, item, extra_attrs=None)
 

Private Attributes

 _error_message_is_logged
 
 _errors
 
 _log_message_is_logged
 
 _writer
 

Detailed Description

Definition at line 24 of file xmllogger.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.lib.robot.output.xmllogger.XmlLogger.__init__ (   self,
  path,
  log_level = 'TRACE',
  rpa = False,
  generator = 'Robot' 
)

Definition at line 26 of file xmllogger.py.

Member Function Documentation

◆ _get_writer()

def robotide.lib.robot.output.xmllogger.XmlLogger._get_writer (   self,
  path,
  rpa,
  generator 
)
private

Definition at line 32 of file xmllogger.py.

◆ _write_list()

def robotide.lib.robot.output.xmllogger.XmlLogger._write_list (   self,
  container_tag,
  item_tag,
  items 
)
private

Definition at line 148 of file xmllogger.py.

◆ _write_message()

def robotide.lib.robot.output.xmllogger.XmlLogger._write_message (   self,
  msg 
)
private

Definition at line 64 of file xmllogger.py.

◆ _write_metadata()

def robotide.lib.robot.output.xmllogger.XmlLogger._write_metadata (   self,
  metadata 
)
private

Definition at line 108 of file xmllogger.py.

◆ _write_status()

def robotide.lib.robot.output.xmllogger.XmlLogger._write_status (   self,
  item,
  extra_attrs = None 
)
private

Definition at line 155 of file xmllogger.py.

◆ close()

def robotide.lib.robot.output.xmllogger.XmlLogger.close (   self)

Reimplemented in robotide.lib.robot.reporting.outputwriter.OutputWriter.

Definition at line 45 of file xmllogger.py.

◆ end_errors()

def robotide.lib.robot.output.xmllogger.XmlLogger.end_errors (   self,
  errors = None 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 145 of file xmllogger.py.

◆ end_keyword()

def robotide.lib.robot.output.xmllogger.XmlLogger.end_keyword (   self,
  keyword 
)

Called when keyword ends.

Default implementation does nothing.

Reimplemented from robotide.lib.robot.model.visitor.SuiteVisitor.

Definition at line 80 of file xmllogger.py.

◆ end_statistics()

def robotide.lib.robot.output.xmllogger.XmlLogger.end_statistics (   self,
  stats 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 117 of file xmllogger.py.

◆ end_suite()

def robotide.lib.robot.output.xmllogger.XmlLogger.end_suite (   self,
  suite 
)

Called when suite ends.

Default implementation does nothing.

Reimplemented from robotide.lib.robot.model.visitor.SuiteVisitor.

Definition at line 101 of file xmllogger.py.

◆ end_suite_statistics()

def robotide.lib.robot.output.xmllogger.XmlLogger.end_suite_statistics (   self,
  tag_stats 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 135 of file xmllogger.py.

◆ end_tag_statistics()

def robotide.lib.robot.output.xmllogger.XmlLogger.end_tag_statistics (   self,
  tag_stats 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 129 of file xmllogger.py.

◆ end_test()

def robotide.lib.robot.output.xmllogger.XmlLogger.end_test (   self,
  test 
)

Called when test ends.

Default implementation does nothing.

Reimplemented from robotide.lib.robot.model.visitor.SuiteVisitor.

Definition at line 89 of file xmllogger.py.

◆ end_total_statistics()

def robotide.lib.robot.output.xmllogger.XmlLogger.end_total_statistics (   self,
  total_stats 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 123 of file xmllogger.py.

◆ log_message()

def robotide.lib.robot.output.xmllogger.XmlLogger.log_message (   self,
  msg 
)

Definition at line 60 of file xmllogger.py.

◆ message()

def robotide.lib.robot.output.xmllogger.XmlLogger.message (   self,
  msg 
)

Definition at line 56 of file xmllogger.py.

◆ set_log_level()

def robotide.lib.robot.output.xmllogger.XmlLogger.set_log_level (   self,
  level 
)

Definition at line 53 of file xmllogger.py.

◆ start_errors()

def robotide.lib.robot.output.xmllogger.XmlLogger.start_errors (   self,
  errors = None 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 142 of file xmllogger.py.

◆ start_keyword()

def robotide.lib.robot.output.xmllogger.XmlLogger.start_keyword (   self,
  keyword 
)

Called when keyword starts.

Default implementation does nothing.

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

Reimplemented from robotide.lib.robot.model.visitor.SuiteVisitor.

Definition at line 70 of file xmllogger.py.

◆ start_statistics()

def robotide.lib.robot.output.xmllogger.XmlLogger.start_statistics (   self,
  stats 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 114 of file xmllogger.py.

◆ start_suite()

def robotide.lib.robot.output.xmllogger.XmlLogger.start_suite (   self,
  suite 
)

Called when suite starts.

Default implementation does nothing.

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

Reimplemented from robotide.lib.robot.model.visitor.SuiteVisitor.

Definition at line 97 of file xmllogger.py.

◆ start_suite_statistics()

def robotide.lib.robot.output.xmllogger.XmlLogger.start_suite_statistics (   self,
  tag_stats 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 132 of file xmllogger.py.

◆ start_tag_statistics()

def robotide.lib.robot.output.xmllogger.XmlLogger.start_tag_statistics (   self,
  tag_stats 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 126 of file xmllogger.py.

◆ start_test()

def robotide.lib.robot.output.xmllogger.XmlLogger.start_test (   self,
  test 
)

Called when test starts.

Default implementation does nothing.

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

Reimplemented from robotide.lib.robot.model.visitor.SuiteVisitor.

Definition at line 86 of file xmllogger.py.

◆ start_total_statistics()

def robotide.lib.robot.output.xmllogger.XmlLogger.start_total_statistics (   self,
  total_stats 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 120 of file xmllogger.py.

◆ visit_stat()

def robotide.lib.robot.output.xmllogger.XmlLogger.visit_stat (   self,
  stat 
)

Reimplemented from robotide.lib.robot.result.visitor.ResultVisitor.

Definition at line 138 of file xmllogger.py.

Member Data Documentation

◆ _error_message_is_logged

robotide.lib.robot.output.xmllogger.XmlLogger._error_message_is_logged
private

Definition at line 28 of file xmllogger.py.

◆ _errors

robotide.lib.robot.output.xmllogger.XmlLogger._errors
private

Definition at line 30 of file xmllogger.py.

◆ _log_message_is_logged

robotide.lib.robot.output.xmllogger.XmlLogger._log_message_is_logged
private

Definition at line 27 of file xmllogger.py.

◆ _writer

robotide.lib.robot.output.xmllogger.XmlLogger._writer
private

Definition at line 29 of file xmllogger.py.


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