Source code for robot.model.body

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  See the License for the specific language governing permissions and
#  limitations under the License.

import re

from .itemlist import ItemList
from .modelobject import ModelObject

[docs]class BodyItem(ModelObject): KEYWORD = 'KEYWORD' SETUP = 'SETUP' TEARDOWN = 'TEARDOWN' FOR = 'FOR' FOR_ITERATION = 'FOR ITERATION' IF_ELSE_ROOT = 'IF/ELSE ROOT' IF = 'IF' ELSE_IF = 'ELSE IF' ELSE = 'ELSE' MESSAGE = 'MESSAGE' type = None __slots__ = ['parent'] @property def id(self): """Item id in format like ``s1-t3-k1``. See :attr:` <>` for more information. """ # This algorithm must match the id creation algorithm in the JavaScript side # or linking to warnings and errors won't work. if not self: return None if not self.parent: return 'k1' setup = getattr(self.parent, 'setup', None) body = getattr(self.parent, 'body', ()) teardown = getattr(self.parent, 'teardown', None) steps = [step for step in [setup] + list(body) + [teardown] if step and step.type != step.MESSAGE] return '%s-k%d' % (, steps.index(self) + 1)
[docs]class Body(ItemList): """A list-like object representing body of a suite, a test or a keyword. Body contains the keywords and other structures such as for loops. """ __slots__ = [] # Set using 'Body.register' when these classes are created. keyword_class = None for_class = None if_class = None def __init__(self, parent=None, items=None): ItemList.__init__(self, BodyItem, {'parent': parent}, items)
[docs] @classmethod def register(cls, item_class): name_parts = re.findall('([A-Z][a-z]+)', item_class.__name__) + ['class'] name = '_'.join(name_parts).lower() if not hasattr(cls, name): raise TypeError("Cannot register '%s'." % name) setattr(cls, name, item_class) return item_class
@property def create(self): raise AttributeError( "'%s' object has no attribute 'create'. " "Use item specific methods like 'create_keyword' instead." % type(self).__name__ )
[docs] def create_keyword(self, *args, **kwargs): return self._create(self.keyword_class, 'create_keyword', args, kwargs)
def _create(self, cls, name, args, kwargs): if cls is None: raise TypeError("'%s' object does not support '%s'." % (type(self).__name__, name)) return self.append(cls(*args, **kwargs))
[docs] def create_for(self, *args, **kwargs): return self._create(self.for_class, 'create_for', args, kwargs)
[docs] def create_if(self, *args, **kwargs): return self._create(self.if_class, 'create_if', args, kwargs)
[docs] def filter(self, keywords=None, fors=None, ifs=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 FOR and IF constructs use ``body.filter(fors=False, ifs=False)``. Including and excluding by types at the same time is not supported. Custom ``predicate`` is a calleble 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. """ return self._filter([(self.keyword_class, keywords), (self.for_class, fors), (self.if_class, ifs)], predicate)
def _filter(self, types, predicate): include = tuple(cls for cls, activated in types if activated is True) exclude = tuple(cls for cls, activated in types if activated is False) if include and exclude: raise ValueError('Items cannot be both included and excluded by type.') items = list(self) if include: items = [item for item in items if isinstance(item, include)] if exclude: items = [item for item in items if not isinstance(item, exclude)] if predicate: items = [item for item in items if predicate(item)] return items
[docs]class IfBranches(Body): if_branch_class = None keyword_class = None for_class = None if_class = None __slots__ = []
[docs] def create_branch(self, *args, **kwargs): return self.append(self.if_branch_class(*args, **kwargs))