draft implemented add_data

music_kraken/utils/__init__.py

@@ -1,15 +1,18 @@
-from datetime import datetime
-from pathlib import Path
+import inspect
 import json
 import logging
-import inspect
-from typing import List, Union
+from datetime import datetime
+from functools import lru_cache
+from pathlib import Path
+from typing import Any, List, Union
 
-from .shared import DEBUG, DEBUG_LOGGING, DEBUG_DUMP, DEBUG_TRACE, DEBUG_OBJECT_TRACE, DEBUG_OBJECT_TRACE_CALLSTACK
 from .config import config, read_config, write_config
 from .enums.colors import BColors
-from .path_manager import LOCATIONS
 from .hacking import merge_args
+from .path_manager import LOCATIONS
+from .shared import (DEBUG, DEBUG_DUMP, DEBUG_LOGGING, DEBUG_OBJECT_TRACE,
+                     DEBUG_OBJECT_TRACE_CALLSTACK, DEBUG_TRACE, URL_PATTERN)
+from .string_processing import hash_url, is_url, unify
 
 """
 IO functions
@@ -125,4 +128,34 @@ def get_current_millis() -> int:
 
 
 def get_unix_time() -> int:
-    return int(datetime.now().timestamp())
+    return int(datetime.now().timestamp())
+
+
+@lru_cache
+def custom_hash(value: Any) -> int:
+    if is_url(value):
+        value = hash_url(value)
+    elif isinstance(value, str):
+        try:
+            value = int(value)
+        except ValueError:
+            value = unify(value)
+    
+    return hash(value)
+
+
+def create_dataclass_instance(t, data: dict):
+    """Creates an instance of a dataclass with the given data.
+    It filters out all data key, which has no attribute in the dataclass.
+
+    Args:
+        t (Type): The dataclass type class
+        data (dict): the attribute to pass into the constructor
+    
+    Returns:
+        Tuple[Type, dict]: The created instance and a dict, containing the data, which was not used in the creation
+    """
+    
+    data = {k: v for k, v in data.items() if hasattr(t, k)}
+    removed_data = {k: v for k, v in data.items() if not hasattr(t, k)}
+    return t(**data), removed_data

music_kraken/utils/enums/__init__.py

@@ -1,7 +1,11 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional, TYPE_CHECKING, Type
+from enum import Enum
+from typing import TYPE_CHECKING, Optional, Type
+
+from mutagen.id3 import PictureType
+
 if TYPE_CHECKING:
     from ...pages.abstract import Page
 
@@ -52,3 +56,73 @@ class ALL_SOURCE_TYPES:
     MANUAL = SourceType(name="manual")
     
     PRESET = SourceType(name="preset")
+
+
+class PictureType(Enum):
+    """Enumeration of image types defined by the ID3 standard for the APIC
+    frame, but also reused in WMA/FLAC/VorbisComment.
+
+    This is copied from mutagen.id3.PictureType
+    """
+
+    OTHER = 0
+
+    FILE_ICON = 1
+    """32x32 pixels 'file icon' (PNG only)"""
+
+    OTHER_FILE_ICON = 2
+    """Other file icon"""
+
+    COVER_FRONT = 3
+    """Cover (front)"""
+
+    COVER_BACK = 4
+    """Cover (back)"""
+
+    LEAFLET_PAGE = 5
+    """Leaflet page"""
+
+    MEDIA = 6
+    """Media (e.g. label side of CD)"""
+
+    LEAD_ARTIST = 7
+    """Lead artist/lead performer/soloist"""
+
+    ARTIST = 8
+    """Artist/performer"""
+
+    CONDUCTOR = 9
+    """Conductor"""
+
+    BAND = 10
+    """Band/Orchestra"""
+
+    COMPOSER = 11
+    """Composer"""
+
+    LYRICIST = 12
+    """Lyricist/text writer"""
+
+    RECORDING_LOCATION = 13
+    """Recording Location"""
+
+    DURING_RECORDING = 14
+    """During recording"""
+
+    DURING_PERFORMANCE = 15
+    """During performance"""
+
+    SCREEN_CAPTURE = 16
+    """Movie/video screen capture"""
+
+    FISH = 17
+    """A bright colored fish"""
+
+    ILLUSTRATION = 18
+    """Illustration"""
+
+    BAND_LOGOTYPE = 19
+    """Band/artist logotype"""
+
+    PUBLISHER_LOGOTYPE = 20
+    """Publisher/Studio logotype"""

music_kraken/utils/string_processing.py

@@ -1,13 +1,14 @@
-from typing import Tuple, Union, Optional
-from pathlib import Path
 import string
 from functools import lru_cache
+from pathlib import Path
+from typing import Any, Optional, Tuple, Union
+from urllib.parse import ParseResult, parse_qs, urlparse
 
-from transliterate.exceptions import LanguageDetectionError
-from transliterate import translit
 from pathvalidate import sanitize_filename
-from urllib.parse import urlparse, ParseResult, parse_qs
+from transliterate import translit
+from transliterate.exceptions import LanguageDetectionError
 
+from .shared import URL_PATTERN
 
 COMMON_TITLE_APPENDIX_LIST: Tuple[str, ...] = (
     "(official video)",
@@ -229,3 +230,12 @@ def shorten_display_url(url: str, max_length: int = 150, chars_at_end: int = 4,
         return url
     
     return url[:max_length] + shorten_string + url[-chars_at_end:]
+
+def is_url(value: Any) -> bool:
+    if isinstance(value, ParseResult):
+        return True
+    
+    if not isinstance(value, str):
+        return True
+
+    return re.match(URL_PATTERN, query) is not None