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

279 lines
9.3 KiB
Python
Raw Normal View History

2023-12-19 12:58:39 +00:00
from __future__ import annotations
2023-02-07 18:26:14 +00:00
2024-05-08 10:09:41 +00:00
import copy
from collections import defaultdict
from dataclasses import dataclass
from typing import (Any, Callable, Dict, Generator, Generic, Iterable,
Iterator, List, Optional, Set, Tuple, TypeVar, Union)
2024-05-08 10:09:41 +00:00
from ..utils import BColors, object_trace, output
from .parents import InnerData, OuterProxy
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
@dataclass
class AppendHookArguments:
"""
This class is used to store the arguments for the append hook.
The best explanation is with an examples:
```
album = Album()
song = Song()
album.song_collection.append(song)
```
In this case, the append hook is triggered with the following arguments:
```
AppendHookArguments(
collection=album.song_collection,
new_object=song,
collection_root_objects=[album]
)
```
"""
collection: Collection
new_object: T
collection_root_objects: Set[InnerData]
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
2024-04-29 16:18:57 +00:00
_indexed_from_id: Dict[int, Dict[str, Any]]
_indexed_values: Dict[str, Dict[Any, T]]
2023-10-24 09:44:00 +00:00
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,
append_callbacks: Set[Callable[[AppendHookArguments], None]] = 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 {}
2024-04-30 06:11:10 +00:00
self.pull_from: List[Collection] = []
self.push_to: List[Collection] = []
self.append_callbacks: Set[Callable[[AppendHookArguments], None]] = append_callbacks or set()
2023-10-24 09:44:00 +00:00
# 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-05-08 10:09:41 +00:00
def __hash__(self) -> int:
return id(self)
@property
def collection_names(self) -> List[str]:
return list(set(self._collection_for.values()))
2024-04-19 15:45:49 +00:00
def __repr__(self) -> str:
2024-05-08 10:09:41 +00:00
return f"Collection({' | '.join(self.collection_names)} {id(self)})"
2024-04-19 15:45:49 +00:00
2024-05-03 12:52:12 +00:00
def _map_element(self, __object: T, no_unmap: bool = False, **kwargs):
if not no_unmap:
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
2024-04-29 16:18:57 +00:00
def _remap(self):
2024-05-03 12:52:12 +00:00
# reinitialize the mapping to clean it without time consuming operations
self._indexed_from_id: Dict[int, Dict[str, Any]] = defaultdict(dict)
self._indexed_values: Dict[str, Dict[Any, T]] = defaultdict(dict)
2024-04-29 16:18:57 +00:00
2024-05-03 12:52:12 +00:00
for e in self._data:
self._map_element(e, no_unmap=True)
2024-04-30 06:11:10 +00:00
2024-05-03 12:55:22 +00:00
2024-05-03 12:52:12 +00:00
def _find_object(self, __object: T, **kwargs) -> Optional[T]:
2024-04-29 20:37:07 +00:00
self._remap()
2024-05-06 15:39:53 +00:00
if __object.id in self._indexed_from_id:
return self._indexed_values["id"][__object.id]
2024-01-15 09:50:24 +00:00
for name, value in __object.indexing_values:
if value in self._indexed_values[name]:
2024-05-03 12:52:12 +00:00
return self._indexed_values[name][value]
2024-01-15 09:50:24 +00:00
2024-05-03 12:52:12 +00:00
return None
def _append_new_object(self, other: T, **kwargs):
"""
This function appends the other object to the current collection.
This only works if not another object, which represents the same real life object exists in the collection.
2024-01-15 09:50:24 +00:00
"""
2024-05-03 12:52:12 +00:00
self._data.append(other)
2024-05-08 10:09:41 +00:00
other._inner._is_in_collection.add(self)
2024-01-15 09:50:24 +00:00
2024-05-03 12:52:12 +00:00
for attribute, a in self.sync_on_append.items():
# syncing two collections by reference
b = other.__getattribute__(attribute)
if a is b:
continue
2024-04-30 15:43:00 +00:00
2024-05-03 12:52:12 +00:00
object_trace(f"Syncing [{a}] = [{b}]")
2024-04-30 10:32:55 +00:00
2024-05-03 12:52:12 +00:00
b_data = b.data.copy()
b_collection_for = b._collection_for.copy()
2024-05-03 12:52:12 +00:00
del b
2024-05-03 12:52:12 +00:00
for synced_with, key in b_collection_for.items():
synced_with.__setattr__(key, a)
a._collection_for[synced_with] = key
2024-04-19 15:45:49 +00:00
2024-05-03 12:52:12 +00:00
a.extend(b_data, **kwargs)
2024-04-29 20:37:07 +00:00
2024-05-16 12:29:50 +00:00
# all of the existing hooks to get the defined datastructures
for collection_attribute, generator in self.extend_object_to_attribute.items():
other.__getattribute__(collection_attribute).extend(generator, **kwargs)
for attribute, new_object in self.append_object_to_attribute.items():
other.__getattribute__(attribute).append(new_object, **kwargs)
append_hook_args = AppendHookArguments(
collection=self,
new_object=other,
collection_root_objects=self._collection_for.keys(),
)
for callback in self.append_callbacks:
callback(append_hook_args)
2024-05-03 12:52:12 +00:00
def append(self, other: Optional[T], **kwargs):
"""
If an object, that represents the same entity exists in a relevant collection,
merge into this object. (and remap)
Else append to this collection.
2024-05-03 12:52:12 +00:00
:param other:
:return:
"""
2024-05-03 12:52:12 +00:00
if other is None:
return
2024-05-08 19:06:40 +00:00
if not other._inner._has_data:
return
2024-05-03 12:52:12 +00:00
if other.id in self._indexed_from_id:
return
2024-04-29 20:37:07 +00:00
2024-05-03 12:52:12 +00:00
object_trace(f"Appending {other.option_string} to {self}")
2024-05-06 15:39:53 +00:00
# switching collection in the case of push to
for c in self.push_to:
r = c._find_object(other)
if r is not None:
2024-05-16 15:14:18 +00:00
# output("found push to", r, other, c, self, color=BColors.RED, sep="\t")
2024-05-06 15:39:53 +00:00
return c.append(other, **kwargs)
2024-05-08 10:09:41 +00:00
for c in self.pull_from:
r = c._find_object(other)
if r is not None:
2024-05-16 15:14:18 +00:00
# output("found pull from", r, other, c, self, color=BColors.RED, sep="\t")
2024-05-08 10:09:41 +00:00
c.remove(r, existing=r, **kwargs)
2024-05-03 12:52:12 +00:00
2024-05-08 10:09:41 +00:00
existing = self._find_object(other)
if existing is None:
2024-05-06 08:31:21 +00:00
self._append_new_object(other, **kwargs)
2024-01-15 09:50:24 +00:00
else:
2024-05-08 10:09:41 +00:00
existing.merge(other, **kwargs)
2024-05-03 12:52:12 +00:00
2024-05-08 10:09:41 +00:00
def remove(self, *other_list: List[T], silent: bool = False, existing: Optional[T] = None, remove_from_other_collection=True, **kwargs):
other: T
2024-05-03 12:52:12 +00:00
for other in other_list:
existing: Optional[T] = existing or self._indexed_values["id"].get(other.id, None)
2024-05-03 12:52:12 +00:00
if existing is None:
if not silent:
raise ValueError(f"Object {other} not found in {self}")
return other
2024-04-17 12:15:56 +00:00
2024-05-08 10:09:41 +00:00
if remove_from_other_collection:
for c in copy.copy(other._inner._is_in_collection):
c.remove(other, silent=True, remove_from_other_collection=False, **kwargs)
other._inner._is_in_collection = set()
else:
self._data.remove(existing)
self._unmap_element(existing)
2024-04-30 00:09:52 +00:00
2024-05-03 12:55:22 +00:00
def contains(self, __object: T) -> bool:
return self._find_object(__object) is not None
2023-03-24 14:58:21 +00:00
2024-05-03 12:52:12 +00:00
def extend(self, other_collections: Optional[Generator[T, None, None]], **kwargs):
if other_collections is None:
2023-10-12 17:24:35 +00:00
return
2023-12-19 12:58:39 +00:00
2024-05-06 15:39:53 +00:00
for other_object in other_collections:
self.append(other_object, **kwargs)
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
2024-05-03 12:52:12 +00:00
def __merge__(self, other: Collection, **kwargs):
object_trace(f"merging {str(self)} | {str(other)}")
2024-05-03 12:52:12 +00:00
self.extend(other, **kwargs)
2024-01-15 09:50:24 +00:00
def __getitem__(self, item: int):
return self._data[item]
2024-04-25 22:23:04 +00:00
def get(self, item: int, default = None):
if item >= len(self._data):
return default
return self._data[item]
def __eq__(self, other: Collection) -> bool:
if self.empty and other.empty:
return True
return self._data == other._data