Robot Framework
robot.result.merger.Merger Class Reference
Inheritance diagram for robot.result.merger.Merger:
robot.model.visitor.SuiteVisitor

Public Member Functions

def __init__ (self, result, rpa=False)
 
def end_suite (self, suite)
 Called when a suite ends. More...
 
def merge (self, merged)
 
def start_suite (self, suite)
 Called when a suite starts. More...
 
def visit_test (self, test)
 Implements traversing through tests. More...
 
- 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_break (self, break_)
 Called when a BREAK element ends. More...
 
def end_continue (self, continue_)
 Called when a CONTINUE element ends. More...
 
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, keyword)
 Called when a keyword ends. More...
 
def end_message (self, msg)
 Called when a message ends. More...
 
def end_return (self, return_)
 Called when a RETURN element ends. More...
 
def end_test (self, test)
 Called when a test ends. More...
 
def end_try (self, try_)
 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 start_body_item (self, item)
 Called, by default, when keywords, messages or control structures start. More...
 
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_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, keyword)
 Called when a keyword starts. More...
 
def start_message (self, msg)
 Called when a message starts. More...
 
def start_return (self, return_)
 Called when a RETURN element starts. More...
 
def start_test (self, test)
 Called when a test starts. More...
 
def start_try (self, try_)
 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_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_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...
 

Public Attributes

 current
 
 result
 
 rpa
 

Private Member Functions

def _create_add_message (self, item, suite=False)
 
def _create_merge_message (self, new, old)
 
def _create_skip_message (self, test, new)
 
def _find (self, items, name)
 
def _find_root (self, name)
 
def _format_old_status_and_message (self, test, merge_header)
 
def _format_status_and_message (self, state, test)
 
def _html (self, message)
 
def _message_header (self, state)
 
def _status_header (self, state)
 
def _status_text (self, status)
 

Detailed Description

Definition at line 21 of file merger.py.

Constructor & Destructor Documentation

◆ __init__()

def robot.result.merger.Merger.__init__ (   self,
  result,
  rpa = False 
)

Definition at line 23 of file merger.py.

Member Function Documentation

◆ _create_add_message()

def robot.result.merger.Merger._create_add_message (   self,
  item,
  suite = False 
)
private

Definition at line 78 of file merger.py.

◆ _create_merge_message()

def robot.result.merger.Merger._create_merge_message (   self,
  new,
  old 
)
private

Definition at line 90 of file merger.py.

◆ _create_skip_message()

def robot.result.merger.Merger._create_skip_message (   self,
  test,
  new 
)
private

Definition at line 126 of file merger.py.

◆ _find()

def robot.result.merger.Merger._find (   self,
  items,
  name 
)
private

Definition at line 57 of file merger.py.

◆ _find_root()

def robot.result.merger.Merger._find_root (   self,
  name 
)
private

Definition at line 50 of file merger.py.

◆ _format_old_status_and_message()

def robot.result.merger.Merger._format_old_status_and_message (   self,
  test,
  merge_header 
)
private

Definition at line 116 of file merger.py.

◆ _format_status_and_message()

def robot.result.merger.Merger._format_status_and_message (   self,
  state,
  test 
)
private

Definition at line 101 of file merger.py.

◆ _html()

def robot.result.merger.Merger._html (   self,
  message 
)
private

Definition at line 85 of file merger.py.

◆ _message_header()

def robot.result.merger.Merger._message_header (   self,
  state 
)
private

Definition at line 113 of file merger.py.

◆ _status_header()

def robot.result.merger.Merger._status_header (   self,
  state 
)
private

Definition at line 107 of file merger.py.

◆ _status_text()

def robot.result.merger.Merger._status_text (   self,
  status 
)
private

Definition at line 110 of file merger.py.

◆ end_suite()

def robot.result.merger.Merger.end_suite (   self,
  suite 
)

Called when a suite ends.

Default implementation does nothing.

Reimplemented from robot.model.visitor.SuiteVisitor.

Definition at line 63 of file merger.py.

◆ merge()

def robot.result.merger.Merger.merge (   self,
  merged 
)

Definition at line 28 of file merger.py.

◆ start_suite()

def robot.result.merger.Merger.start_suite (   self,
  suite 
)

Called when a suite starts.

Default implementation does nothing.

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

Reimplemented from robot.model.visitor.SuiteVisitor.

Definition at line 33 of file merger.py.

◆ visit_test()

def robot.result.merger.Merger.visit_test (   self,
  test 
)

Implements traversing through tests.

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

Reimplemented from robot.model.visitor.SuiteVisitor.

Definition at line 66 of file merger.py.

Member Data Documentation

◆ current

robot.result.merger.Merger.current

Definition at line 25 of file merger.py.

◆ result

robot.result.merger.Merger.result

Definition at line 24 of file merger.py.

◆ rpa

robot.result.merger.Merger.rpa

Definition at line 26 of file merger.py.


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