music-kraken-core/music_kraken/objects/collection.py

164 lines
5.4 KiB
Python
Raw Permalink Normal View History

2023-12-19 12:58:39 +00:00
from __future__ import annotations
2023-02-07 18:26:14 +00:00
2023-12-19 12:58:39 +00:00
from collections import defaultdict
from typing import TypeVar, Generic, Dict, Optional, Iterable, List, Iterator, Tuple, Generator, Union, Any
2023-12-19 12:58:39 +00:00
from .parents import OuterProxy
2024-04-19 15:45:49 +00:00
from ..utils import object_trace
2023-02-23 22:52:41 +00:00
2023-12-19 12:58:39 +00:00
T = TypeVar('T', bound=OuterProxy)
2023-08-28 18:59:19 +00:00
2023-12-19 12:58:39 +00:00
class Collection(Generic[T]):
__is_collection__ = True
2023-08-28 18:59:19 +00:00
_data: List[T]
2023-02-23 22:52:41 +00:00
2023-10-24 09:44:00 +00:00
_indexed_values: Dict[str, set]
_indexed_to_objects: Dict[any, list]
shallow_list = property(fget=lambda self: self.data)
def __init__(
2023-12-19 12:58:39 +00:00
self,
data: Optional[Iterable[T]] = None,
sync_on_append: Dict[str, Collection] = None,
append_object_to_attribute: Dict[str, T] = None,
extend_object_to_attribute: Dict[str, Collection] = None,
2023-10-24 09:44:00 +00:00
) -> None:
2024-04-19 15:45:49 +00:00
self._collection_for: dict = dict()
2023-10-24 15:41:42 +00:00
self._contains_ids = set()
2023-10-24 09:44:00 +00:00
self._data = []
2023-12-19 12:58:39 +00:00
2023-10-24 09:44:00 +00:00
# List of collection attributes that should be modified on append
# Key: collection attribute (str) of appended element
# Value: main collection to sync to
2023-12-19 12:58:39 +00:00
self.append_object_to_attribute: Dict[str, T] = append_object_to_attribute or {}
self.extend_object_to_attribute: Dict[str, Collection[T]] = extend_object_to_attribute or {}
self.sync_on_append: Dict[str, Collection] = sync_on_append or {}
2023-10-24 09:44:00 +00:00
2024-04-17 15:52:59 +00:00
self._id_to_index_values: Dict[int, set] = defaultdict(set)
# This is to cleanly unmap previously mapped items by their id
self._indexed_from_id: Dict[int, Dict[str, Any]] = defaultdict(dict)
# this is to keep track and look up the actual objects
self._indexed_values: Dict[str, Dict[Any, T]] = defaultdict(dict)
2023-12-19 12:58:39 +00:00
2023-10-24 09:44:00 +00:00
self.extend(data)
2023-02-07 18:26:14 +00:00
2024-04-19 15:45:49 +00:00
def __repr__(self) -> str:
return f"Collection({id(self)})"
2023-10-24 15:41:42 +00:00
def _map_element(self, __object: T, from_map: bool = False):
self._unmap_element(__object.id)
self._indexed_from_id[__object.id]["id"] = __object.id
self._indexed_values["id"][__object.id] = __object
2023-10-24 15:41:42 +00:00
for name, value in __object.indexing_values:
if value is None or value == __object._inner._default_values.get(name):
2023-03-10 17:38:32 +00:00
continue
self._indexed_values[name][value] = __object
self._indexed_from_id[__object.id][name] = value
2023-03-24 14:58:21 +00:00
2024-04-18 12:37:20 +00:00
def _unmap_element(self, __object: Union[T, int]):
obj_id = __object.id if isinstance(__object, OuterProxy) else __object
if obj_id not in self._indexed_from_id:
return
2023-03-24 14:58:21 +00:00
for name, value in self._indexed_from_id[obj_id].items():
if value in self._indexed_values[name]:
del self._indexed_values[name][value]
2023-03-09 21:14:39 +00:00
del self._indexed_from_id[obj_id]
2023-12-20 11:31:53 +00:00
def _find_object(self, __object: T) -> Optional[T]:
2024-01-15 09:50:24 +00:00
for name, value in __object.indexing_values:
if value in self._indexed_values[name]:
return self._indexed_values[name][value]
2024-01-15 09:50:24 +00:00
2023-10-24 15:41:42 +00:00
def append(self, __object: Optional[T], already_is_parent: bool = False, from_map: bool = False):
2024-01-15 09:50:24 +00:00
"""
If an object, that represents the same entity exists in a relevant collection,
merge into this object. (and remap)
Else append to this collection.
:param __object:
:param already_is_parent:
:param from_map:
:return:
"""
if __object is None:
2023-10-24 15:41:42 +00:00
return
2023-12-19 12:58:39 +00:00
existing_object = self._find_object(__object)
2024-01-15 09:50:24 +00:00
if existing_object is None:
# append
self._data.append(__object)
self._map_element(__object)
for collection_attribute, child_collection in self.extend_object_to_attribute.items():
__object.__getattribute__(collection_attribute).extend(child_collection)
for attribute, new_object in self.append_object_to_attribute.items():
__object.__getattribute__(attribute).append(new_object)
2024-04-19 15:45:49 +00:00
# only modify collections if the object actually has been appended
for attribute, a in self.sync_on_append.items():
b = __object.__getattribute__(attribute)
object_trace(f"Syncing [{a}{id(a)}] = [{b}{id(b)}]")
data_to_extend = b.data
a._collection_for.update(b._collection_for)
for synced_with, key in b._collection_for.items():
synced_with.__setattr__(key, a)
a.extend(data_to_extend)
2024-01-15 09:50:24 +00:00
else:
2024-04-17 12:15:56 +00:00
# merge only if the two objects are not the same
if existing_object.id == __object.id:
return
2024-04-18 12:37:20 +00:00
old_id = existing_object.id
2024-04-17 15:52:59 +00:00
2024-01-15 09:50:24 +00:00
existing_object.merge(__object)
2024-04-18 12:37:20 +00:00
if existing_object.id != old_id:
self._unmap_element(old_id)
2024-04-18 12:37:20 +00:00
self._map_element(existing_object)
2023-03-24 14:58:21 +00:00
2024-04-17 12:15:56 +00:00
def extend(self, __iterable: Optional[Generator[T, None, None]]):
2023-10-24 09:44:00 +00:00
if __iterable is None:
2023-10-12 17:24:35 +00:00
return
2023-12-19 12:58:39 +00:00
2023-10-24 09:44:00 +00:00
for __object in __iterable:
2024-04-17 12:15:56 +00:00
self.append(__object)
2023-10-12 17:24:35 +00:00
2023-10-24 09:44:00 +00:00
@property
def data(self) -> List[T]:
return list(self.__iter__())
2023-12-19 12:58:39 +00:00
2023-10-24 09:44:00 +00:00
def __len__(self) -> int:
return len(self._data)
2023-03-03 11:32:08 +00:00
2023-12-19 21:11:46 +00:00
@property
def empty(self) -> bool:
2024-02-28 13:27:35 +00:00
return self.__len__() <= 0
2023-12-19 21:11:46 +00:00
def __iter__(self) -> Iterator[T]:
yield from self._data
2024-01-15 09:50:24 +00:00
2023-12-29 15:15:54 +00:00
def __merge__(self, __other: Collection, override: bool = False):
2024-04-17 16:13:03 +00:00
self.extend(__other)
2024-01-15 09:50:24 +00:00
def __getitem__(self, item: int):
return self._data[item]