keyword.py

Go to the documentation of this file.

#  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
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
import warnings
 
from robot.utils import setter
 
from .body import Body, BodyItem
from .fixture import create_fixture
from .itemlist import ItemList
from .tags import Tags
 
 
@Body.register
 
class Keyword(BodyItem):
    repr_args = ('name', 'args', 'assign')
    __slots__ = ['_name', 'doc', 'args', 'assign', 'timeout', 'type', '_teardown']
 
    def __init__(self, name='', doc='', args=(), assign=(), tags=(),
                 timeout=None, type=BodyItem.KEYWORD, parent=None):
        self._name_name = name
        self.docdoc = doc
        self.argsargs = args
        self.assignassign = assign
        self.tagstagstags = tags
        self.timeouttimeout = timeout
        self.typetypetype = type
        self._teardown_teardown = None
        self.parentparent = parent
 
    @property
    name = property
    
    def name(self):
        return self._name_name
 
    @name.setter
    
    def name(self, name):
        self._name_name = name
 
    @property    # Cannot use @setter because it would create teardowns recursively.
    
    teardown = property
    
    def teardown(self):
        if self._teardown_teardown is None and self:
            self._teardown_teardown = create_fixture(None, self, self.TEARDOWNTEARDOWN)
        return self._teardown_teardown
 
    @teardown.setter
    
    def teardown(self, teardown):
        self._teardown_teardown = create_fixture(teardown, self, self.TEARDOWNTEARDOWN)
 
    @property
    
    has_teardown = property
    
    def has_teardown(self):
        return bool(self._teardown_teardown)
 
    @setter
    
    def tags(self, tags):
        return Tags(tags)
 
    
    def visit(self, visitor):
        if self:
            visitor.visit_keyword(self)
 
    def __bool__(self):
        return self.namenamenamename is not None
 
    def __str__(self):
        parts = list(self.assignassign) + [self.namenamenamename] + list(self.argsargs)
        return '    '.join(str(p) for p in parts)
 
 
 
class Keywords(ItemList):
    __slots__ = []
    deprecation_message = (
        "'keywords' attribute is read-only and deprecated since Robot Framework 4.0. "
        "Use 'body', 'setup' or 'teardown' instead."
    )
 
    def __init__(self, parent=None, keywords=None):
        warnings.warn(self.deprecation_messagedeprecation_message, UserWarning)
        ItemList.__init__(self, object, {'parent': parent})
        if keywords:
            ItemList.extend(self, keywords)
 
    @property
    setup = property
    
    def setup(self):
        return self[0] if (self and self[0].type == 'SETUP') else None
 
    @setup.setter
    
    def setup(self, kw):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def create_setup(self, *args, **kwargs):
        self.raise_deprecation_errorraise_deprecation_error()
 
    @property
    teardown = property
    
    def teardown(self):
        return self[-1] if (self and self[-1].type == 'TEARDOWN') else None
 
    @teardown.setter
    
    def teardown(self, kw):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def create_teardown(self, *args, **kwargs):
        self.raise_deprecation_errorraise_deprecation_error()
 
    @property
    
    all = property
    
    def all(self):
        return self
 
    @property
    
    normal = property
    
    def normal(self):
        return [kw for kw in self if kw.type not in ('SETUP', 'TEARDOWN')]
 
    def __setitem__(self, index, item):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def create(self, *args, **kwargs):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def append(self, item):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def extend(self, items):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def insert(self, index, item):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def pop(self, *index):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def remove(self, item):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def clear(self):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def __delitem__(self, index):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def sort(self):
        self.raise_deprecation_errorraise_deprecation_error()
 
    def reverse(self):
        self.raise_deprecation_errorraise_deprecation_error()
 
    @classmethod
    def raise_deprecation_error(cls):
        raise AttributeError(cls.deprecation_messagedeprecation_message)