moment/harmonyqml/backend/model/list_model.py

import logging
from typing import (
    Any, Callable, Dict, Iterable, List, Mapping, MutableSequence, Optional,
    Sequence, Tuple, Union
)

from namedlist import namedlist
from PyQt5.QtCore import (
    QAbstractListModel, QModelIndex, QObject, Qt, pyqtProperty, pyqtSignal,
    pyqtSlot
)

NewValue = Union[Mapping[str, Any], Sequence]
ReturnItem = Dict[str, Any]


class ListModel(QAbstractListModel):
    changed = pyqtSignal()

    def __init__(self,
                 initial_data: Optional[List[NewValue]]        = None,
                 container:    Callable[..., MutableSequence]  = list,
                 parent:       Optional[QObject]               = None) -> None:
        super().__init__(parent)
        self._ref_namedlist             = None
        self._roles: Tuple[str, ...]    = ()
        self._data:  MutableSequence    = container()

        if initial_data:
            self.extend(initial_data)


    def __repr__(self) -> str:
        return "%s(%r)" % (type(self).__name__, self._data)


    def __getitem__(self, index):
        return self._data[index]


    def __setitem__(self, index, value) -> None:
        self.set(index, value)


    def __delitem__(self, index) -> None:
        self.remove(index)


    def __len__(self) -> int:
        return self.rowCount()


    def roleNames(self) -> Dict[int, bytes]:
        return {Qt.UserRole + i: bytes(f, "utf-8")
                for i, f in enumerate(self._roles, 1)}


    def data(self, index: QModelIndex, role: int = Qt.DisplayRole) -> Any:
        if role <= Qt.UserRole:
            return None

        return self._data[index.row()][role - Qt.UserRole - 1]


    def rowCount(self, _: QModelIndex = QModelIndex()) -> int:
        return len(self._data)


    def _convert_new_value(self, value: NewValue) -> Any:
        if isinstance(value, Mapping):
            if not self._ref_namedlist:
                self._ref_namedlist = namedlist("ListItem", value.keys())
                self._roles         = tuple(value.keys())

            return self._ref_namedlist(**value)  # type: ignore

        if isinstance(value, Sequence):
            if not self._ref_namedlist:
                try:
                    self._ref_namedlist = namedlist(
                        value.__class__.__name__, value._fields  # type: ignore
                    )
                    self._roles = tuple(value._fields)  # type: ignore
                except AttributeError:
                    raise TypeError(
                        "Need a mapping/dict, namedtuple or namedlist as "
                        "first value to set allowed keys/fields."
                    )

            return self._ref_namedlist(*value)  # type: ignore


        raise TypeError("Value must be a mapping or sequence.")


    @pyqtProperty(int, constant=True)
    def count(self) -> int:  # pylint: disable=arguments-differ
        return self.rowCount()


    @pyqtSlot(int, result="QVariantMap")
    def get(self, index: int) -> ReturnItem:
        return self._data[index]._asdict()


    @pyqtSlot(str, "QVariant", result=int)
    def indexWhere(self, prop: str, is_value: Any) -> int:
        for i, item in enumerate(self._data):
            if getattr(item, prop) == is_value:
                return i

        raise ValueError(f"No {type(self._ref_namedlist)} in list with "
                         f"property {prop!r} set to {is_value!r}.")


    @pyqtSlot(str, "QVariant", result="QVariantMap")
    def getWhere(self, prop: str, is_value: Any) -> ReturnItem:
        return self.get(self.indexWhere(prop, is_value))


    @pyqtSlot(int, list)
    def insert(self, index: int, value: NewValue) -> None:
        value = self._convert_new_value(value)
        self.beginInsertRows(QModelIndex(), index, index)
        self._data.insert(index, value)
        self.endInsertRows()
        self.changed.emit()


    @pyqtSlot(list)
    def append(self, value: NewValue) -> None:
        self.insert(self.rowCount(), value)


    @pyqtSlot(list)
    def extend(self, values: Iterable[NewValue]) -> None:
        for val in values:
            self.append(val)


    @pyqtSlot(int, list)
    def set(self, index: int, value: NewValue) -> None:
        qidx              = QAbstractListModel.index(self, index, 0)
        value             = self._convert_new_value(value)
        self._data[index] = value
        self.dataChanged.emit(qidx, qidx, self.roleNames())
        self.changed.emit()


    @pyqtSlot(int, str, "QVariant")
    def setProperty(self, index: int, prop: str, value: Any) -> None:
        self._data[index][self._roles.index(prop)] = value
        qidx = QAbstractListModel.index(self, index, 0)
        self.dataChanged.emit(qidx, qidx, self.roleNames())
        self.changed.emit()


    # pylint: disable=invalid-name
    @pyqtSlot(int, int)
    @pyqtSlot(int, int, int)
    def move(self, from_: int, to: int, n: int = 1) -> None:
        qlast = from_ + n - 1

        if (n <= 0) or (from_ == to) or (qlast == to) or \
           not (self.rowCount() > qlast >= 0) or \
           not self.rowCount() >= to >= 0:
            logging.warning("No need for move or out of range")
            return

        qidx  = QModelIndex()
        qto   = min(self.rowCount(), to + n if to > from_ else to)
        # print(f"self.beginMoveRows(qidx, {from_}, {qlast}, qidx, {qto})")
        valid = self.beginMoveRows(qidx, from_, qlast, qidx, qto)

        if not valid:
            logging.warning("Invalid move operation")
            return

        last = from_ + n
        cut  = self._data[from_:last]
        del self._data[from_:last]
        self._data[to:to] = cut

        self.endMoveRows()
        self.changed.emit()


    @pyqtSlot(int)
    def remove(self, index: int) -> None:  # pylint: disable=arguments-differ
        self.beginRemoveRows(QModelIndex(), index, index)
        del self._data[index]
        self.endRemoveRows()
        self.changed.emit()


    @pyqtSlot()
    def clear(self) -> None:
        # Reimplemented for performance reasons (begin/endRemoveRows)
        self.beginRemoveRows(QModelIndex(), 0, self.rowCount())
        self._data.clear()
        self.endRemoveRows()
        self.changed.emit()