# 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.
from functools import total_ordering
from robot.utils import py2to3, unicode
# TODO: When Python 2 support is dropped, we could extend MutableSequence.
# In Python 2 it doesn't have slots: https://bugs.python.org/issue11333
[docs]@total_ordering
@py2to3
class ItemList(object):
__slots__ = ['_item_class', '_common_attrs', '_items']
def __init__(self, item_class, common_attrs=None, items=None):
self._item_class = item_class
self._common_attrs = common_attrs
self._items = []
if items:
self.extend(items)
[docs] def create(self, *args, **kwargs):
return self.append(self._item_class(*args, **kwargs))
[docs] def append(self, item):
self._check_type_and_set_attrs(item)
self._items.append(item)
return item
def _check_type_and_set_attrs(self, *items):
common_attrs = self._common_attrs or {}
for item in items:
if not isinstance(item, self._item_class):
raise TypeError("Only %s objects accepted, got %s."
% (self._item_class.__name__,
item.__class__.__name__))
for attr in common_attrs:
setattr(item, attr, common_attrs[attr])
return items
[docs] def extend(self, items):
self._items.extend(self._check_type_and_set_attrs(*items))
[docs] def insert(self, index, item):
self._check_type_and_set_attrs(item)
self._items.insert(index, item)
[docs] def pop(self, *index):
return self._items.pop(*index)
[docs] def remove(self, item):
self._items.remove(item)
[docs] def index(self, item, *start_and_end):
return self._items.index(item, *start_and_end)
[docs] def clear(self):
self._items = []
[docs] def visit(self, visitor):
for item in self:
item.visit(visitor)
def __iter__(self):
index = 0
while index < len(self._items):
yield self._items[index]
index += 1
def __getitem__(self, index):
if not isinstance(index, slice):
return self._items[index]
return self._create_new_from(self._items[index])
def _create_new_from(self, items):
# Cannot pass common_attrs directly to new object because all
# subclasses don't have compatible __init__.
new = type(self)(self._item_class)
new._common_attrs = self._common_attrs
new.extend(items)
return new
def __setitem__(self, index, item):
if isinstance(index, slice):
self._check_type_and_set_attrs(*item)
else:
self._check_type_and_set_attrs(item)
self._items[index] = item
def __delitem__(self, index):
del self._items[index]
def __contains__(self, item):
return item in self._items
def __len__(self):
return len(self._items)
def __unicode__(self):
return u'[%s]' % ', '.join(unicode(item) for item in self)
[docs] def count(self, item):
return self._items.count(item)
[docs] def sort(self):
self._items.sort()
[docs] def reverse(self):
self._items.reverse()
def __reversed__(self):
index = 0
while index < len(self._items):
yield self._items[len(self._items) - index - 1]
index += 1
def __eq__(self, other):
return (isinstance(other, ItemList)
and self._is_compatible(other)
and self._items == other._items)
def _is_compatible(self, other):
return (self._item_class is other._item_class
and self._common_attrs == other._common_attrs)
def __ne__(self, other):
# @total_ordering doesn't add __ne__ in Python < 2.7.15
return not self == other
def __lt__(self, other):
if not isinstance(other, ItemList):
raise TypeError('Cannot order ItemList and %s' % type(other).__name__)
if not self._is_compatible(other):
raise TypeError('Cannot order incompatible ItemLists')
return self._items < other._items
def __add__(self, other):
if not isinstance(other, ItemList):
raise TypeError('Cannot add ItemList and %s' % type(other).__name__)
if not self._is_compatible(other):
raise TypeError('Cannot add incompatible ItemLists')
return self._create_new_from(self._items + other._items)
def __iadd__(self, other):
if isinstance(other, ItemList) and not self._is_compatible(other):
raise TypeError('Cannot add incompatible ItemLists')
self.extend(other)
return self
def __mul__(self, other):
return self._create_new_from(self._items * other)
def __imul__(self, other):
self._items *= other
return self
def __rmul__(self, other):
return self * other