Robot Framework
robot.running.suiterunner.SuiteRunner Class Reference
Inheritance diagram for robot.running.suiterunner.SuiteRunner:
robot.model.visitor.SuiteVisitor

Public Member Functions

def __init__ (self, output, settings)
 
def end_suite (self, suite)
 Called when a suite ends. More...
 
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

 result
 

Properties

 _context = property
 

Private Member Functions

def _add_exit_combine (self)
 
def _context (self)
 
def _get_timeout (self, test)
 
def _resolve_setting (self, value)
 
def _run_setup (self, setup, status, result=None)
 
def _run_setup_or_teardown (self, data)
 
def _run_teardown (self, teardown, status, result=None)
 

Private Attributes

 _executed
 
 _output
 
 _settings
 
 _skipped_tags
 
 _suite
 
 _suite_status
 
 _variables
 

Detailed Description

Definition at line 30 of file suiterunner.py.

Constructor & Destructor Documentation

◆ __init__()

def robot.running.suiterunner.SuiteRunner.__init__ (   self,
  output,
  settings 
)

Definition at line 32 of file suiterunner.py.

Member Function Documentation

◆ _add_exit_combine()

def robot.running.suiterunner.SuiteRunner._add_exit_combine (   self)
private

Definition at line 186 of file suiterunner.py.

◆ _context()

def robot.running.suiterunner.SuiteRunner._context (   self)
private

Definition at line 45 of file suiterunner.py.

◆ _get_timeout()

def robot.running.suiterunner.SuiteRunner._get_timeout (   self,
  test 
)
private

Definition at line 191 of file suiterunner.py.

◆ _resolve_setting()

def robot.running.suiterunner.SuiteRunner._resolve_setting (   self,
  value 
)
private

Definition at line 92 of file suiterunner.py.

◆ _run_setup()

def robot.running.suiterunner.SuiteRunner._run_setup (   self,
  setup,
  status,
  result = None 
)
private

Definition at line 196 of file suiterunner.py.

◆ _run_setup_or_teardown()

def robot.running.suiterunner.SuiteRunner._run_setup_or_teardown (   self,
  data 
)
private

Definition at line 219 of file suiterunner.py.

◆ _run_teardown()

def robot.running.suiterunner.SuiteRunner._run_teardown (   self,
  teardown,
  status,
  result = None 
)
private

Definition at line 205 of file suiterunner.py.

◆ end_suite()

def robot.running.suiterunner.SuiteRunner.end_suite (   self,
  suite 
)

Called when a suite ends.

Default implementation does nothing.

Reimplemented from robot.model.visitor.SuiteVisitor.

Definition at line 97 of file suiterunner.py.

◆ start_suite()

def robot.running.suiterunner.SuiteRunner.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 48 of file suiterunner.py.

◆ visit_test()

def robot.running.suiterunner.SuiteRunner.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 116 of file suiterunner.py.

Member Data Documentation

◆ _executed

robot.running.suiterunner.SuiteRunner._executed
private

Definition at line 39 of file suiterunner.py.

◆ _output

robot.running.suiterunner.SuiteRunner._output
private

Definition at line 34 of file suiterunner.py.

◆ _settings

robot.running.suiterunner.SuiteRunner._settings
private

Definition at line 35 of file suiterunner.py.

◆ _skipped_tags

robot.running.suiterunner.SuiteRunner._skipped_tags
private

Definition at line 40 of file suiterunner.py.

◆ _suite

robot.running.suiterunner.SuiteRunner._suite
private

Definition at line 37 of file suiterunner.py.

◆ _suite_status

robot.running.suiterunner.SuiteRunner._suite_status
private

Definition at line 38 of file suiterunner.py.

◆ _variables

robot.running.suiterunner.SuiteRunner._variables
private

Definition at line 36 of file suiterunner.py.

◆ result

robot.running.suiterunner.SuiteRunner.result

Definition at line 33 of file suiterunner.py.

Property Documentation

◆ _context

robot.running.suiterunner.SuiteRunner._context = property
staticprivate

Definition at line 43 of file suiterunner.py.


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