import os from typing import List, Optional, Type import pycountry import copy from .metadata import ( Mapping as id3Mapping, ID3Timestamp, MetadataAttribute ) from src.music_kraken.utils.shared import ( MUSIC_DIR, DATABASE_LOGGER as logger ) from .parents import ( DatabaseObject, Reference, SongAttribute ) from .source import ( Source, SourceTypes, SourcePages, SourceAttribute ) from .formatted_text import FormattedText from .collection import Collection from .album import AlbumType, AlbumStatus """ All Objects dependent """ CountryTyping = type(list(pycountry.countries)[0]) 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) -> Optional[str]: 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) -> Optional[str]: 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, SourceAttribute, MetadataAttribute): def __init__( self, text: str, language: pycountry.Languages, id_: str = None, source_list: List[Source] = None ) -> None: DatabaseObject.__init__(self, id_=id_) SongAttribute.__init__(self) self.text = text self.language = language if source_list is not None: self.source_list = source_list def get_metadata(self) -> MetadataAttribute.Metadata: return super().get_metadata() class Song(DatabaseObject, SourceAttribute, MetadataAttribute): """ Class representing a song object, with attributes id, mb_id, title, album_name, isrc, length, tracksort, genre, source_list, target, lyrics_list, album, main_artist_list, and feature_artist_list. Inherits from DatabaseObject, SourceAttribute, and MetadataAttribute classes. """ def __init__( self, id_: str = None, title: str = None, isrc: str = None, length: int = None, tracksort: int = None, genre: str = None, source_list: List[Source] = None, target: Target = None, lyrics_list: List[Lyrics] = None, album_list: Type['Album'] = None, main_artist_list: List[Type['Artist']] = None, feature_artist_list: List[Type['Artist']] = None, **kwargs ) -> None: """ Initializes the Song object with the following attributes: """ super().__init__(id_=id_, **kwargs) # attributes # *private* attributes self.title: str = title self.isrc: str = isrc self.length: int = length self.tracksort: int = tracksort or 0 self.genre: str = genre self.source_list = source_list or [] self.target = target or Target() self.lyrics_list = lyrics_list or [] # initialize with either a passed in album, or an empty one, # so it can at least properly generate dynamic attributes """ TODO put in collection """ self._album: List[Type['Album']] = album_list or [] self.album = album self.main_artist_collection = Collection( data=main_artist_list or [], map_attributes=["title"], element_type=Artist ) self.feature_artist_collection = Collection( data=feature_artist_list or [], map_attributes=["title"], element_type=Artist ) def __eq__(self, other): if type(other) != type(self): return False return self.id == other.id def get_artist_credits(self) -> str: main_artists = ", ".join([artist.name for artist in self.main_artist_collection]) feature_artists = ", ".join([artist.name for artist in self.feature_artist_collection]) if len(feature_artists) == 0: return main_artists return f"{main_artists} feat. {feature_artists}" def __str__(self) -> str: artist_credit_str = "" artist_credits = self.get_artist_credits() if artist_credits != "": artist_credit_str = f" by {artist_credits}" return f"\"{self.title}\"{artist_credit_str}" def __repr__(self) -> str: return f"Song(\"{self.title}\")" def get_tracksort_str(self): """ if the album tracklist is empty, it sets it length to 1, this song has to be in the Album :returns id3_tracksort: {song_position}/{album.length_of_tracklist} """ return f"{self.tracksort}/{len(self.album.tracklist) or 1}" def get_metadata(self) -> MetadataAttribute.Metadata: metadata = MetadataAttribute.Metadata({ id3Mapping.TITLE: [self.title], id3Mapping.ISRC: [self.isrc], id3Mapping.LENGTH: [self.length], id3Mapping.GENRE: [self.genre], id3Mapping.TRACKNUMBER: [self.tracksort_str] }) metadata.merge_many([s.get_song_metadata() for s in self.source_list]) if not self.album.empty: metadata.merge(self.album.metadata) metadata.merge_many([a.metadata for a in self.main_artist_list]) metadata.merge_many([a.metadata for a in self.feature_artist_list]) metadata.merge_many([l.metadata for l in self.lyrics]) return metadata def get_options(self) -> list: """ Return a list of related objects including the song object, album object, main artist objects, and feature artist objects. :return: a list of objects that are related to the Song object """ options = self.main_artist_list.copy() options.extend(self.feature_artist_list.copy()) if not self.album.empty: options.append(self.album) options.append(self) return options def get_option_string(self) -> str: return f"Song({self.title}) of Album({self.album.title}) from Artists({self.get_artist_credits()})" tracksort_str: List[Type['Album']] = property(fget=get_tracksort_str) main_artist_list: List[Type['Artist']] = property(fget=lambda self: self.main_artist_collection.copy()) feature_artist_list: List[Type['Artist']] = property(fget=lambda self: self.feature_artist_collection.copy()) """ All objects dependent on Album """ class Album(DatabaseObject, SourceAttribute, MetadataAttribute): def __init__( self, id_: str = None, title: str = None, label: str = None, language: pycountry.Languages = None, date: ID3Timestamp = None, barcode: str = None, is_split: bool = False, albumsort: int = None, dynamic: bool = False, source_list: List[Source] = None, artist_list: list = None, tracklist: List[Song] = None, album_status: AlbumStatus = None, album_type: AlbumType = None, **kwargs ) -> None: DatabaseObject.__init__(self, id_=id_, dynamic=dynamic, **kwargs) """ TODO add to db """ self.album_type: AlbumType = album_type self.title: str = title self.album_status: AlbumStatus = album_status self.label = label self.language: pycountry.Languages = language self.date: ID3Timestamp = date or ID3Timestamp() """ TODO find out the id3 tag for barcode and implement it maybe look at how mutagen does it with easy_id3 """ self.barcode: str = barcode self.is_split: bool = is_split """ TODO implement a function in the Artist class, to set albumsort with help of the release year """ self.albumsort: Optional[int] = albumsort self._tracklist = Collection( data=tracklist or [], map_attributes=["title"], element_type=Song ) self.source_list = source_list or [] self.artists = Collection( data=artist_list or [], map_attributes=["name"], element_type=Artist ) def __str__(self) -> str: return f"-----{self.title}-----\n{self.tracklist}" def __repr__(self): return f"Album(\"{self.title}\")" def __len__(self) -> int: return len(self.tracklist) def set_tracklist(self, tracklist): tracklist_list = [] if type(tracklist) == Collection: tracklist_list = tracklist_list elif type(tracklist) == list: tracklist_list = tracklist self._tracklist = Collection( data=tracklist_list, map_attributes=["title"], element_type=Song ) def get_metadata(self) -> MetadataAttribute.Metadata: return MetadataAttribute.Metadata({ id3Mapping.ALBUM: [self.title], id3Mapping.COPYRIGHT: [self.copyright], id3Mapping.LANGUAGE: [self.iso_639_2_language], id3Mapping.ALBUM_ARTIST: [a.name for a in self.artists], id3Mapping.DATE: [self.date.timestamp] }) def get_copyright(self) -> str: if self.date is None: return "" if self.date.year == 1 or self.label is None: return "" return f"{self.date.year} {self.label}" def get_iso_639_2_lang(self) -> Optional[str]: if self.language is None: return None return self.language.alpha_3 def get_options(self) -> list: options = self.artists.copy() options.append(self) for track in self.tracklist: new_track: Song = copy.copy(track) new_track.album = self options.append(new_track) return options def get_option_string(self) -> str: return f"Album: {self.title}; Artists {', '.join([i.name for i in self.artists])}" copyright = property(fget=get_copyright) iso_639_2_language = property(fget=get_iso_639_2_lang) tracklist: Collection = property(fget=lambda self: self._tracklist, fset=set_tracklist) """ All objects dependent on Artist """ class Artist(DatabaseObject, SourceAttribute, MetadataAttribute): """ main_songs feature_song albums """ def __init__( self, id_: str = None, name: str = None, source_list: List[Source] = None, feature_songs: List[Song] = None, main_albums: List[Album] = None, notes: FormattedText = None, lyrical_themes: List[str] = None, general_genre: str = "", country: CountryTyping = None, formed_in: ID3Timestamp = None ): DatabaseObject.__init__(self, id_=id_) """ TODO implement album type and notes """ self.country: CountryTyping = country self.formed_in: ID3Timestamp = formed_in """ notes, generall genre, lyrics themes are attributes which are meant to only use in outputs to describe the object i mean do as you want but there aint no strict rule about em so good luck """ self.notes: FormattedText = notes or FormattedText() self.lyrical_themes: List[str] = lyrical_themes or [] self.general_genre = general_genre self.name: str = name self.feature_songs = Collection( data=feature_songs, map_attributes=["title"], element_type=Song ) self.main_albums = Collection( data=main_albums, map_attributes=["title"], element_type=Album ) if source_list is not None: self.source_list = source_list def __str__(self): string = self.name or "" plaintext_notes = self.notes.get_plaintext() if plaintext_notes is not None: string += "\n" + plaintext_notes return string def __repr__(self): return self.__str__() def __eq__(self, __o: DatabaseObject) -> bool: return self.id_ == __o.id_ def get_features(self) -> Album: feature_release = Album( title="features", album_status=AlbumStatus.UNRELEASED, album_type=AlbumType.COMPILATION_ALBUM, is_split=True, albumsort=666, dynamic=True ) return feature_release def get_all_songs(self) -> List[Song]: """ returns a list of all Songs. probably not that useful, because it is unsorted """ collection = [] for album in self.discography: collection.extend(album.tracklist) return collection def get_discography(self) -> List[Album]: flat_copy_discography = self.main_albums.copy() flat_copy_discography.append(self.get_features()) return flat_copy_discography def get_metadata(self) -> MetadataAttribute.Metadata: metadata = MetadataAttribute.Metadata({ id3Mapping.ARTIST: [self.name] }) metadata.merge_many([s.get_artist_metadata() for s in self.source_list]) return metadata def get_options(self) -> list: options = [self] options.extend(self.main_albums) options.extend(self.feature_songs) return options def get_option_string(self) -> str: return f"Artist: {self.name}" discography: List[Album] = property(fget=get_discography) features: Album = property(fget=get_features) all_songs: Album = property(fget=get_all_songs)