Merge pull request 'fix/clean_feature_artists' (#38) from fix/clean_feature_artists into experimental

Reviewed-on: #38

music_kraken/cli/main_downloader.py

@@ -354,37 +354,41 @@ class Downloader:
                 command, query = _[0], ":".join(_[1:])
 
             do_search = "s" in command
+            do_fetch = "f" in command
             do_download = "d" in command
             do_merge = "m" in command
 
-            if do_search and do_download:
-                raise MKInvalidInputException(message="You can't search and download at the same time.")
-
-            if do_search and do_merge:
-                raise MKInvalidInputException(message="You can't search and merge at the same time.")
+            if do_search and (do_download or do_fetch or do_merge):
+                raise MKInvalidInputException(message="You can't search and do another operation at the same time.")
 
             if do_search:
                 self.search(":".join(input_str.split(":")[1:]))
                 return False
 
-            indices = []
-            for possible_index in query.split(","):
-                possible_index = possible_index.strip()
-                if possible_index == "":
-                    continue
-                
-                i = 0
-                try:
-                    i = int(possible_index)
-                except ValueError:
-                    raise MKInvalidInputException(message=f"The index \"{possible_index}\" is not a number.")
+            def get_selected_objects(q: str):
+                if q.strip().lower() == "all":
+                    return list(self.current_results)
 
-                if i < 0 or i >= len(self.current_results):
-                    raise MKInvalidInputException(message=f"The index \"{i}\" is not within the bounds of 0-{len(self.current_results) - 1}.")
-                
-                indices.append(i)
+                indices = []
+                for possible_index in q.split(","):
+                    possible_index = possible_index.strip()
+                    if possible_index == "":
+                        continue
+                    
+                    i = 0
+                    try:
+                        i = int(possible_index)
+                    except ValueError:
+                        raise MKInvalidInputException(message=f"The index \"{possible_index}\" is not a number.")
 
-            selected_objects = [self.current_results[i] for i in indices]
+                    if i < 0 or i >= len(self.current_results):
+                        raise MKInvalidInputException(message=f"The index \"{i}\" is not within the bounds of 0-{len(self.current_results) - 1}.")
+                    
+                    indices.append(i)
+
+                return [self.current_results[i] for i in indices]
+
+            selected_objects = get_selected_objects(query)
 
             if do_merge:
                 old_selected_objects = selected_objects
@@ -397,6 +401,13 @@ class Downloader:
 
                 selected_objects = [a]
 
+            if do_fetch:
+                for data_object in selected_objects:
+                    self.pages.fetch_details(data_object)
+
+                self.print_current_options()
+                return False
+
             if do_download:
                 self.download(selected_objects)
                 return False

music_kraken/objects/collection.py

@@ -115,7 +115,6 @@ class Collection(Generic[T]):
         self._data.append(other)
         other._inner._is_in_collection.add(self)
 
-        """
         for attribute, a in self.sync_on_append.items():
             # syncing two collections by reference
             b = other.__getattribute__(attribute)
@@ -134,7 +133,6 @@ class Collection(Generic[T]):
                 a._collection_for[synced_with] = key
 
             a.extend(b_data, **kwargs)
-        """
 
         # all of the existing hooks to get the defined datastructures
         for collection_attribute, generator in self.extend_object_to_attribute.items():
@@ -162,24 +160,6 @@ class Collection(Generic[T]):
 
         object_trace(f"Appending {other.option_string} to {self}")
 
-        for attribute, a in self.sync_on_append.items():
-            # syncing two collections by reference
-            b = other.__getattribute__(attribute)
-            if a is b:
-                continue
-
-            object_trace(f"Syncing [{a}] = [{b}]")
-
-            b_data = b.data.copy()
-            b_collection_for = b._collection_for.copy()
-
-            del b
-
-            for synced_with, key in b_collection_for.items():
-                synced_with.__setattr__(key, a)
-                a._collection_for[synced_with] = key
-
-            a.extend(b_data, **kwargs)
 
         # switching collection in the case of push to
         for c in self.push_to:

music_kraken/objects/song.py

@@ -219,7 +219,8 @@ class Song(Base):
 
     @property
     def option_string(self) -> str:
-        r = OPTION_FOREGROUND.value + self.title_string + BColors.ENDC.value + OPTION_BACKGROUND.value
+        r = "song "
+        r += OPTION_FOREGROUND.value + self.title_string + BColors.ENDC.value + OPTION_BACKGROUND.value
         r += get_collection_string(self.album_collection, " from {}", ignore_titles={self.title})
         r += get_collection_string(self.artist_collection, " by {}")
         r += get_collection_string(self.feature_artist_collection, " feat. {}" if len(self.artist_collection) > 0 else " by {}")
@@ -369,9 +370,11 @@ class Album(Base):
 
     @property
     def option_string(self) -> str:
-        r = OPTION_FOREGROUND.value + self.title_string + BColors.ENDC.value + OPTION_BACKGROUND.value
+        r = "album "
+        r += OPTION_FOREGROUND.value + self.title_string + BColors.ENDC.value + OPTION_BACKGROUND.value
         r += get_collection_string(self.artist_collection, " by {}")
-        r += get_collection_string(self.feature_artist_collection, " feat. {}" if len(self.artist_collection) > 0 else " by {}")
+        if len(self.artist_collection) <= 0:
+            r += get_collection_string(self.feature_artist_collection, " by {}")
         r += get_collection_string(self.label_collection, " under {}")
 
         if len(self.song_collection) > 0:
@@ -627,7 +630,8 @@ class Artist(Base):
 
     @property
     def option_string(self) -> str:
-        r = OPTION_FOREGROUND.value + self.title_string + BColors.ENDC.value + OPTION_BACKGROUND.value
+        r = "artist "
+        r += OPTION_FOREGROUND.value + self.title_string + BColors.ENDC.value + OPTION_BACKGROUND.value
         r += get_collection_string(self.label_collection, " under {}")
         
         r += OPTION_BACKGROUND.value
@@ -720,4 +724,4 @@ class Label(Base):
 
     @property
     def option_string(self):
-        return OPTION_FOREGROUND.value + self.name + BColors.ENDC.value
+        return "label " + OPTION_FOREGROUND.value + self.name + BColors.ENDC.value

music_kraken/pages/youtube_music/youtube_music.py

@@ -589,6 +589,8 @@ class YoutubeMusic(SuperYouTube):
             },
             name=f"fetch_song_lyrics_{video_id}.json"
         )
+        if r is None:
+            return None
 
         dump_to_file(f"fetch_song_lyrics_{video_id}.json", r.text, is_json=True, exit_after_dump=False)
 

music_kraken/utils/config/config_files/main_config.py

@@ -19,7 +19,7 @@ config = Config((
 You can use Audio formats which support ID3.2 and ID3.1,
 but you will have cleaner Metadata using ID3.2."""),
 
-    Attribute(name="result_history", default_value=False, description="""If enabled, you can go back to the previous results.
+    Attribute(name="result_history", default_value=True, description="""If enabled, you can go back to the previous results.
 The consequence is a higher meory consumption, because every result is saved."""),
     Attribute(name="history_length", default_value=8, description="""You can choose how far back you can go in the result history.
 The further you choose to be able to go back, the higher the memory usage.

music_kraken/utils/shared.py

@@ -15,7 +15,7 @@ __stage__ = os.getenv("STAGE", "prod")
 DEBUG = (__stage__ == "dev") and True
 DEBUG_LOGGING = DEBUG and False
 DEBUG_TRACE = DEBUG and True
-DEBUG_OBJECT_TRACE = DEBUG and False
+DEBUG_OBJECT_TRACE = DEBUG and True
 DEBUG_OBJECT_TRACE_CALLSTACK = DEBUG_OBJECT_TRACE and False
 DEBUG_YOUTUBE_INITIALIZING = DEBUG and False
 DEBUG_PAGES = DEBUG and False

tests/test_collection.py

@@ -3,92 +3,94 @@ import unittest
 from music_kraken.objects import Song, Album, Artist, Collection, Country
 
 class TestCollection(unittest.TestCase):
-    @staticmethod
-    def complicated_object() -> Artist:
-        return Artist(
-            name="artist",
-            country=Country.by_alpha_2("DE"),
-            album_list=[
-                Album(
-                    title="album",
-                    song_list=[
-                        Song(
-                            title="song",
-                            album_list=[
-                                Album(title="album", albumsort=123),
-                            ],
-                        ),
-                        Song(
-                            title="other_song",
-                            album_list=[
-                                Album(title="album", albumsort=423),
-                            ],
-                        ),
-                    ]
-                ),
-                Album(title="album", barcode="1234567890123"),
+    def test_song_contains_album(self):
+        """
+        Tests that every song contains the album it is added to in its album_collection
+        """
+
+        a_1 = Album(
+            title="album",
+            song_list= [
+                Song(title="song"),
             ]
         )
+        a_2 = a_1.song_collection[0].album_collection[0]
+        self.assertTrue(a_1.id == a_2.id)
 
-    def test_song_album_relation(self):
+    def test_album_contains_song(self):
         """
-        Tests that
-        album = album.any_song.one_album
-        is the same object
+        Tests that every album contains the song it is added to in its song_collection
+        """
+        s_1 = Song(
+            title="song",
+            album_list=[
+                Album(title="album"),
+            ]
+        )
+        s_2 = s_1.album_collection[0].song_collection[0]
+        self.assertTrue(s_1.id == s_2.id)
+
+
+    def test_auto_add_artist_to_album_feature_artist(self):
+        """
+        Tests that every artist is added to the album's feature_artist_collection per default
         """
 
-        a = self.complicated_object().album_collection[0]
-        b = a.song_collection[0].album_collection[0]
-        c = a.song_collection[1].album_collection[0]
-        d = b.song_collection[0].album_collection[0]
-        e = d.song_collection[0].album_collection[0]
-        f = e.song_collection[0].album_collection[0]
-        g = f.song_collection[0].album_collection[0]
+        a_1 = Artist(
+            name="artist",
+            album_list=[
+                Album(title="album")
+            ]
+        )
+        a_2 = a_1.album_collection[0].feature_artist_collection[0]
 
-        self.assertTrue(a.id == b.id == c.id == d.id == e.id == f.id == g.id)
-        self.assertTrue(a.title == b.title == c.title == d.title == e.title == f.title == g.title == "album")
-        self.assertTrue(a.barcode == b.barcode == c.barcode == d.barcode == e.barcode == f.barcode == g.barcode == "1234567890123")
-        self.assertTrue(a.albumsort == b.albumsort == c.albumsort == d.albumsort == e.albumsort == f.albumsort == g.albumsort == 123)
-
-        d.title = "new_title"
-
-        self.assertTrue(a.title == b.title == c.title == d.title == e.title == f.title == g.title == "new_title")
-
-    def test_album_artist_relation(self):
+        self.assertTrue(a_1.id == a_2.id)
+    
+    def test_auto_add_artist_to_album_feature_artist_push(self):
         """
-        Tests that
-        artist = artist.any_album.any_song.one_artist
-        is the same object
+        Tests that every artist is added to the album's feature_artist_collection per default but pulled into the album's artist_collection if a merge exitst
         """
 
-        a = self.complicated_object()
-        b = a.album_collection[0].artist_collection[0]
-        c = b.album_collection[0].artist_collection[0]
-        d = c.album_collection[0].artist_collection[0]
-
-        self.assertTrue(a.id == b.id == c.id == d.id)
-        self.assertTrue(a.name == b.name == c.name == d.name == "artist")
-        self.assertTrue(a.country == b.country == c.country == d.country)
-
-    def test_artist_artist_relation(self):
-        artist = Artist(
+        a_1 = Artist(
             name="artist",
             album_list=[
                 Album(
                     title="album",
-                    song_list=[
-                        Song(title="song"),
-                    ],
                     artist_list=[
                         Artist(name="artist"),
                     ]
                 )
             ]
         )
+        a_2 = a_1.album_collection[0].artist_collection[0]
 
-        self.assertTrue(artist.id == artist.album_collection[0].song_collection[0].artist_collection[0].id)
+        self.assertTrue(a_1.id == a_2.id)
+
+
+    def test_artist_artist_relation(self):
+        """
+        Tests the proper syncing between album.artist_collection and song.artist_collection
+        """
+
+        album = Album(
+            title="album",
+            song_list=[
+                Song(title="song"),
+            ],
+            artist_list=[
+                Artist(name="artist"),
+            ]
+        )
+        a_1 = album.artist_collection[0]
+        a_2 = album.song_collection[0].artist_collection[0]
+
+        self.assertTrue(a_1.id == a_2.id)
 
     def test_artist_collection_sync(self):
+        """
+        tests the actual implementation of the test above
+        """
+
         album_1 = Album(
             title="album",
             song_list=[
@@ -113,15 +115,5 @@ class TestCollection(unittest.TestCase):
 
         self.assertTrue(id(album_1.artist_collection) == id(album_1.artist_collection) == id(album_1.song_collection[0].artist_collection) == id(album_1.song_collection[0].artist_collection))
 
-    def test_song_artist_relations(self):
-        a = self.complicated_object()
-        b = a.album_collection[0].song_collection[0].artist_collection[0]
-        c = b.album_collection[0].song_collection[0].artist_collection[0]
-        d = c.album_collection[0].song_collection[0].artist_collection[0]
-
-        self.assertTrue(a.id == b.id == c.id == d.id)
-        self.assertTrue(a.name == b.name == c.name == d.name == "artist")
-        self.assertTrue(a.country == b.country == c.country == d.country)
-
 if __name__ == "__main__":
     unittest.main()