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

267 lines
8.3 KiB
Python
Raw Normal View History

from __future__ import annotations
2023-12-19 21:11:46 +00:00
import random
2024-01-15 11:48:36 +00:00
from collections import defaultdict
from functools import lru_cache
2024-01-15 09:50:24 +00:00
from typing import Optional, Dict, Tuple, List, Type, Generic, Any, TypeVar, Set
2022-12-01 12:15:30 +00:00
2023-03-10 08:09:35 +00:00
from .metadata import Metadata
from ..utils import get_unix_time, object_trace
from ..utils.config import logging_settings, main_settings
2023-09-11 19:34:45 +00:00
from ..utils.shared import HIGHEST_ID
2024-04-09 12:18:34 +00:00
from ..utils.hacking import MetaClass
2023-09-10 14:27:09 +00:00
LOGGER = logging_settings["object_logger"]
2022-12-01 12:15:30 +00:00
2023-12-19 21:11:46 +00:00
P = TypeVar("P", bound="OuterProxy")
2023-09-14 21:35:37 +00:00
2023-12-19 12:58:39 +00:00
class InnerData:
"""
This is the core class, which is used for every Data class.
The attributes are set, and can be merged.
The concept is, that the outer class proxies this class.
If the data in the wrapper class has to be merged, then this class is just replaced and garbage collected.
"""
_refers_to_instances: set = None
def __init__(self, object_type, **kwargs):
2024-04-15 12:12:26 +00:00
self._refers_to_instances =set()
# initialize the default values
self.__default_values = {}
for name, factory in object_type._default_factories.items():
self.__default_values[name] = factory()
2023-12-19 12:58:39 +00:00
for key, value in kwargs.items():
self.__setattr__(key, value)
def __merge__(self, __other: InnerData, override: bool = False):
"""
:param __other:
:param override:
:return:
"""
2023-12-29 20:50:40 +00:00
for key, value in __other.__dict__.copy().items():
2023-12-19 12:58:39 +00:00
# just set the other value if self doesn't already have it
if key not in self.__dict__ or (key in self.__dict__ and self.__dict__[key] == self.__default_values.get(key)):
2023-12-19 12:58:39 +00:00
self.__setattr__(key, value)
continue
# if the object of value implemented __merge__, it merges
existing = self.__getattribute__(key)
if hasattr(type(existing), "__merge__"):
2023-12-29 15:15:54 +00:00
existing.__merge__(value, override)
2023-12-19 12:58:39 +00:00
continue
# override the existing value if requested
if override:
self.__setattr__(key, value)
2023-12-20 08:55:09 +00:00
class OuterProxy:
2023-12-19 12:58:39 +00:00
"""
Wraps the inner data, and provides apis, to naturally access those values.
"""
2023-12-19 21:11:46 +00:00
_default_factories: dict = {}
2024-01-15 10:52:31 +00:00
_outer_attribute: Set[str] = {"options", "metadata", "indexing_values", "option_string"}
2023-12-19 21:11:46 +00:00
2024-01-15 09:56:59 +00:00
DOWNWARDS_COLLECTION_STRING_ATTRIBUTES = tuple()
UPWARDS_COLLECTION_STRING_ATTRIBUTES = tuple()
2024-04-10 08:25:05 +00:00
TITEL = "id"
2023-12-19 12:58:39 +00:00
def __init__(self, _id: int = None, dynamic: bool = False, **kwargs):
_automatic_id: bool = False
if _id is None and not dynamic:
"""
generates a random integer id
the range is defined in the config
"""
_id = random.randint(0, HIGHEST_ID)
_automatic_id = True
kwargs["automatic_id"] = _automatic_id
kwargs["id"] = _id
kwargs["dynamic"] = dynamic
for name, factory in type(self)._default_factories.items():
2023-12-29 20:50:40 +00:00
if kwargs.get(name, None) is None:
2023-12-19 12:58:39 +00:00
kwargs[name] = factory()
2023-12-29 20:50:40 +00:00
collection_data: Dict[str, list] = {}
for name, value in kwargs.copy().items():
if isinstance(value, list) and name.endswith("_list"):
collection_name = name.replace("_list", "_collection")
collection_data[collection_name] = value
del kwargs[name]
self._fetched_from: dict = {}
self._inner: InnerData = InnerData(type(self), **kwargs)
2024-04-15 12:12:26 +00:00
self._inner._refers_to_instances.add(self)
object_trace(f"creating {type(self).__name__} [{self.title_string}]")
2023-12-19 12:58:39 +00:00
self.__init_collections__()
2023-12-29 20:50:40 +00:00
for name, data_list in collection_data.items():
collection = self._inner.__getattribute__(name)
collection.extend(data_list)
2023-12-19 12:58:39 +00:00
2023-12-29 20:50:40 +00:00
self._inner.__setattr__(name, collection)
2023-12-19 12:58:39 +00:00
def __init_collections__(self):
pass
def __getattribute__(self, __name: str) -> Any:
"""
Returns the attribute of _inner if the attribute exists,
else it returns the attribute of self.
That the _inner gets checked first is essential for the type hints.
:param __name:
:return:
"""
2024-01-15 09:56:59 +00:00
if __name.startswith("_") or __name in self._outer_attribute or __name.isupper():
2024-01-15 09:50:24 +00:00
return object.__getattribute__(self, __name)
2023-12-19 12:58:39 +00:00
_inner: InnerData = super().__getattribute__("_inner")
try:
return _inner.__getattribute__(__name)
except AttributeError:
return super().__getattribute__(__name)
def __setattr__(self, __name, __value):
if not __name.startswith("_") and hasattr(self, "_inner"):
_inner: InnerData = super().__getattribute__("_inner")
return _inner.__setattr__(__name, __value)
return super().__setattr__(__name, __value)
2024-01-15 11:48:36 +00:00
def _add_other_db_objects(self, object_type: Type[OuterProxy], object_list: List[OuterProxy]):
pass
def add_list_of_other_objects(self, object_list: List[OuterProxy]):
d: Dict[Type[OuterProxy], List[OuterProxy]] = defaultdict(list)
for db_object in object_list:
d[type(db_object)].append(db_object)
for key, value in d.items():
self._add_other_db_objects(key, value)
2023-12-19 12:58:39 +00:00
def __hash__(self):
"""
:raise: IsDynamicException
:return:
"""
if self.dynamic:
return id(self._inner)
return self.id
def __eq__(self, other: Any):
return self.__hash__() == other.__hash__()
2023-12-29 14:43:33 +00:00
def merge(self, __other: Optional[OuterProxy], override: bool = False):
2023-12-19 12:58:39 +00:00
"""
1. merges the data of __other in self
2. replaces the data of __other with the data of self
:param __other:
:param override:
:return:
"""
2023-12-29 14:43:33 +00:00
if __other is None:
return
object_trace(f"merging {type(self).__name__} [{self.title_string}] with {type(__other).__name__} [{__other.title_string}]")
a = self
b = __other
if a._inner is b._inner:
return
# switch instances if more efficient
if len(b._inner._refers_to_instances) > len(a._inner._refers_to_instances):
a, b = b, a
a._inner.__merge__(b._inner, override=override)
2024-04-15 12:12:26 +00:00
a._inner._refers_to_instances.update(b._inner._refers_to_instances)
2024-04-15 12:12:26 +00:00
for instance in b._inner._refers_to_instances:
instance._inner = a._inner
2023-12-19 12:58:39 +00:00
def mark_as_fetched(self, *url_hash_list: List[str]):
for url_hash in url_hash_list:
self._fetched_from[url_hash] = {
"time": get_unix_time(),
"url": url_hash,
}
def already_fetched_from(self, url_hash: str) -> bool:
res = self._fetched_from.get(url_hash, None)
if res is None:
return False
return get_unix_time() - res["time"] < main_settings["refresh_after"]
2023-03-09 17:19:49 +00:00
@property
2023-12-19 21:11:46 +00:00
def metadata(self) -> Metadata:
2023-03-09 17:19:49 +00:00
"""
2023-12-19 21:11:46 +00:00
This is an interface.
:return:
2023-03-09 17:19:49 +00:00
"""
2023-03-10 08:09:35 +00:00
return Metadata()
2023-03-10 09:54:15 +00:00
@property
2023-12-19 21:11:46 +00:00
def options(self) -> List[P]:
2023-06-12 12:56:14 +00:00
return [self]
2023-03-10 09:54:15 +00:00
@property
2023-12-19 21:11:46 +00:00
def indexing_values(self) -> List[Tuple[str, object]]:
2023-03-14 10:03:54 +00:00
"""
2023-12-19 21:11:46 +00:00
This is an interface.
It is supposed to return a map of the name and values for all important attributes.
This helps in comparing classes for equal data (e.g. being the same song but different attributes)
2023-12-19 12:58:39 +00:00
2023-12-19 21:11:46 +00:00
TODO
Rewrite this approach into a approach, that is centered around statistics, and not binaries.
Instead of: one of this matches, it is the same
This: If enough attributes are similar enough, they are the same
2023-12-19 21:11:46 +00:00
Returns:
List[Tuple[str, object]]: the first element in the tuple is the name of the attribute, the second the value.
"""
2022-12-01 12:15:30 +00:00
2023-12-19 21:11:46 +00:00
return []
@property
@lru_cache()
def all_collections(self):
r = []
for key in self._default_factories:
val = self._inner.__getattribute__(key)
if hasattr(val, "__is_collection__"):
r.append(val)
return r
def __repr__(self):
return f"{type(self).__name__}({', '.join(key + ': ' + str(val) for key, val in self.indexing_values)})"
2024-04-10 08:25:05 +00:00
@property
def title_string(self) -> str:
return str(self.__getattribute__(self.TITEL))