Skip to content

omnipy.util.setdeque

CLASS DESCRIPTION
SetDeque

SetDeque

Bases: deque, Generic[_ObjT]

METHOD DESCRIPTION
__init__
append
appendleft
clear
count
extend
extendleft
insert
pop
popleft
remove
Source code in src/omnipy/util/setdeque.py
class SetDeque(deque, Generic[_ObjT]):
    def __init__(self, iterable: Iterable = (), maxlen: int | None = None):
        unique_ordered_els = dict.fromkeys(iterable).keys()
        super().__init__(iterable=unique_ordered_els, maxlen=maxlen)
        self._set: set[_ObjT] = set(self.__iter__())

    def _add_element(self, method_name: str, *args: object, el: _ObjT) -> bool:
        if el not in self._set:
            getattr(super(), method_name)(*args, el)
            self._set.add(el)
            return True
        return False

    def _add_elements(self, method_name: str, el_iter: Iterable[_ObjT]) -> None:
        unique_ordered_els = dict.fromkeys(el_iter).keys()
        new_unique_ordered_els = (el for el in unique_ordered_els if el not in self._set)
        getattr(super(), method_name)(new_unique_ordered_els)
        self._set |= unique_ordered_els

    def _remove_returned_element(self, method_name: str) -> _ObjT:
        el = getattr(super(), method_name)()
        self._set.remove(el)
        return el

    def _remove_explicit_element(self,
                                 method_name: str,
                                 *args: object,
                                 el: _ObjT,
                                 add_el_to_args: bool) -> None:
        if add_el_to_args:
            args = args + (el,)
        getattr(super(), method_name)(*args)
        self._set.remove(el)

    def append(self, el: _ObjT) -> None:
        self._add_element('append', el=el)

    def appendleft(self, el: _ObjT) -> None:
        self._add_element('appendleft', el=el)

    def extend(self, el_iter: Iterable[_ObjT]) -> None:
        self._add_elements('extend', el_iter)

    def extendleft(self, el_iter: Iterable[_ObjT]) -> None:
        self._add_elements('extendleft', el_iter)

    def insert(self, __i: int, __x: _ObjT) -> None:
        self._add_element('insert', __i, el=__x)

    def pop(self) -> _ObjT:  # type: ignore[override]
        return self._remove_returned_element('pop')

    def popleft(self) -> _ObjT:
        return self._remove_returned_element('popleft')

    def remove(self, __value) -> None:
        self._remove_explicit_element('remove', el=__value, add_el_to_args=True)

    def clear(self) -> None:
        super().clear()
        self._set.clear()

    def count(self, __x: _ObjT) -> int:
        return 1 if __x in self._set else 0

    def __setitem__(self, __key: SupportsIndex, __value: _ObjT) -> None:  # type: ignore[override]
        old_val = super().__getitem__(__key)
        if __value != old_val:
            added = self._add_element('__setitem__', __key, el=__value)
            if added:
                self._set.remove(old_val)

    def __delitem__(self, __key: SupportsIndex) -> None:  # type: ignore[override]
        self._remove_explicit_element(
            '__delitem__',
            __key,
            el=super().__getitem__(__key),
            add_el_to_args=False,
        )

    def __add__(self, __value: 'SetDeque[_ObjT]') -> 'SetDeque[_ObjT] | NotImplementedType':
        if not isinstance(__value, SetDeque):
            return NotImplemented
        self_copy = copy(self)
        self_copy.extend(__value)
        return self_copy

    def __iadd__(self, __value: Iterable[_ObjT]):  # type: ignore[misc]
        self.extend(__value)
        return self

    def __eq__(self, __value: object):
        return super().__eq__(__value) and self._set == cast(SetDeque[_ObjT], __value)._set

    def __reduce__(self):
        ret = super().__reduce__()
        return ret[0], ret[1], None, ret[3]

    def __contains__(self, __key: object) -> bool:
        return self._set.__contains__(__key)

    def _common_mul(self, __value: int):
        if __value > 0:
            return SetDeque[_ObjT](self.__iter__())
        else:
            return SetDeque[_ObjT]()

    def __mul__(self, __value: int):
        return self._common_mul(__value)

    def __rmul__(self, __value: int):
        return self._common_mul(__value)

    def __imul__(self, __value: int):
        if __value <= 0:
            self.clear()
        return self

    def __repr__(self):
        arg_repr = ''
        if hasattr(self, '__orig_class__'):
            args = get_args(self.__orig_class__)  # pyright: ignore [reportAttributeAccessIssue]
            if len(args) == 1:
                arg = args[0]
                arg_repr = f"[{arg.__name__ if hasattr(arg, '__name__') else repr(arg)}]"
        maxlen_repr = f', maxlen={self.maxlen}' if self.maxlen is not None else ''
        return f'{self.__class__.__name__}{arg_repr}({list(self)}{maxlen_repr})'

    def __sizeof__(self):
        return super().__sizeof__() + sys.getsizeof(self._set)

__init__

__init__(iterable: Iterable = (), maxlen: int | None = None)
Source code in src/omnipy/util/setdeque.py
def __init__(self, iterable: Iterable = (), maxlen: int | None = None):
    unique_ordered_els = dict.fromkeys(iterable).keys()
    super().__init__(iterable=unique_ordered_els, maxlen=maxlen)
    self._set: set[_ObjT] = set(self.__iter__())

append

append(el: _ObjT) -> None
Source code in src/omnipy/util/setdeque.py
def append(self, el: _ObjT) -> None:
    self._add_element('append', el=el)

appendleft

appendleft(el: _ObjT) -> None
Source code in src/omnipy/util/setdeque.py
def appendleft(self, el: _ObjT) -> None:
    self._add_element('appendleft', el=el)

clear

clear() -> None
Source code in src/omnipy/util/setdeque.py
def clear(self) -> None:
    super().clear()
    self._set.clear()

count

count(__x: _ObjT) -> int
Source code in src/omnipy/util/setdeque.py
def count(self, __x: _ObjT) -> int:
    return 1 if __x in self._set else 0

extend

extend(el_iter: Iterable[_ObjT]) -> None
Source code in src/omnipy/util/setdeque.py
def extend(self, el_iter: Iterable[_ObjT]) -> None:
    self._add_elements('extend', el_iter)

extendleft

extendleft(el_iter: Iterable[_ObjT]) -> None
Source code in src/omnipy/util/setdeque.py
def extendleft(self, el_iter: Iterable[_ObjT]) -> None:
    self._add_elements('extendleft', el_iter)

insert

insert(__i: int, __x: _ObjT) -> None
Source code in src/omnipy/util/setdeque.py
def insert(self, __i: int, __x: _ObjT) -> None:
    self._add_element('insert', __i, el=__x)

pop

pop() -> _ObjT
Source code in src/omnipy/util/setdeque.py
def pop(self) -> _ObjT:  # type: ignore[override]
    return self._remove_returned_element('pop')

popleft

popleft() -> _ObjT
Source code in src/omnipy/util/setdeque.py
def popleft(self) -> _ObjT:
    return self._remove_returned_element('popleft')

remove

remove(__value) -> None
Source code in src/omnipy/util/setdeque.py
def remove(self, __value) -> None:
    self._remove_explicit_element('remove', el=__value, add_el_to_args=True)