yutipy 1.3.0__tar.gz → 1.3.2__tar.gz

{yutipy-1.3.0 → yutipy-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 1.3.0
+Version: 1.3.2
 Summary: A simple package for retrieving music information from various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>

{yutipy-1.3.0 → yutipy-1.3.2}/docs/usage_examples.rst

@@ -5,7 +5,7 @@ Usage Examples
 Here's a quick example of how to use the **yutipy** package to search for a song:
 
 .. important::
-    All examples here—except for the `YouTube Music`_ & `Yutipy Music`_—use the ``with`` context manager to initialize an instance of the respective class,
+    All examples here—except for the `YouTube Music`_—use the ``with`` context manager to initialize an instance of the respective class,
     as those classes internally use ``requests.Session()`` for making requests to APIs.
     This approach ensures that the session is automatically closed once you exit the context. Although using ``with`` is not mandatory,
     if you instantiate an object without it, you are responsible for closing the session after use by calling the ``close_session()`` method on that object.
@@ -118,6 +118,6 @@ Yutipy Music
 
     from yutipy.yutify_music import YutipyMusic
 
-    yutipy_music = YutipyMusic()
-    result = yutify_music.search("Artist Name", "Song Title")
-    print(result)
+    with YutipyMusic() as yutipy_music:
+        result = yutify_music.search("Artist Name", "Song Title")
+        print(result)

{yutipy-1.3.0 → yutipy-1.3.2}/yutipy/deezer.py

@@ -41,7 +41,7 @@ class Deezer:
         """Checks if the session is closed."""
         return self._is_session_closed
 
-    def search(self, artist: str, song: str) -> Optional[MusicInfo]:
+    def search(self, artist: str, song: str, limit: int = 10) -> Optional[MusicInfo]:
         """
         Searches for a song by artist and title.
 
@@ -51,6 +51,9 @@ class Deezer:
             The name of the artist.
         song : str
             The title of the song.
+        limit: int, optional
+            The number of items to retrieve from API.
+            ``limit >=1 and <= 50``. Default is ``10``.
 
         Returns
         -------
@@ -66,7 +69,7 @@ class Deezer:
 
         for search_type in search_types:
             endpoint = f"{self.api_url}/search/{search_type}"
-            query = f'?q=artist:"{artist}" {search_type}:"{song}"&limit=10'
+            query = f'?q=artist:"{artist}" {search_type}:"{song}"&limit={limit}'
             query_url = endpoint + query
 
             try:

{yutipy-1.3.0 → yutipy-1.3.2}/yutipy/itunes.py

@@ -42,7 +42,7 @@ class Itunes:
         """Checks if the session is closed."""
         return self._is_session_closed
 
-    def search(self, artist: str, song: str) -> Optional[MusicInfo]:
+    def search(self, artist: str, song: str, limit: int = 10) -> Optional[MusicInfo]:
         """
         Searches for a song by artist and title.
 
@@ -52,6 +52,9 @@ class Itunes:
             The name of the artist.
         song : str
             The title of the song.
+        limit: int, optional
+        The number of items to retrieve from API.
+        ``limit >=1 and <= 50``. Default is ``10``.
 
         Returns
         -------
@@ -66,7 +69,7 @@ class Itunes:
         entities = ["song", "album"]
         for entity in entities:
             endpoint = f"{self.api_url}/search"
-            query = f"?term={artist} - {song}&media=music&entity={entity}&limit=10"
+            query = f"?term={artist} - {song}&media=music&entity={entity}&limit={limit}"
             query_url = endpoint + query
 
             try:

{yutipy-1.3.0 → yutipy-1.3.2}/yutipy/kkbox.py

@@ -134,7 +134,7 @@ class KKBox:
             self.__start_time = time.time()
 
     def search(
-        self, artist: str, song: str, territory: str = "TW"
+        self, artist: str, song: str, territory: str = "TW", limit: int = 10,
     ) -> Optional[MusicInfo]:
         """
         Searches for a song by artist and title.
@@ -148,6 +148,9 @@ class KKBox:
         territory : str
             Two-letter country codes from ISO 3166-1 alpha-2.
             Allowed values: ``HK``, ``JP``, ``MY``, ``SG``, ``TW``.
+        limit: int, optional
+            The number of items to retrieve from API.
+            ``limit >=1 and <= 50``. Default is ``10``.
 
         Returns
         -------
@@ -161,7 +164,7 @@ class KKBox:
 
         self.__refresh_token_if_expired()
 
-        query = f"?q={artist} - {song}&type=track,album&territory={territory}&limit=10"
+        query = f"?q={artist} - {song}&type=track,album&territory={territory}&limit={limit}"
         query_url = f"{self.api_url}/search{query}"
 
         try:

{yutipy-1.3.0 → yutipy-1.3.2}/yutipy/musicyt.py

@@ -20,7 +20,7 @@ class MusicYT:
         """Initializes the YouTube Music class and sets up the session."""
         self.ytmusic = YTMusic()
 
-    def search(self, artist: str, song: str) -> Optional[MusicInfo]:
+    def search(self, artist: str, song: str, limit: int = 10) -> Optional[MusicInfo]:
         """
         Searches for a song by artist and title.
 
@@ -30,6 +30,9 @@ class MusicYT:
             The name of the artist.
         song : str
             The title of the song.
+        limit: int, optional
+            The number of items to retrieve from API.
+            ``limit >=1 and <= 50``. Default is ``10``.
 
         Returns
         -------
@@ -44,7 +47,7 @@ class MusicYT:
         query = f"{artist} - {song}"
 
         try:
-            results = self.ytmusic.search(query=query)
+            results = self.ytmusic.search(query=query, limit=limit)
         except exceptions.YTMusicServerError as e:
             raise NetworkException(f"Network error occurred: {e}")
 

{yutipy-1.3.0 → yutipy-1.3.2}/yutipy/spotify.py

@@ -138,7 +138,7 @@ class Spotify:
             self.__header, self.__expires_in = self.__authenticate()
             self.__start_time = time.time()
 
-    def search(self, artist: str, song: str) -> Optional[MusicInfo]:
+    def search(self, artist: str, song: str, limit: int = 10) -> Optional[MusicInfo]:
         """
         Searches for a song by artist and title.
 
@@ -148,6 +148,9 @@ class Spotify:
             The name of the artist.
         song : str
             The title of the song.
+        limit: int, optional
+            The number of items to retrieve from API.
+            ``limit >=1 and <= 50``. Default is ``10``.
 
         Returns
         -------
@@ -161,8 +164,8 @@ class Spotify:
 
         music_info = None
         queries = [
-            f"?q=artist:{artist} track:{song}&type=track&limit=10",
-            f"?q=artist:{artist} album:{song}&type=album&limit=10",
+            f"?q=artist:{artist} track:{song}&type=track&limit={limit}",
+            f"?q=artist:{artist} album:{song}&type=album&limit={limit}",
         ]
 
         for query in queries:

{yutipy-1.3.0 → yutipy-1.3.2}/yutipy/yutipy_music.py

@@ -22,9 +22,22 @@ class YutipyMusic:
     def __init__(self) -> None:
         """Initializes the YutipyMusic class."""
         self.music_info = MusicInfos()
-        self.album_art_priority = ["deezer", "kkbox", "spotify", "musicyt", "itunes"]
-
-    def search(self, artist: str, song: str) -> Optional[MusicInfos]:
+        self.album_art_priority = ["deezer", "kkbox", "spotify", "ytmusic", "itunes"]
+        self.services = {
+            "deezer": Deezer(),
+            "itunes": Itunes(),
+            "kkbox": KKBox(),
+            "ytmusic": MusicYT(),
+            "spotify": Spotify(),
+        }
+
+    def __enter__(self) -> "YutipyMusic":
+        return self
+
+    def __exit__(self, exc_type, exc_value, exc_traceback) -> None:
+        self.close_sessions()
+
+    def search(self, artist: str, song: str, limit: int = 5) -> Optional[MusicInfos]:
         """
         Searches for a song by artist and title.
 
@@ -34,6 +47,9 @@ class YutipyMusic:
             The name of the artist.
         song : str
             The title of the song.
+        limit: int, optional
+            The number of items to retrieve from all APIs.
+            ``limit >=1 and <= 50``. Default is ``5``.
 
         Returns
         -------
@@ -45,18 +61,12 @@ class YutipyMusic:
                 "Artist and song names must be valid strings and can't be empty."
             )
 
-        services = [
-            (Deezer, "deezer"),
-            (Itunes, "itunes"),
-            (KKBox, "kkbox"),
-            (MusicYT, "musicyt"),
-            (Spotify, "spotify"),
-        ]
-
         with ThreadPoolExecutor() as executor:
             futures = {
-                executor.submit(service().search, artist, song): name
-                for service, name in services
+                executor.submit(
+                    service.search, artist=artist, song=song, limit=limit
+                ): name
+                for name, service in self.services.items()
             }
 
             for future in as_completed(futures):
@@ -64,7 +74,10 @@ class YutipyMusic:
                 result = future.result()
                 self._combine_results(result, service_name)
 
-        return self.music_info if self.music_info else None
+        if len(self.music_info.url) == 0:
+            return None
+
+        return self.music_info
 
     def _combine_results(self, result: Optional[MusicInfo], service_name: str) -> None:
         """
@@ -114,9 +127,16 @@ class YutipyMusic:
         self.music_info.id[service_name] = result.id
         self.music_info.url[service_name] = result.url
 
+    def close_sessions(self) -> None:
+        """Closes the sessions for all services."""
+        for service in self.services.values():
+            if hasattr(service, "close_session"):
+                service.close_session()
+
 
 if __name__ == "__main__":
     yutipy_music = YutipyMusic()
     artist_name = input("Artist Name: ")
     song_name = input("Song Name: ")
     pprint(yutipy_music.search(artist_name, song_name))
+    yutipy_music.close_sessions()

{yutipy-1.3.0 → yutipy-1.3.2}/yutipy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 1.3.0
+Version: 1.3.2
 Summary: A simple package for retrieving music information from various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>