Robot Framework
robot.result.configurer.SuiteConfigurer Class Reference

Result suite configured. More...

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

Public Member Functions

def __init__ (self, remove_keywords=None, log_level=None, start_time=None, end_time=None, **base_config)
 
def visit_suite (self, suite)
 Implements traversing through suites. More...
 
- Public Member Functions inherited from 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 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_suite (self, suite)
 Called when a suite 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_suite (self, suite)
 Called when a suite 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_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...
 

Public Attributes

 end_time
 
 log_level
 
 remove_keywords
 
 start_time
 
- Public Attributes inherited from 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 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` and
:meth:`~robot.result.testsuite.TestSuite.filter_messages` 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 31 of file configurer.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 33 of file configurer.py.

Member Function Documentation

◆ _get_remove_keywords()

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

Definition at line 41 of file configurer.py.

◆ _get_time()

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

Definition at line 48 of file configurer.py.

◆ _remove_keywords()

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

Definition at line 63 of file configurer.py.

◆ _set_times()

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

Definition at line 67 of file configurer.py.

◆ visit_suite()

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

Implements traversing through suites.

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

Reimplemented from robot.model.configurer.SuiteConfigurer.

Definition at line 57 of file configurer.py.

Member Data Documentation

◆ end_time

robot.result.configurer.SuiteConfigurer.end_time

Definition at line 39 of file configurer.py.

◆ log_level

robot.result.configurer.SuiteConfigurer.log_level

Definition at line 37 of file configurer.py.

◆ remove_keywords

robot.result.configurer.SuiteConfigurer.remove_keywords

Definition at line 36 of file configurer.py.

◆ start_time

robot.result.configurer.SuiteConfigurer.start_time

Definition at line 38 of file configurer.py.


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