Robot Framework Integrated Development Environment (RIDE)
robotide.lib.robot.model.statistics.StatisticsBuilder Class Reference
Inheritance diagram for robotide.lib.robot.model.statistics.StatisticsBuilder:
robotide.lib.robot.model.visitor.SuiteVisitor

Public Member Functions

def __init__ (self, total_builder, suite_builder, tag_builder)
 
def end_suite (self, suite)
 Called when suite ends. More...
 
def start_suite (self, suite)
 Called when suite starts. More...
 
def visit_keyword (self, kw)
 Implements traversing through the keyword and its child keywords. More...
 
def visit_test (self, test)
 Implements traversing through the test and its keywords. More...
 
- Public Member Functions inherited from robotide.lib.robot.model.visitor.SuiteVisitor
def end_keyword (self, keyword)
 Called when keyword ends. More...
 
def end_message (self, msg)
 Called when message ends. More...
 
def end_test (self, test)
 Called when test ends. More...
 
def start_keyword (self, keyword)
 Called when keyword starts. More...
 
def start_message (self, msg)
 Called when message starts. More...
 
def start_test (self, test)
 Called when test starts. 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...
 

Private Attributes

 _suite_builder
 
 _tag_builder
 
 _total_builder
 

Detailed Description

Definition at line 48 of file statistics.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.lib.robot.model.statistics.StatisticsBuilder.__init__ (   self,
  total_builder,
  suite_builder,
  tag_builder 
)

Definition at line 50 of file statistics.py.

Member Function Documentation

◆ end_suite()

def robotide.lib.robot.model.statistics.StatisticsBuilder.end_suite (   self,
  suite 
)

Called when suite ends.

Default implementation does nothing.

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

Definition at line 58 of file statistics.py.

◆ start_suite()

def robotide.lib.robot.model.statistics.StatisticsBuilder.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 55 of file statistics.py.

◆ visit_keyword()

def robotide.lib.robot.model.statistics.StatisticsBuilder.visit_keyword (   self,
  kw 
)

Implements traversing through the keyword and its child keywords.

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

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

Definition at line 66 of file statistics.py.

◆ visit_test()

def robotide.lib.robot.model.statistics.StatisticsBuilder.visit_test (   self,
  test 
)

Implements traversing through the test and its keywords.

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

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

Definition at line 61 of file statistics.py.

Member Data Documentation

◆ _suite_builder

robotide.lib.robot.model.statistics.StatisticsBuilder._suite_builder
private

Definition at line 52 of file statistics.py.

◆ _tag_builder

robotide.lib.robot.model.statistics.StatisticsBuilder._tag_builder
private

Definition at line 53 of file statistics.py.

◆ _total_builder

robotide.lib.robot.model.statistics.StatisticsBuilder._total_builder
private

Definition at line 51 of file statistics.py.


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