Robot Framework
robot.model.body.BaseBody Class Reference

Base class for Body and Branches objects. More...

Inheritance diagram for robot.model.body.BaseBody:
robot.model.itemlist.ItemList robot.model.body.Body robot.model.body.Branches robot.result.model.Iterations robot.result.model.Body robot.running.model.Body robot.result.model.Branches

Public Member Functions

def __init__ (self, parent=None, items=None)
 
def create_break (self, *args, **kwargs)
 
def create_continue (self, *args, **kwargs)
 
def create_for (self, *args, **kwargs)
 
def create_if (self, *args, **kwargs)
 
def create_keyword (self, *args, **kwargs)
 
def create_message (self, *args, **kwargs)
 
def create_return (self, *args, **kwargs)
 
def create_try (self, *args, **kwargs)
 
def create_while (self, *args, **kwargs)
 
def filter (self, keywords=None, messages=None, predicate=None)
 Filter body items based on type and/or custom predicate. More...
 
def flatten (self)
 Return steps so that IF and TRY structures are flattened. More...
 
def register (cls, item_class)
 
- Public Member Functions inherited from robot.model.itemlist.ItemList
def __add__ (self, other)
 
def __contains__ (self, item)
 
def __delitem__ (self, index)
 
def __eq__ (self, other)
 
def __getitem__ (self, index)
 
def __iadd__ (self, other)
 
def __imul__ (self, other)
 
def __init__ (self, item_class, common_attrs=None, items=None)
 
def __iter__ (self)
 
def __len__ (self)
 
def __lt__ (self, other)
 
def __mul__ (self, other)
 
def __repr__ (self)
 
def __reversed__ (self)
 
def __rmul__ (self, other)
 
def __setitem__ (self, index, item)
 
def __str__ (self)
 
def append (self, item)
 
def clear (self)
 
def count (self, item)
 
def create (self, *args, **kwargs)
 
def extend (self, items)
 
def index (self, item, *start_and_end)
 
def insert (self, index, item)
 
def reverse (self)
 
def sort (self)
 
def visit (self, visitor)
 

Static Public Attributes

 break_class = None
 
 continue_class = None
 
 for_class = None
 
 if_class = None
 
 keyword_class = None
 
 message_class = None
 
 return_class = None
 
 try_class = None
 
 while_class = None
 

Properties

 create = property
 

Private Member Functions

def _create (self, cls, name, args, kwargs)
 
def _filter (self, types, predicate)
 
def create (self)
 

Static Private Attributes

list __slots__ = []
 

Detailed Description

Base class for Body and Branches objects.

Definition at line 86 of file body.py.

Constructor & Destructor Documentation

◆ __init__()

def robot.model.body.BaseBody.__init__ (   self,
  parent = None,
  items = None 
)

Definition at line 99 of file body.py.

Member Function Documentation

◆ _create()

def robot.model.body.BaseBody._create (   self,
  cls,
  name,
  args,
  kwargs 
)
private

Definition at line 123 of file body.py.

◆ _filter()

def robot.model.body.BaseBody._filter (   self,
  types,
  predicate 
)
private

Definition at line 182 of file body.py.

◆ create()

def robot.model.body.BaseBody.create (   self)
private

Definition at line 114 of file body.py.

◆ create_break()

def robot.model.body.BaseBody.create_break (   self,
args,
**  kwargs 
)

Definition at line 146 of file body.py.

◆ create_continue()

def robot.model.body.BaseBody.create_continue (   self,
args,
**  kwargs 
)

Definition at line 143 of file body.py.

◆ create_for()

def robot.model.body.BaseBody.create_for (   self,
args,
**  kwargs 
)

Definition at line 128 of file body.py.

◆ create_if()

def robot.model.body.BaseBody.create_if (   self,
args,
**  kwargs 
)

Definition at line 131 of file body.py.

◆ create_keyword()

def robot.model.body.BaseBody.create_keyword (   self,
args,
**  kwargs 
)

Definition at line 120 of file body.py.

◆ create_message()

def robot.model.body.BaseBody.create_message (   self,
args,
**  kwargs 
)

Definition at line 149 of file body.py.

◆ create_return()

def robot.model.body.BaseBody.create_return (   self,
args,
**  kwargs 
)

Definition at line 140 of file body.py.

◆ create_try()

def robot.model.body.BaseBody.create_try (   self,
args,
**  kwargs 
)

Definition at line 134 of file body.py.

◆ create_while()

def robot.model.body.BaseBody.create_while (   self,
args,
**  kwargs 
)

Definition at line 137 of file body.py.

◆ filter()

def robot.model.body.BaseBody.filter (   self,
  keywords = None,
  messages = None,
  predicate = None 
)

Filter body items based on type and/or custom predicate.

    To include or exclude items based on types, give matching arguments
    ``True`` or ``False`` values. For example, to include only keywords,
    use ``body.filter(keywords=True)`` and to exclude messages use
    ``body.filter(messages=False)``. Including and excluding by types
    at the same time is not supported and filtering my ``messages``
    is supported only if the ``Body`` object actually supports messages.

    Custom ``predicate`` is a callable getting each body item as an argument
    that must return ``True/False`` depending on should the item be included
    or not.

    Selected items are returned as a list and the original body is not modified.

    It was earlier possible to filter also based on FOR and IF types.
    That support was removed in RF 5.0 because it was not considered useful
    in general and because adding support for all new control structures
    would have required extra work. To exclude all control structures, use
    ``body.filter(keywords=True, messages=True)`` and to only include them
    use ``body.filter(keywords=False``, messages=False)``. For more detailed
    filtering it is possible to use ``predicate``.

Definition at line 175 of file body.py.

◆ flatten()

def robot.model.body.BaseBody.flatten (   self)

Return steps so that IF and TRY structures are flattened.

    Basically the IF/ELSE and TRY/EXCEPT root elements are replaced
    with their branches. This is how they are shown in log files.

Definition at line 201 of file body.py.

◆ register()

def robot.model.body.BaseBody.register (   cls,
  item_class 
)

Definition at line 103 of file body.py.

Member Data Documentation

◆ __slots__

list robot.model.body.BaseBody.__slots__ = []
staticprivate

Definition at line 87 of file body.py.

◆ break_class

robot.model.body.BaseBody.break_class = None
static

Definition at line 96 of file body.py.

◆ continue_class

robot.model.body.BaseBody.continue_class = None
static

Definition at line 95 of file body.py.

◆ for_class

robot.model.body.BaseBody.for_class = None
static

Definition at line 90 of file body.py.

◆ if_class

robot.model.body.BaseBody.if_class = None
static

Definition at line 91 of file body.py.

◆ keyword_class

robot.model.body.BaseBody.keyword_class = None
static

Definition at line 89 of file body.py.

◆ message_class

robot.model.body.BaseBody.message_class = None
static

Definition at line 97 of file body.py.

◆ return_class

robot.model.body.BaseBody.return_class = None
static

Definition at line 94 of file body.py.

◆ try_class

robot.model.body.BaseBody.try_class = None
static

Definition at line 92 of file body.py.

◆ while_class

robot.model.body.BaseBody.while_class = None
static

Definition at line 93 of file body.py.

Property Documentation

◆ create

robot.model.body.BaseBody.create = property
static

Definition at line 112 of file body.py.


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