import os from typing import List, Tuple from mutagen.easyid3 import EasyID3 from ...utils.shared import ( MUSIC_DIR, DATABASE_LOGGER as logger ) from .database_object import ( DatabaseObject, Reference ) """ All Objects dependent """ class SongAttribute: def __init__(self, song_ref: Reference = None): # the reference to the song the lyrics belong to self.song_ref = song_ref def add_song(self, song_ref: Reference): self.song_ref = song_ref def get_ref_song_id(self): if self.song_ref is None: return None return self.song_ref.id def set_ref_song_id(self, song_id): self.song_ref = Reference(song_id) song_ref_id = property(fget=get_ref_song_id, fset=set_ref_song_id) class Metadata: """ Shall only be read or edited via the Song object. For this reason there is no reference to the song needed. """ def __init__(self, data: dict = {}) -> None: self.data = data def get_all_metadata(self): return list(self.data.items()) def __setitem__(self, item, value): if item in EasyID3.valid_keys.keys(): self.data[item] = value def __getitem__(self, item): if item not in self.data: return None return self.data[item] class Source(DatabaseObject, SongAttribute): """ create somehow like that ```python # url won't be a valid one due to it being just an example Source(src="youtube", url="https://youtu.be/dfnsdajlhkjhsd") ``` """ def __init__(self, id_: str = None, src: str = None, url: str = None) -> None: DatabaseObject.__init__(self, id_=id_) SongAttribute.__init__(self) self.src = src self.url = url def __str__(self): return f"{self.src}: {self.url}" class Target(DatabaseObject, SongAttribute): """ create somehow like that ```python # I know path is pointless, and I will change that (don't worry about backwards compatibility there) Target(file="~/Music/genre/artist/album/song.mp3", path="~/Music/genre/artist/album") ``` """ def __init__(self, id_: str = None, file: str = None, path: str = None) -> None: DatabaseObject.__init__(self, id_=id_) SongAttribute.__init__(self) self._file = file self._path = path def set_file(self, _file: str): self._file = _file def get_file(self) -> str | None: if self._file is None: return None return os.path.join(MUSIC_DIR, self._file) def set_path(self, _path: str): self._path = _path def get_path(self) -> str | None: if self._path is None: return None return os.path.join(MUSIC_DIR, self._path) def get_exists_on_disc(self) -> bool: """ returns True when file can be found on disc returns False when file can't be found on disc or no filepath is set """ if not self.is_set(): return False return os.path.exists(self.file) def is_set(self) -> bool: return not (self._file is None or self._path is None) file = property(fget=get_file, fset=set_file) path = property(fget=get_path, fset=set_path) exists_on_disc = property(fget=get_exists_on_disc) class Lyrics(DatabaseObject, SongAttribute): def __init__(self, text: str, language: str, id_: str = None) -> None: DatabaseObject.__init__(self, id_=id_) SongAttribute.__init__(self) self.text = text self.language = language class Song(DatabaseObject): def __init__( self, id_: str = None, mb_id: str = None, title: str = None, album_name: str = None, artist_names: List[str] = [], isrc: str = None, length: int = None, tracksort: int = None, sources: List[Source] = None, target: Target = None, lyrics: List[Lyrics] = None, metadata: dict = {}, album_ref: Reference = None, artist_refs: List[Reference] = None ) -> None: """ id: is not NECESARRILY the musicbrainz id, but is DISTINCT for every song mb_id: is the musicbrainz_id target: Each Song can have exactly one target which can be either full or empty lyrics: There can be multiple lyrics. Each Lyrics object can me added to multiple lyrics """ super().__init__(id_=id_) # attributes # self.id_: str | None = id_ self.mb_id: str | None = mb_id self.title: str | None = title self.album_name: str | None = album_name self.isrc: str | None = isrc self.length_: int | None = length self.artist_names = artist_names self.tracksort: int | None = tracksort self.metadata = Metadata(data=metadata) if sources is None: sources = [] self.sources: List[Source] = sources for source in self.sources: source.add_song(self.reference) if target is None: target = Target() self.target: Target = target self.target.add_song(self.reference) if lyrics is None: lyrics = [] self.lyrics: List[Lyrics] = lyrics for lyrics_ in self.lyrics: lyrics_.add_song(self.reference) self.album_ref = album_ref self.artist_refs = artist_refs self._album: Album | None = None def __eq__(self, other): if type(other) != type(self): return False return self.id == other.id def __str__(self) -> str: return f"\"{self.title}\" by {', '.join(self.artist_names)}" def __repr__(self) -> str: return self.__str__() def get_metadata(self): return self.metadata.get_all_metadata() def has_isrc(self) -> bool: return self.isrc is not None def get_artist_names(self) -> List[str]: return self.artist_names def get_length(self): if self.length_ is None: return None return int(self.length_) def set_length(self, length: int): if type(length) != int: raise TypeError(f"length of a song must be of the type int not {type(length)}") self.length_ = length def get_album_id(self) -> str | None: if self.album_ref is None: return None return self.album_ref.id def set_album(self, album): if self.album_ref.id is not None: if self.album_ref.id != album.id: logger.warning(f"song already refers to different album, overriding reference.") self.album_ref = Reference(album.id) self._album = album album = property(fget=lambda self: self._album, fset=set_album) length: int = property(fget=get_length, fset=set_length) """ All objects dependent on Album """ class Album(DatabaseObject): """ -------DB-FIELDS------- title TEXT, copyright TEXT, album_status TEXT, language TEXT, year TEXT, date TEXT, country TEXT, barcode TEXT, song_id BIGINT, is_split BOOLEAN NOT NULL DEFAULT 0 """ def __init__( self, id_: str = None, title: str = None, copyright_: str = None, album_status: str = None, language: str = None, year: str = None, date: str = None, country: str = None, barcode: str = None, is_split: bool = False, albumsort: int = None, dynamic: bool = False ) -> None: DatabaseObject.__init__(self, id_=id_, dynamic=dynamic) self.title: str = title self.copyright: str = copyright_ self.album_status: str = album_status self.language: str = language self.year: str = year self.date: str = date self.country: str = country self.barcode: str = barcode self.is_split: bool = is_split self.albumsort: int | None = albumsort self.tracklist: List[Song] = [] def __str__(self) -> str: return f"Album: \"{self.title}\"" def __len__(self) -> int: return len(self.tracklist) def set_tracklist(self, tracklist: List[Song]): self.tracklist = tracklist for i, track in enumerate(self.tracklist): track.tracksort = i + 1 def add_song(self, song: Song): for existing_song in self.tracklist: if existing_song == song: return song.tracksort = len(self.tracklist) self.tracklist.append(song) """ All objects dependent on Artist """ class ArtistSong(Song): """ A subclass of Song with the additional attribute is_feature, which makes only sense when in/from the Artist class """ is_feature: bool = False class Artist(DatabaseObject): def __init__( self, id_: str = None, name: str = None, discography: List[Album] = [], features: List[Song] = [] ): DatabaseObject.__init__(self, id_=id_) self.name: str | None = name self.songs: List[ArtistSong] = [] self.album_refs: List[Album] = [] self.song self.set_discography(discography) self.set_features(features) def __str__(self): return self.name or "" def add_album(self, album: Album): self.album_refs.append(album) for song in album.tracklist: song.__class__ = ArtistSong song.is_feature = False self.songs.append(song) def set_discography(self, discography: List[Album]): """ :param discography: :return: """ for album in discography: self.add_album(album) def get_discography(self) -> List[Album]: flat_copy_discography = self.discography.copy() feature_release = Album( title="features", copyright_=self.name, album_status="dynamically generated", is_split=True, albumsort=666, dynamic=True ) for song in self.songs: if song.is_feature: feature_release.add_song(song) flat_copy_discography.append(feature_release) return flat_copy_discography def set_features(self, feature_tracks: List[Song]): for song in feature_tracks: song.__class__ = ArtistSong song.is_feature = True self.songs.append(song) def get_features(self) -> List[ArtistSong]: feature_releases = [] for song in self.songs: if song.is_feature: feature_releases.append(song) return feature_releases discography = property(fget=get_discography, fset=set_discography) features = property(fget=get_features, fset=set_features)