robotide.lib.robot.model.configurer.SuiteConfigurer Class Reference

Inheritance diagram for robotide.lib.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 the suite and its direct children. 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_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
	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 robotide.lib.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 robotide.lib.robot.model.configurer.SuiteConfigurer._filter (   self,   suite  )

private

Definition at line 62 of file configurer.py.

_format_selector_msg()

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

private

Definition at line 85 of file configurer.py.

_get_suite_selector_msg()

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

private

Definition at line 90 of file configurer.py.

_get_test_selector_msgs()

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

private

Definition at line 76 of file configurer.py.

_raise_no_tests_error()

def robotide.lib.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 robotide.lib.robot.model.configurer.SuiteConfigurer._set_suite_attributes (   self,   suite  )

private

Definition at line 54 of file configurer.py.

add_tags()

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

private

Definition at line 40 of file configurer.py.

remove_tags()

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

private

Definition at line 46 of file configurer.py.

visit_suite()

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

Reimplemented in robotide.lib.robot.result.configurer.SuiteConfigurer.

Definition at line 49 of file configurer.py.

Member Data Documentation

doc

robotide.lib.robot.model.configurer.SuiteConfigurer.doc

Definition at line 28 of file configurer.py.

empty_suite_ok

robotide.lib.robot.model.configurer.SuiteConfigurer.empty_suite_ok

Definition at line 35 of file configurer.py.

exclude_tags

robotide.lib.robot.model.configurer.SuiteConfigurer.exclude_tags

Definition at line 32 of file configurer.py.

include_suites

robotide.lib.robot.model.configurer.SuiteConfigurer.include_suites

Definition at line 33 of file configurer.py.

include_tags

robotide.lib.robot.model.configurer.SuiteConfigurer.include_tags

Definition at line 31 of file configurer.py.

include_tests

robotide.lib.robot.model.configurer.SuiteConfigurer.include_tests

Definition at line 34 of file configurer.py.

metadata

robotide.lib.robot.model.configurer.SuiteConfigurer.metadata

Definition at line 29 of file configurer.py.

name

robotide.lib.robot.model.configurer.SuiteConfigurer.name

Definition at line 27 of file configurer.py.

set_tags

robotide.lib.robot.model.configurer.SuiteConfigurer.set_tags

Definition at line 30 of file configurer.py.

Property Documentation

add_tags

robotide.lib.robot.model.configurer.SuiteConfigurer.add_tags = property

static

Definition at line 38 of file configurer.py.

remove_tags

robotide.lib.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/robotide/lib/robot/model/configurer.py