robot.result.visitor.ResultVisitor Class Reference

Abstract class to conveniently travel :class:~robot.result.executionresult.Result objects. More...

Inheritance diagram for robot.result.visitor.ResultVisitor:

Public Member Functions
def	end_errors (self, errors)
def	end_result (self, result)
def	end_stat (self, stat)
def	end_statistics (self, stats)
def	end_suite_statistics (self, suite_stats)
def	end_tag_statistics (self, stats)
def	end_total_statistics (self, stats)
def	start_errors (self, errors)
def	start_result (self, result)
def	start_stat (self, stat)
def	start_statistics (self, stats)
def	start_suite_statistics (self, stats)
def	start_tag_statistics (self, stats)
def	start_total_statistics (self, stats)
def	visit_errors (self, errors)
def	visit_result (self, result)
def	visit_stat (self, stat)
def	visit_statistics (self, stats)
def	visit_suite_statistics (self, stats)
def	visit_tag_statistics (self, stats)
def	visit_total_statistics (self, stats)
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_suite (self, suite)
	Implements traversing through suites. 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...

Detailed Description

Abstract class to conveniently travel :class:~robot.result.executionresult.Result objects.

A visitor implementation can be given to the :meth:`visit` method of a
result object. This will cause the result object to be traversed and the
visitor's :meth:`visit_x`, :meth:`start_x`, and :meth:`end_x` methods to
be called for each suite, test, keyword and message, as well as for errors,
statistics, and other information in the result object. See methods below
for a full list of available visitor methods.

See the :mod:`result package level <robot.result>` documentation for
more information about handling results and a concrete visitor example.
For more information about the visitor algorithm see documentation in
:mod:`robot.model.visitor` module.

Definition at line 41 of file visitor.py.

Member Function Documentation

end_errors()

def robot.result.visitor.ResultVisitor.end_errors	(		self,
			errors
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 122 of file visitor.py.

end_result()

def robot.result.visitor.ResultVisitor.end_result	(		self,
			result
	)

Reimplemented in robot.reporting.outputwriter.OutputWriter.

Definition at line 52 of file visitor.py.

end_stat()

def robot.result.visitor.ResultVisitor.end_stat	(		self,
			stat
	)

Definition at line 110 of file visitor.py.

end_statistics()

def robot.result.visitor.ResultVisitor.end_statistics	(		self,
			stats
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 65 of file visitor.py.

end_suite_statistics()

def robot.result.visitor.ResultVisitor.end_suite_statistics	(		self,
			suite_stats
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 100 of file visitor.py.

end_tag_statistics()

def robot.result.visitor.ResultVisitor.end_tag_statistics	(		self,
			stats
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 88 of file visitor.py.

end_total_statistics()

def robot.result.visitor.ResultVisitor.end_total_statistics	(		self,
			stats
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 76 of file visitor.py.

start_errors()

def robot.result.visitor.ResultVisitor.start_errors	(		self,
			errors
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 119 of file visitor.py.

start_result()

def robot.result.visitor.ResultVisitor.start_result	(		self,
			result
	)

Definition at line 49 of file visitor.py.

start_stat()

def robot.result.visitor.ResultVisitor.start_stat	(		self,
			stat
	)

Definition at line 107 of file visitor.py.

start_statistics()

def robot.result.visitor.ResultVisitor.start_statistics	(		self,
			stats
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 62 of file visitor.py.

start_suite_statistics()

def robot.result.visitor.ResultVisitor.start_suite_statistics	(		self,
			stats
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 97 of file visitor.py.

start_tag_statistics()

def robot.result.visitor.ResultVisitor.start_tag_statistics	(		self,
			stats
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 85 of file visitor.py.

start_total_statistics()

def robot.result.visitor.ResultVisitor.start_total_statistics	(		self,
			stats
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 73 of file visitor.py.

visit_errors()

def robot.result.visitor.ResultVisitor.visit_errors	(		self,
			errors
	)

Definition at line 113 of file visitor.py.

visit_result()

def robot.result.visitor.ResultVisitor.visit_result	(		self,
			result
	)

Definition at line 42 of file visitor.py.

visit_stat()

def robot.result.visitor.ResultVisitor.visit_stat	(		self,
			stat
	)

Reimplemented in robot.output.xmllogger.XmlLogger.

Definition at line 103 of file visitor.py.

visit_statistics()

def robot.result.visitor.ResultVisitor.visit_statistics	(		self,
			stats
	)

Definition at line 55 of file visitor.py.

visit_suite_statistics()

def robot.result.visitor.ResultVisitor.visit_suite_statistics	(		self,
			stats
	)

Definition at line 91 of file visitor.py.

visit_tag_statistics()

def robot.result.visitor.ResultVisitor.visit_tag_statistics	(		self,
			stats
	)

Definition at line 79 of file visitor.py.

visit_total_statistics()

def robot.result.visitor.ResultVisitor.visit_total_statistics	(		self,
			stats
	)

Definition at line 68 of file visitor.py.

---

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

• src/robot/result/visitor.py