robot.model.modifier.ModelModifier Class Reference

Inheritance diagram for robot.model.modifier.ModelModifier:

Public Member Functions
def	__init__ (self, visitors, empty_suite_ok, logger)
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...

Private Member Functions
def	_yield_visitors (self, visitors, logger)

Private Attributes
	_empty_suite_ok
	_log_error
	_visitors

Detailed Description

Definition at line 23 of file modifier.py.

Constructor & Destructor Documentation

__init__()

def robot.model.modifier.ModelModifier.__init__	(		self,
			visitors,
			empty_suite_ok,
			logger
	)

Definition at line 25 of file modifier.py.

Member Function Documentation

_yield_visitors()

def robot.model.modifier.ModelModifier._yield_visitors (   self,   visitors,   logger  )

private

Definition at line 42 of file modifier.py.

visit_suite()

def robot.model.modifier.ModelModifier.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.

Definition at line 30 of file modifier.py.

Member Data Documentation

_empty_suite_ok

robot.model.modifier.ModelModifier._empty_suite_ok

private

Definition at line 27 of file modifier.py.

_log_error

robot.model.modifier.ModelModifier._log_error

private

Definition at line 26 of file modifier.py.

_visitors

robot.model.modifier.ModelModifier._visitors

private

Definition at line 28 of file modifier.py.

---

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

• src/robot/model/modifier.py