Robot Framework Integrated Development Environment (RIDE)
robotide.lib.robot.result.configurer.SuiteConfigurer Class Reference

Result suite configured. More...

Inheritance diagram for robotide.lib.robot.result.configurer.SuiteConfigurer:
robotide.lib.robot.model.configurer.SuiteConfigurer robotide.lib.robot.model.visitor.SuiteVisitor

Public Member Functions

def __init__ (self, remove_keywords=None, log_level=None, start_time=None, end_time=None, critical_tags=None, non_critical_tags=None, **base_config)
 
def visit_suite (self, suite)
 Implements traversing through the suite and its direct children. More...
 
- Public Member Functions inherited from robotide.lib.robot.model.configurer.SuiteConfigurer
def __init__ (self, name=None, doc=None, metadata=None, set_tags=None, include_tags=None, exclude_tags=None, include_suites=None, include_tests=None, empty_suite_ok=False)
 
- 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_suite (self, suite)
 Called when suite 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_suite (self, suite)
 Called when suite starts. More...
 
def start_test (self, test)
 Called when test 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_test (self, test)
 Implements traversing through the test and its keywords. More...
 

Public Attributes

 critical_tags
 
 end_time
 
 log_level
 
 non_critical_tags
 
 remove_keywords
 
 start_time
 
- Public Attributes inherited from robotide.lib.robot.model.configurer.SuiteConfigurer
 doc
 
 empty_suite_ok
 
 exclude_tags
 
 include_suites
 
 include_tags
 
 include_tests
 
 metadata
 
 name
 
 set_tags
 

Private Member Functions

def _get_remove_keywords (self, value)
 
def _get_time (self, timestamp)
 
def _remove_keywords (self, suite)
 
def _set_times (self, suite)
 

Additional Inherited Members

- Properties inherited from robotide.lib.robot.model.configurer.SuiteConfigurer
 add_tags = property
 
 remove_tags = property
 

Detailed Description

Result suite configured.

Calls suite's
:meth:`~robot.result.testsuite.TestSuite.remove_keywords`,
:meth:`~robot.result.testsuite.TestSuite.filter_messages` and
:meth:`~robot.result.testsuite.TestSuite.set_criticality` methods
and sets its start and end time based on the given named parameters.

``base_config`` is forwarded to
:class:`robot.model.SuiteConfigurer <robot.model.configurer.SuiteConfigurer>`
that will do further configuration based on them.

Definition at line 32 of file configurer.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.lib.robot.result.configurer.SuiteConfigurer.__init__ (   self,
  remove_keywords = None,
  log_level = None,
  start_time = None,
  end_time = None,
  critical_tags = None,
  non_critical_tags = None,
**  base_config 
)

Definition at line 34 of file configurer.py.

Member Function Documentation

◆ _get_remove_keywords()

def robotide.lib.robot.result.configurer.SuiteConfigurer._get_remove_keywords (   self,
  value 
)
private

Definition at line 45 of file configurer.py.

◆ _get_time()

def robotide.lib.robot.result.configurer.SuiteConfigurer._get_time (   self,
  timestamp 
)
private

Definition at line 52 of file configurer.py.

◆ _remove_keywords()

def robotide.lib.robot.result.configurer.SuiteConfigurer._remove_keywords (   self,
  suite 
)
private

Definition at line 68 of file configurer.py.

◆ _set_times()

def robotide.lib.robot.result.configurer.SuiteConfigurer._set_times (   self,
  suite 
)
private

Definition at line 72 of file configurer.py.

◆ visit_suite()

def robotide.lib.robot.result.configurer.SuiteConfigurer.visit_suite (   self,
  suite 
)

Implements traversing through the suite and its direct children.

    Can be overridden to allow modifying the passed in ``suite`` without
    calling :func:`start_suite` or :func:`end_suite` nor visiting child
    suites, tests or keywords (setup and teardown) at all.

Reimplemented from robotide.lib.robot.model.configurer.SuiteConfigurer.

Definition at line 61 of file configurer.py.

Member Data Documentation

◆ critical_tags

robotide.lib.robot.result.configurer.SuiteConfigurer.critical_tags

Definition at line 42 of file configurer.py.

◆ end_time

robotide.lib.robot.result.configurer.SuiteConfigurer.end_time

Definition at line 41 of file configurer.py.

◆ log_level

robotide.lib.robot.result.configurer.SuiteConfigurer.log_level

Definition at line 39 of file configurer.py.

◆ non_critical_tags

robotide.lib.robot.result.configurer.SuiteConfigurer.non_critical_tags

Definition at line 43 of file configurer.py.

◆ remove_keywords

robotide.lib.robot.result.configurer.SuiteConfigurer.remove_keywords

Definition at line 38 of file configurer.py.

◆ start_time

robotide.lib.robot.result.configurer.SuiteConfigurer.start_time

Definition at line 40 of file configurer.py.


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