visitor

Interface to ease traversing through a test suite structure.

Visitors make it easy to modify test suite structures or to collect information from them. They work both with the :mod:executable model <robot.running.model> and the :mod:result model <robot.result.model>, but the objects passed to the visitor methods are slightly different depending on the model they are used with. The main differences are that on the execution side keywords do not have child keywords nor messages, and that only the result objects have status related attributes like :attr:status and :attr:start_time.

This module contains :class:SuiteVisitor that implements the core logic to visit a test suite structure, and the :mod:~robot.result package contains :class:~robot.result.visitor.ResultVisitor that supports visiting the whole test execution result structure. Both of these visitors should be imported via the :mod:robot.api package when used by external code.

Visitor algorithm

All suite, test, keyword and message objects have a :meth:visit method that accepts a visitor instance. These methods will then call the correct visitor method :meth:~SuiteVisitor.visit_suite, :meth:~SuiteVisitor.visit_test, :meth:~SuiteVisitor.visit_keyword or :meth:~SuiteVisitor.visit_message, depending on the instance where the :meth:visit method exists.

The recommended and definitely the easiest way to implement a visitor is extending the :class:SuiteVisitor base class. The default implementation of its :meth:visit_x methods take care of traversing child elements of the object :obj:x recursively. A :meth:visit_x method first calls a corresponding :meth:start_x method (e.g. :meth:visit_suite calls :meth:start_suite), then calls :meth:visit for all child objects of the :obj:x object, and finally calls the corresponding :meth:end_x method. The default implementations of :meth:start_x and :meth:end_x do nothing.

All items that can appear inside tests have their own visit methods. These include :meth:visit_keyword, :meth:visit_message (only applicable with results, not with executable data), :meth:visit_for, :meth:visit_if, and so on, as well as their appropriate start/end methods like :meth:start_keyword and :meth:end_for. If there is a need to visit all these items, it is possible to implement only :meth:start_body_item and :meth:end_body_item methods that are, by default, called by the appropriate start/end methods. These generic methods are new in Robot Framework 5.0.

Visitors extending the :class:SuiteVisitor can stop visiting at a certain level either by overriding suitable :meth:visit_x method or by returning an explicit False from any :meth:start_x method.

Examples

The following example visitor modifies the test suite structure it visits. It could be used, for example, with Robot Framework's --prerunmodifier option to modify test data before execution.

.. literalinclude:: ../../../doc/api/code_examples/SelectEveryXthTest.py :language: python

For more examples it is possible to look at the source code of visitors used internally by Robot Framework itself. Some good examples are :class:~robot.model.tagsetter.TagSetter and :mod:keyword removers <robot.result.keywordremover>.

Type hints

Visitor methods have type hints to give more information about the model objects they receive to editors. Because visitors can be used with both running and result models, the types that are used as type hints are base classes from the :mod:robot.model module. Actual visitor implementations can import appropriate types from the :mod:robot.running or the :mod:robot.result module instead. For example, this visitor uses the result side model objects::

from robot.api import SuiteVisitor
from robot.result import TestCase, TestSuite


class FailurePrinter(SuiteVisitor):

    def start_suite(self, suite: TestSuite):
        print(f"{suite.full_name}: {suite.statistics.failed} failed")

    def visit_test(self, test: TestCase):
        if test.failed:
            print(f'- {test.name}: {test.message}')

Type hints were added in Robot Framework 6.1. They are optional and can be removed altogether if they get in the way.

SuiteVisitor

Abstract class to ease traversing through the suite structure.

See the :mod:module level <robot.model.visitor> documentation for more information and an example.

Source code in src/robot/model/visitor.py

class SuiteVisitor:
    """Abstract class to ease traversing through the suite structure.

    See the :mod:`module level <robot.model.visitor>` documentation for more
    information and an example.
    """

    def visit_suite(self, suite: 'TestSuite'):
        """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.
        """
        if self.start_suite(suite) is not False:
            if suite.has_setup:
                suite.setup.visit(self)
            suite.suites.visit(self)
            suite.tests.visit(self)
            if suite.has_teardown:
                suite.teardown.visit(self)
            self.end_suite(suite)

    def start_suite(self, suite: 'TestSuite') -> 'bool|None':
        """Called when a suite starts. Default implementation does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        pass

    def end_suite(self, suite: 'TestSuite'):
        """Called when a suite ends. Default implementation does nothing."""
        pass

    def visit_test(self, test: 'TestCase'):
        """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.
        """
        if self.start_test(test) is not False:
            if test.has_setup:
                test.setup.visit(self)
            test.body.visit(self)
            if test.has_teardown:
                test.teardown.visit(self)
            self.end_test(test)

    def start_test(self, test: 'TestCase') -> 'bool|None':
        """Called when a test starts. Default implementation does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        pass

    def end_test(self, test: 'TestCase'):
        """Called when a test ends. Default implementation does nothing."""
        pass

    def visit_keyword(self, keyword: 'Keyword'):
        """Implements traversing through keywords.

        Can be overridden to allow modifying the passed in ``kw`` without
        calling :meth:`start_keyword` or :meth:`end_keyword` nor visiting
        the body of the keyword
        """
        if self.start_keyword(keyword) is not False:
            self._possible_setup(keyword)
            self._possible_body(keyword)
            self._possible_teardown(keyword)
            self.end_keyword(keyword)

    def _possible_setup(self, item: 'BodyItem'):
        if getattr(item, 'has_setup', False):
            item.setup.visit(self)    # type: ignore

    def _possible_body(self, item: 'BodyItem'):
        if hasattr(item, 'body'):
            item.body.visit(self)    # type: ignore

    def _possible_teardown(self, item: 'BodyItem'):
        if getattr(item, 'has_teardown', False):
            item.teardown.visit(self)    # type: ignore

    def start_keyword(self, keyword: 'Keyword') -> 'bool|None':
        """Called when a keyword starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(keyword)

    def end_keyword(self, keyword: 'Keyword'):
        """Called when a keyword ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(keyword)

    def visit_for(self, for_: 'For'):
        """Implements traversing through FOR loops.

        Can be overridden to allow modifying the passed in ``for_`` without
        calling :meth:`start_for` or :meth:`end_for` nor visiting body.
        """
        if self.start_for(for_) is not False:
            for_.body.visit(self)
            self.end_for(for_)

    def start_for(self, for_: 'For') -> 'bool|None':
        """Called when a FOR loop starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(for_)

    def end_for(self, for_: 'For'):
        """Called when a FOR loop ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(for_)

    def visit_for_iteration(self, iteration: 'ForIteration'):
        """Implements traversing through single FOR loop iteration.

        This is only used with the result side model because on the running side
        there are no iterations.

        Can be overridden to allow modifying the passed in ``iteration`` without
        calling :meth:`start_for_iteration` or :meth:`end_for_iteration` nor visiting
        body.
        """
        if self.start_for_iteration(iteration) is not False:
            iteration.body.visit(self)
            self.end_for_iteration(iteration)

    def start_for_iteration(self, iteration: 'ForIteration') -> 'bool|None':
        """Called when a FOR loop iteration starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(iteration)

    def end_for_iteration(self, iteration: 'ForIteration'):
        """Called when a FOR loop iteration ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(iteration)

    def visit_if(self, if_: 'If'):
        """Implements traversing through IF/ELSE structures.

        Notice that ``if_`` does not have any data directly. Actual IF/ELSE
        branches are in its ``body`` and they are visited separately using
        :meth:`visit_if_branch`.

        Can be overridden to allow modifying the passed in ``if_`` without
        calling :meth:`start_if` or :meth:`end_if` nor visiting branches.
        """
        if self.start_if(if_) is not False:
            if_.body.visit(self)
            self.end_if(if_)

    def start_if(self, if_: 'If') -> 'bool|None':
        """Called when an IF/ELSE structure starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(if_)

    def end_if(self, if_: 'If'):
        """Called when an IF/ELSE structure ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(if_)

    def visit_if_branch(self, branch: 'IfBranch'):
        """Implements traversing through single IF/ELSE branch.

        Can be overridden to allow modifying the passed in ``branch`` without
        calling :meth:`start_if_branch` or :meth:`end_if_branch` nor visiting body.
        """
        if self.start_if_branch(branch) is not False:
            branch.body.visit(self)
            self.end_if_branch(branch)

    def start_if_branch(self, branch: 'IfBranch') -> 'bool|None':
        """Called when an IF/ELSE branch starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(branch)

    def end_if_branch(self, branch: 'IfBranch'):
        """Called when an IF/ELSE branch ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(branch)

    def visit_try(self, try_: 'Try'):
        """Implements traversing through TRY/EXCEPT structures.

        This method is used with the TRY/EXCEPT root element. Actual TRY, EXCEPT, ELSE
        and FINALLY branches are visited separately using :meth:`visit_try_branch`.
        """
        if self.start_try(try_) is not False:
            try_.body.visit(self)
            self.end_try(try_)

    def start_try(self, try_: 'Try') -> 'bool|None':
        """Called when a TRY/EXCEPT structure starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(try_)

    def end_try(self, try_: 'Try'):
        """Called when a TRY/EXCEPT structure ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(try_)

    def visit_try_branch(self, branch: 'TryBranch'):
        """Visits individual TRY, EXCEPT, ELSE and FINALLY branches."""
        if self.start_try_branch(branch) is not False:
            branch.body.visit(self)
            self.end_try_branch(branch)

    def start_try_branch(self, branch: 'TryBranch') -> 'bool|None':
        """Called when TRY, EXCEPT, ELSE or FINALLY branches start.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(branch)

    def end_try_branch(self, branch: 'TryBranch'):
        """Called when TRY, EXCEPT, ELSE and FINALLY branches end.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(branch)

    def visit_while(self, while_: 'While'):
        """Implements traversing through WHILE loops.

        Can be overridden to allow modifying the passed in ``while_`` without
        calling :meth:`start_while` or :meth:`end_while` nor visiting body.
        """
        if self.start_while(while_) is not False:
            while_.body.visit(self)
            self.end_while(while_)

    def start_while(self, while_: 'While') -> 'bool|None':
        """Called when a WHILE loop starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(while_)

    def end_while(self, while_: 'While'):
        """Called when a WHILE loop ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(while_)

    def visit_while_iteration(self, iteration: 'WhileIteration'):
        """Implements traversing through single WHILE loop iteration.

        This is only used with the result side model because on the running side
        there are no iterations.

        Can be overridden to allow modifying the passed in ``iteration`` without
        calling :meth:`start_while_iteration` or :meth:`end_while_iteration` nor visiting
        body.
        """
        if self.start_while_iteration(iteration) is not False:
            iteration.body.visit(self)
            self.end_while_iteration(iteration)

    def start_while_iteration(self, iteration: 'WhileIteration') -> 'bool|None':
        """Called when a WHILE loop iteration starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(iteration)

    def end_while_iteration(self, iteration: 'WhileIteration'):
        """Called when a WHILE loop iteration ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(iteration)

    def visit_var(self, var: 'Var'):
        """Visits a VAR elements."""
        if self.start_var(var) is not False:
            self._possible_body(var)
            self.end_var(var)

    def start_var(self, var: 'Var') -> 'bool|None':
        """Called when a VAR element starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(var)

    def end_var(self, var: 'Var'):
        """Called when a VAR element ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(var)

    def visit_return(self, return_: 'Return'):
        """Visits a RETURN elements."""
        if self.start_return(return_) is not False:
            self._possible_body(return_)
            self.end_return(return_)

    def start_return(self, return_: 'Return') -> 'bool|None':
        """Called when a RETURN element starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(return_)

    def end_return(self, return_: 'Return'):
        """Called when a RETURN element ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(return_)

    def visit_continue(self, continue_: 'Continue'):
        """Visits CONTINUE elements."""
        if self.start_continue(continue_) is not False:
            self._possible_body(continue_)
            self.end_continue(continue_)

    def start_continue(self, continue_: 'Continue') -> 'bool|None':
        """Called when a CONTINUE element starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(continue_)

    def end_continue(self, continue_: 'Continue'):
        """Called when a CONTINUE element ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(continue_)

    def visit_break(self, break_: 'Break'):
        """Visits BREAK elements."""
        if self.start_break(break_) is not False:
            self._possible_body(break_)
            self.end_break(break_)

    def start_break(self, break_: 'Break') -> 'bool|None':
        """Called when a BREAK element starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(break_)

    def end_break(self, break_: 'Break'):
        """Called when a BREAK element ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(break_)

    def visit_error(self, error: 'Error'):
        """Visits body items resulting from invalid syntax.

        Examples include syntax like ``END`` or ``ELSE`` in wrong place and
        invalid setting like ``[Invalid]``.
        """
        if self.start_error(error) is not False:
            self._possible_body(error)
            self.end_error(error)

    def start_error(self, error: 'Error') -> 'bool|None':
        """Called when a ERROR element starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(error)

    def end_error(self, error: 'Error'):
        """Called when a ERROR element ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(error)

    def visit_message(self, message: 'Message'):
        """Implements visiting messages.

        Can be overridden to allow modifying the passed in ``msg`` without
        calling :meth:`start_message` or :meth:`end_message`.
        """
        if self.start_message(message) is not False:
            self.end_message(message)

    def start_message(self, message: 'Message') -> 'bool|None':
        """Called when a message starts.

        By default, calls :meth:`start_body_item` which, by default, does nothing.

        Can return explicit ``False`` to stop visiting.
        """
        return self.start_body_item(message)

    def end_message(self, message: 'Message'):
        """Called when a message ends.

        By default, calls :meth:`end_body_item` which, by default, does nothing.
        """
        self.end_body_item(message)

    def start_body_item(self, item: 'BodyItem') -> 'bool|None':
        """Called, by default, when keywords, messages or control structures start.

        More specific :meth:`start_keyword`, :meth:`start_message`, `:meth:`start_for`,
        etc. can be implemented to visit only keywords, messages or specific control
        structures.

        Can return explicit ``False`` to stop visiting. Default implementation does
        nothing.
        """
        pass

    def end_body_item(self, item: 'BodyItem'):
        """Called, by default, when keywords, messages or control structures end.

        More specific :meth:`end_keyword`, :meth:`end_message`, `:meth:`end_for`,
        etc. can be implemented to visit only keywords, messages or specific control
        structures.

        Default implementation does nothing.
        """
        pass

end_body_item(item)

Called, by default, when keywords, messages or control structures end.

More specific :meth:end_keyword, :meth:end_message, :meth:end_for`, etc. can be implemented to visit only keywords, messages or specific control structures.

Default implementation does nothing.

Source code in src/robot/model/visitor.py

def end_body_item(self, item: 'BodyItem'):
    """Called, by default, when keywords, messages or control structures end.

    More specific :meth:`end_keyword`, :meth:`end_message`, `:meth:`end_for`,
    etc. can be implemented to visit only keywords, messages or specific control
    structures.

    Default implementation does nothing.
    """
    pass

end_break(break_)

Called when a BREAK element ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_break(self, break_: 'Break'):
    """Called when a BREAK element ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(break_)

end_continue(continue_)

Called when a CONTINUE element ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_continue(self, continue_: 'Continue'):
    """Called when a CONTINUE element ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(continue_)

end_error(error)

Called when a ERROR element ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_error(self, error: 'Error'):
    """Called when a ERROR element ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(error)

end_for(for_)

Called when a FOR loop ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_for(self, for_: 'For'):
    """Called when a FOR loop ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(for_)

end_for_iteration(iteration)

Called when a FOR loop iteration ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_for_iteration(self, iteration: 'ForIteration'):
    """Called when a FOR loop iteration ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(iteration)

end_if(if_)

Called when an IF/ELSE structure ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_if(self, if_: 'If'):
    """Called when an IF/ELSE structure ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(if_)

end_if_branch(branch)

Called when an IF/ELSE branch ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_if_branch(self, branch: 'IfBranch'):
    """Called when an IF/ELSE branch ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(branch)

end_keyword(keyword)

Called when a keyword ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_keyword(self, keyword: 'Keyword'):
    """Called when a keyword ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(keyword)

end_message(message)

Called when a message ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_message(self, message: 'Message'):
    """Called when a message ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(message)

end_return(return_)

Called when a RETURN element ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_return(self, return_: 'Return'):
    """Called when a RETURN element ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(return_)

end_suite(suite)

Called when a suite ends. Default implementation does nothing.

Source code in src/robot/model/visitor.py

def end_suite(self, suite: 'TestSuite'):
    """Called when a suite ends. Default implementation does nothing."""
    pass

end_test(test)

Called when a test ends. Default implementation does nothing.

Source code in src/robot/model/visitor.py

def end_test(self, test: 'TestCase'):
    """Called when a test ends. Default implementation does nothing."""
    pass

end_try(try_)

Called when a TRY/EXCEPT structure ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_try(self, try_: 'Try'):
    """Called when a TRY/EXCEPT structure ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(try_)

end_try_branch(branch)

Called when TRY, EXCEPT, ELSE and FINALLY branches end.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_try_branch(self, branch: 'TryBranch'):
    """Called when TRY, EXCEPT, ELSE and FINALLY branches end.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(branch)

end_var(var)

Called when a VAR element ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_var(self, var: 'Var'):
    """Called when a VAR element ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(var)

end_while(while_)

Called when a WHILE loop ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_while(self, while_: 'While'):
    """Called when a WHILE loop ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(while_)

end_while_iteration(iteration)

Called when a WHILE loop iteration ends.

By default, calls :meth:end_body_item which, by default, does nothing.

Source code in src/robot/model/visitor.py

def end_while_iteration(self, iteration: 'WhileIteration'):
    """Called when a WHILE loop iteration ends.

    By default, calls :meth:`end_body_item` which, by default, does nothing.
    """
    self.end_body_item(iteration)

start_body_item(item)

Called, by default, when keywords, messages or control structures start.

More specific :meth:start_keyword, :meth:start_message, :meth:start_for`, etc. can be implemented to visit only keywords, messages or specific control structures.

Can return explicit False to stop visiting. Default implementation does nothing.

Source code in src/robot/model/visitor.py

def start_body_item(self, item: 'BodyItem') -> 'bool|None':
    """Called, by default, when keywords, messages or control structures start.

    More specific :meth:`start_keyword`, :meth:`start_message`, `:meth:`start_for`,
    etc. can be implemented to visit only keywords, messages or specific control
    structures.

    Can return explicit ``False`` to stop visiting. Default implementation does
    nothing.
    """
    pass

start_break(break_)

Called when a BREAK element starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_break(self, break_: 'Break') -> 'bool|None':
    """Called when a BREAK element starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(break_)

start_continue(continue_)

Called when a CONTINUE element starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_continue(self, continue_: 'Continue') -> 'bool|None':
    """Called when a CONTINUE element starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(continue_)

start_error(error)

Called when a ERROR element starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_error(self, error: 'Error') -> 'bool|None':
    """Called when a ERROR element starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(error)

start_for(for_)

Called when a FOR loop starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_for(self, for_: 'For') -> 'bool|None':
    """Called when a FOR loop starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(for_)

start_for_iteration(iteration)

Called when a FOR loop iteration starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_for_iteration(self, iteration: 'ForIteration') -> 'bool|None':
    """Called when a FOR loop iteration starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(iteration)

start_if(if_)

Called when an IF/ELSE structure starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_if(self, if_: 'If') -> 'bool|None':
    """Called when an IF/ELSE structure starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(if_)

start_if_branch(branch)

Called when an IF/ELSE branch starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_if_branch(self, branch: 'IfBranch') -> 'bool|None':
    """Called when an IF/ELSE branch starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(branch)

start_keyword(keyword)

Called when a keyword starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_keyword(self, keyword: 'Keyword') -> 'bool|None':
    """Called when a keyword starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(keyword)

start_message(message)

Called when a message starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_message(self, message: 'Message') -> 'bool|None':
    """Called when a message starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(message)

start_return(return_)

Called when a RETURN element starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_return(self, return_: 'Return') -> 'bool|None':
    """Called when a RETURN element starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(return_)

start_suite(suite)

Called when a suite starts. Default implementation does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_suite(self, suite: 'TestSuite') -> 'bool|None':
    """Called when a suite starts. Default implementation does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    pass

start_test(test)

Called when a test starts. Default implementation does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_test(self, test: 'TestCase') -> 'bool|None':
    """Called when a test starts. Default implementation does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    pass

start_try(try_)

Called when a TRY/EXCEPT structure starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_try(self, try_: 'Try') -> 'bool|None':
    """Called when a TRY/EXCEPT structure starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(try_)

start_try_branch(branch)

Called when TRY, EXCEPT, ELSE or FINALLY branches start.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_try_branch(self, branch: 'TryBranch') -> 'bool|None':
    """Called when TRY, EXCEPT, ELSE or FINALLY branches start.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(branch)

start_var(var)

Called when a VAR element starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_var(self, var: 'Var') -> 'bool|None':
    """Called when a VAR element starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(var)

start_while(while_)

Called when a WHILE loop starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_while(self, while_: 'While') -> 'bool|None':
    """Called when a WHILE loop starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(while_)

start_while_iteration(iteration)

Called when a WHILE loop iteration starts.

By default, calls :meth:start_body_item which, by default, does nothing.

Can return explicit False to stop visiting.

Source code in src/robot/model/visitor.py

def start_while_iteration(self, iteration: 'WhileIteration') -> 'bool|None':
    """Called when a WHILE loop iteration starts.

    By default, calls :meth:`start_body_item` which, by default, does nothing.

    Can return explicit ``False`` to stop visiting.
    """
    return self.start_body_item(iteration)

visit_break(break_)

Visits BREAK elements.

Source code in src/robot/model/visitor.py

def visit_break(self, break_: 'Break'):
    """Visits BREAK elements."""
    if self.start_break(break_) is not False:
        self._possible_body(break_)
        self.end_break(break_)

visit_continue(continue_)

Visits CONTINUE elements.

Source code in src/robot/model/visitor.py

def visit_continue(self, continue_: 'Continue'):
    """Visits CONTINUE elements."""
    if self.start_continue(continue_) is not False:
        self._possible_body(continue_)
        self.end_continue(continue_)

visit_error(error)

Visits body items resulting from invalid syntax.

Examples include syntax like END or ELSE in wrong place and invalid setting like [Invalid].

Source code in src/robot/model/visitor.py

def visit_error(self, error: 'Error'):
    """Visits body items resulting from invalid syntax.

    Examples include syntax like ``END`` or ``ELSE`` in wrong place and
    invalid setting like ``[Invalid]``.
    """
    if self.start_error(error) is not False:
        self._possible_body(error)
        self.end_error(error)

visit_for(for_)

Implements traversing through FOR loops.

Can be overridden to allow modifying the passed in for_ without calling :meth:start_for or :meth:end_for nor visiting body.

Source code in src/robot/model/visitor.py

def visit_for(self, for_: 'For'):
    """Implements traversing through FOR loops.

    Can be overridden to allow modifying the passed in ``for_`` without
    calling :meth:`start_for` or :meth:`end_for` nor visiting body.
    """
    if self.start_for(for_) is not False:
        for_.body.visit(self)
        self.end_for(for_)

visit_for_iteration(iteration)

Implements traversing through single FOR loop iteration.

This is only used with the result side model because on the running side there are no iterations.

Can be overridden to allow modifying the passed in iteration without calling :meth:start_for_iteration or :meth:end_for_iteration nor visiting body.

Source code in src/robot/model/visitor.py

def visit_for_iteration(self, iteration: 'ForIteration'):
    """Implements traversing through single FOR loop iteration.

    This is only used with the result side model because on the running side
    there are no iterations.

    Can be overridden to allow modifying the passed in ``iteration`` without
    calling :meth:`start_for_iteration` or :meth:`end_for_iteration` nor visiting
    body.
    """
    if self.start_for_iteration(iteration) is not False:
        iteration.body.visit(self)
        self.end_for_iteration(iteration)

visit_if(if_)

Implements traversing through IF/ELSE structures.

Notice that if_ does not have any data directly. Actual IF/ELSE branches are in its body and they are visited separately using :meth:visit_if_branch.

Can be overridden to allow modifying the passed in if_ without calling :meth:start_if or :meth:end_if nor visiting branches.

Source code in src/robot/model/visitor.py

def visit_if(self, if_: 'If'):
    """Implements traversing through IF/ELSE structures.

    Notice that ``if_`` does not have any data directly. Actual IF/ELSE
    branches are in its ``body`` and they are visited separately using
    :meth:`visit_if_branch`.

    Can be overridden to allow modifying the passed in ``if_`` without
    calling :meth:`start_if` or :meth:`end_if` nor visiting branches.
    """
    if self.start_if(if_) is not False:
        if_.body.visit(self)
        self.end_if(if_)

visit_if_branch(branch)

Implements traversing through single IF/ELSE branch.

Can be overridden to allow modifying the passed in branch without calling :meth:start_if_branch or :meth:end_if_branch nor visiting body.

Source code in src/robot/model/visitor.py

def visit_if_branch(self, branch: 'IfBranch'):
    """Implements traversing through single IF/ELSE branch.

    Can be overridden to allow modifying the passed in ``branch`` without
    calling :meth:`start_if_branch` or :meth:`end_if_branch` nor visiting body.
    """
    if self.start_if_branch(branch) is not False:
        branch.body.visit(self)
        self.end_if_branch(branch)

visit_keyword(keyword)

Implements traversing through keywords.

Can be overridden to allow modifying the passed in kw without calling :meth:start_keyword or :meth:end_keyword nor visiting the body of the keyword

Source code in src/robot/model/visitor.py

def visit_keyword(self, keyword: 'Keyword'):
    """Implements traversing through keywords.

    Can be overridden to allow modifying the passed in ``kw`` without
    calling :meth:`start_keyword` or :meth:`end_keyword` nor visiting
    the body of the keyword
    """
    if self.start_keyword(keyword) is not False:
        self._possible_setup(keyword)
        self._possible_body(keyword)
        self._possible_teardown(keyword)
        self.end_keyword(keyword)

visit_message(message)

Implements visiting messages.

Can be overridden to allow modifying the passed in msg without calling :meth:start_message or :meth:end_message.

Source code in src/robot/model/visitor.py

def visit_message(self, message: 'Message'):
    """Implements visiting messages.

    Can be overridden to allow modifying the passed in ``msg`` without
    calling :meth:`start_message` or :meth:`end_message`.
    """
    if self.start_message(message) is not False:
        self.end_message(message)

visit_return(return_)

Visits a RETURN elements.

Source code in src/robot/model/visitor.py

def visit_return(self, return_: 'Return'):
    """Visits a RETURN elements."""
    if self.start_return(return_) is not False:
        self._possible_body(return_)
        self.end_return(return_)

visit_suite(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.

Source code in src/robot/model/visitor.py

def visit_suite(self, suite: 'TestSuite'):
    """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.
    """
    if self.start_suite(suite) is not False:
        if suite.has_setup:
            suite.setup.visit(self)
        suite.suites.visit(self)
        suite.tests.visit(self)
        if suite.has_teardown:
            suite.teardown.visit(self)
        self.end_suite(suite)

visit_test(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.

Source code in src/robot/model/visitor.py

def visit_test(self, test: 'TestCase'):
    """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.
    """
    if self.start_test(test) is not False:
        if test.has_setup:
            test.setup.visit(self)
        test.body.visit(self)
        if test.has_teardown:
            test.teardown.visit(self)
        self.end_test(test)

visit_try(try_)

Implements traversing through TRY/EXCEPT structures.

This method is used with the TRY/EXCEPT root element. Actual TRY, EXCEPT, ELSE and FINALLY branches are visited separately using :meth:visit_try_branch.

Source code in src/robot/model/visitor.py

def visit_try(self, try_: 'Try'):
    """Implements traversing through TRY/EXCEPT structures.

    This method is used with the TRY/EXCEPT root element. Actual TRY, EXCEPT, ELSE
    and FINALLY branches are visited separately using :meth:`visit_try_branch`.
    """
    if self.start_try(try_) is not False:
        try_.body.visit(self)
        self.end_try(try_)

visit_try_branch(branch)

Visits individual TRY, EXCEPT, ELSE and FINALLY branches.

Source code in src/robot/model/visitor.py

def visit_try_branch(self, branch: 'TryBranch'):
    """Visits individual TRY, EXCEPT, ELSE and FINALLY branches."""
    if self.start_try_branch(branch) is not False:
        branch.body.visit(self)
        self.end_try_branch(branch)

visit_var(var)

Visits a VAR elements.

Source code in src/robot/model/visitor.py

def visit_var(self, var: 'Var'):
    """Visits a VAR elements."""
    if self.start_var(var) is not False:
        self._possible_body(var)
        self.end_var(var)

visit_while(while_)

Implements traversing through WHILE loops.

Can be overridden to allow modifying the passed in while_ without calling :meth:start_while or :meth:end_while nor visiting body.

Source code in src/robot/model/visitor.py

def visit_while(self, while_: 'While'):
    """Implements traversing through WHILE loops.

    Can be overridden to allow modifying the passed in ``while_`` without
    calling :meth:`start_while` or :meth:`end_while` nor visiting body.
    """
    if self.start_while(while_) is not False:
        while_.body.visit(self)
        self.end_while(while_)

visit_while_iteration(iteration)

Implements traversing through single WHILE loop iteration.

This is only used with the result side model because on the running side there are no iterations.

Can be overridden to allow modifying the passed in iteration without calling :meth:start_while_iteration or :meth:end_while_iteration nor visiting body.

Source code in src/robot/model/visitor.py

def visit_while_iteration(self, iteration: 'WhileIteration'):
    """Implements traversing through single WHILE loop iteration.

    This is only used with the result side model because on the running side
    there are no iterations.

    Can be overridden to allow modifying the passed in ``iteration`` without
    calling :meth:`start_while_iteration` or :meth:`end_while_iteration` nor visiting
    body.
    """
    if self.start_while_iteration(iteration) is not False:
        iteration.body.visit(self)
        self.end_while_iteration(iteration)