robot.model.configurer.SuiteConfigurer Class Reference

Inheritance diagram for robot.model.configurer.SuiteConfigurer:

Public Member Functions
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)
def	visit_suite (self, suite)
	Implements traversing through suites. 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_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
	doc
	empty_suite_ok
	exclude_tags
	include_suites
	include_tags
	include_tests
	metadata
	name
	set_tags

Properties
	add_tags = property
	remove_tags = property

Private Member Functions
def	_filter (self, suite)
def	_format_selector_msg (self, explanation, selector)
def	_get_suite_selector_msg (self)
def	_get_test_selector_msgs (self)
def	_raise_no_tests_error (self, suite, rpa=False)
def	_set_suite_attributes (self, suite)
def	add_tags (self)
def	remove_tags (self)

Detailed Description

Definition at line 22 of file configurer.py.

Constructor & Destructor Documentation

__init__()

def robot.model.configurer.SuiteConfigurer.__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
	)

Definition at line 24 of file configurer.py.

Member Function Documentation

_filter()

def robot.model.configurer.SuiteConfigurer._filter (   self,   suite  )

private

Definition at line 62 of file configurer.py.

_format_selector_msg()

def robot.model.configurer.SuiteConfigurer._format_selector_msg (   self,   explanation,   selector  )

private

Definition at line 85 of file configurer.py.

_get_suite_selector_msg()

def robot.model.configurer.SuiteConfigurer._get_suite_selector_msg (   self )

private

Definition at line 90 of file configurer.py.

_get_test_selector_msgs()

def robot.model.configurer.SuiteConfigurer._get_test_selector_msgs (   self )

private

Definition at line 76 of file configurer.py.

_raise_no_tests_error()

def robot.model.configurer.SuiteConfigurer._raise_no_tests_error (   self,   suite,   rpa = False  )

private

Definition at line 69 of file configurer.py.

_set_suite_attributes()

def robot.model.configurer.SuiteConfigurer._set_suite_attributes (   self,   suite  )

private

Definition at line 54 of file configurer.py.

add_tags()

def robot.model.configurer.SuiteConfigurer.add_tags (   self )

private

Definition at line 40 of file configurer.py.

remove_tags()

def robot.model.configurer.SuiteConfigurer.remove_tags (   self )

private

Definition at line 46 of file configurer.py.

visit_suite()

def robot.model.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.visitor.SuiteVisitor.

Reimplemented in robot.result.configurer.SuiteConfigurer.

Definition at line 49 of file configurer.py.

Member Data Documentation

doc

robot.model.configurer.SuiteConfigurer.doc

Definition at line 28 of file configurer.py.

empty_suite_ok

robot.model.configurer.SuiteConfigurer.empty_suite_ok

Definition at line 35 of file configurer.py.

exclude_tags

robot.model.configurer.SuiteConfigurer.exclude_tags

Definition at line 32 of file configurer.py.

include_suites

robot.model.configurer.SuiteConfigurer.include_suites

Definition at line 33 of file configurer.py.

include_tags

robot.model.configurer.SuiteConfigurer.include_tags

Definition at line 31 of file configurer.py.

include_tests

robot.model.configurer.SuiteConfigurer.include_tests

Definition at line 34 of file configurer.py.

metadata

robot.model.configurer.SuiteConfigurer.metadata

Definition at line 29 of file configurer.py.

name

robot.model.configurer.SuiteConfigurer.name

Definition at line 27 of file configurer.py.

set_tags

robot.model.configurer.SuiteConfigurer.set_tags

Definition at line 30 of file configurer.py.

Property Documentation

add_tags

robot.model.configurer.SuiteConfigurer.add_tags = property

static

Definition at line 38 of file configurer.py.

remove_tags

robot.model.configurer.SuiteConfigurer.remove_tags = property

static

Definition at line 44 of file configurer.py.

---

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

• src/robot/model/configurer.py