yutipy 2.2.2__tar.gz → 2.2.4__tar.gz

{yutipy-2.2.2 → yutipy-2.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 2.2.2
+Version: 2.2.4
 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-2.2.2 → yutipy-2.2.4}/docs/api_reference.rst

@@ -97,7 +97,7 @@ UserPlaying
 .. autoclass:: yutipy.models.UserPlaying
     :members:
     :noindex:
-    :exclude-members: album_art, album_art_source, album_title, album_type, artists, genre, id, isrc, lyrics, release_date, tempo, title, type, upc, url, is_playing
+    :exclude-members: album_art, album_art_source, album_title, album_type, artists, genre, id, isrc, lyrics, release_date, tempo, title, type, upc, url, timestamp, is_playing
 
 Exceptions
 =============

{yutipy-2.2.2 → yutipy-2.2.4}/tests/test_spotify.py

@@ -183,6 +183,7 @@ def test_get_currently_playing(spotify_auth, monkeypatch):
             @staticmethod
             def json():
                 return {
+                    "timestamp": 1745797530935,
                     "is_playing": False,
                     "item": {
                         "album": {

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy/deezer.py

@@ -9,11 +9,10 @@ from yutipy.exceptions import (
     DeezerException,
     InvalidResponseException,
     InvalidValueException,
-    NetworkException,
 )
+from yutipy.logger import logger
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import are_strings_similar, is_valid_string
-from yutipy.logger import logger
 
 
 class Deezer:
@@ -97,17 +96,17 @@ class Deezer:
                 logger.debug(f"Response status code: {response.status_code}")
                 response.raise_for_status()
             except requests.RequestException as e:
-                logger.error(f"Network error while fetching music info: {e}")
-                raise NetworkException(f"Network error occurred: {e}")
+                logger.warning(f"Network error while fetching music info: {e}")
+                return None
             except Exception as e:
-                logger.exception(f"Unexpected error while searching Deezer: {e}")
+                logger.warning(f"Unexpected error while searching Deezer: {e}")
                 raise DeezerException(f"An error occurred while searching Deezer: {e}")
 
             try:
                 logger.debug(f"Parsing response JSON: {response.json()}")
                 result = response.json()["data"]
             except (IndexError, KeyError, ValueError) as e:
-                logger.error(f"Invalid response structure from Deezer: {e}")
+                logger.warning(f"Invalid response structure from Deezer: {e}")
                 raise InvalidResponseException(f"Invalid response received: {e}")
 
             music_info = self._parse_results(artist, song, result)
@@ -164,17 +163,17 @@ class Deezer:
             logger.debug(f"Response status code: {response.status_code}")
             response.raise_for_status()
         except requests.RequestException as e:
-            logger.error(f"Error fetching track info: {e}")
-            raise NetworkException(f"Network error occurred: {e}")
+            logger.warning(f"Error fetching track info: {e}")
+            return None
         except Exception as e:
-            logger.error(f"Error fetching track info: {e}")
+            logger.warning(f"Error fetching track info: {e}")
             raise DeezerException(f"An error occurred while fetching track info: {e}")
 
         try:
             logger.debug(f"Response JSON: {response.json()}")
             result = response.json()
         except ValueError as e:
-            logger.error(f"Invalid response received from Deezer: {e}")
+            logger.warning(f"Invalid response received from Deezer: {e}")
             raise InvalidResponseException(f"Invalid response received: {e}")
 
         return {
@@ -205,17 +204,17 @@ class Deezer:
             logger.info(f"Response status code: {response.status_code}")
             response.raise_for_status()
         except requests.RequestException as e:
-            logger.error(f"Error fetching album info: {e}")
-            raise NetworkException(f"Network error occurred: {e}")
+            logger.warning(f"Error fetching album info: {e}")
+            return None
         except Exception as e:
-            logger.error(f"Error fetching album info: {e}")
+            logger.warning(f"Error fetching album info: {e}")
             raise DeezerException(f"An error occurred while fetching album info: {e}")
 
         try:
             logger.debug(f"Response JSON: {response.json()}")
             result = response.json()
         except ValueError as e:
-            logger.error(f"Invalid response received from Deezer: {e}")
+            logger.warning(f"Invalid response received from Deezer: {e}")
             raise InvalidResponseException(f"Invalid response received: {e}")
 
         return {
@@ -323,6 +322,7 @@ class Deezer:
 
 if __name__ == "__main__":
     import logging
+
     from yutipy.logger import enable_logging
 
     enable_logging(level=logging.DEBUG)

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy/exceptions.py

@@ -2,7 +2,6 @@ __all__ = [
     "AuthenticationException",
     "InvalidResponseException",
     "InvalidValueException",
-    "NetworkException",
     "YutipyException",
 ]
 
@@ -25,10 +24,6 @@ class InvalidValueException(YutipyException):
     """Exception raised for invalid values."""
 
 
-class NetworkException(YutipyException):
-    """Exception raised for network-related errors."""
-
-
 # Service Exceptions
 class DeezerException(YutipyException):
     """Exception raised for errors related to the Deezer API."""

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy/itunes.py

@@ -9,8 +9,7 @@ import requests
 from yutipy.exceptions import (
     InvalidResponseException,
     InvalidValueException,
-    ItunesException,
-    NetworkException,
+    ItunesException
 )
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import (
@@ -100,8 +99,8 @@ class Itunes:
                 logger.debug(f"Response status code: {response.status_code}")
                 response.raise_for_status()
             except requests.RequestException as e:
-                logger.error(f"Network error while searching iTunes: {e}")
-                raise NetworkException(f"Network error occurred: {e}")
+                logger.warning(f"Network error while searching iTunes: {e}")
+                return None
             except Exception as e:
                 logger.exception(f"Unexpected error while searching iTunes: {e}")
                 raise ItunesException(f"An error occurred while searching iTunes: {e}")
@@ -110,7 +109,7 @@ class Itunes:
                 logger.debug(f"Parsing response JSON: {response.json()}")
                 result = response.json()["results"]
             except (IndexError, KeyError, ValueError) as e:
-                logger.error(f"Invalid response structure from iTunes: {e}")
+                logger.warning(f"Invalid response structure from iTunes: {e}")
                 raise InvalidResponseException(f"Invalid response received: {e}")
 
             music_info = self._parse_result(artist, song, result)

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy/kkbox.py

@@ -12,10 +12,8 @@ from dotenv import load_dotenv
 
 from yutipy.exceptions import (
     AuthenticationException,
-    InvalidResponseException,
     InvalidValueException,
     KKBoxException,
-    NetworkException,
 )
 from yutipy.logger import logger
 from yutipy.models import MusicInfo
@@ -91,6 +89,13 @@ class KKBox:
                 self.__access_token = token_info.get("access_token")
                 self.__token_expires_in = token_info.get("expires_in")
                 self.__token_requested_at = token_info.get("requested_at")
+
+                try:
+                    self.save_access_token(token_info)
+                except NotImplementedError:
+                    logger.warning(
+                        "`save_access_token` is not implemented, falling back to in-memory storage. Access token will not be saved."
+                    )
         else:
             logger.warning(
                 "`defer_load` is set to `True`. Make sure to call `load_token_after_init()`."
@@ -135,6 +140,13 @@ class KKBox:
             self.__token_expires_in = token_info.get("expires_in")
             self.__token_requested_at = token_info.get("requested_at")
 
+            try:
+                self.save_access_token(token_info)
+            except NotImplementedError:
+                logger.warning(
+                    "`save_access_token` is not implemented, falling back to in-memory storage. Access token will not be saved."
+                )
+
     def __authorization_header(self) -> dict:
         """
         Generates the authorization header for Spotify API requests.
@@ -173,15 +185,15 @@ class KKBox:
             logger.debug(f"Authentication response status code: {response.status_code}")
             response.raise_for_status()
         except requests.RequestException as e:
-            logger.error(f"Network error during KKBOX authentication: {e}")
-            raise NetworkException(f"Network error occurred: {e}")
+            logger.warning(f"Network error during KKBOX authentication: {e}")
+            return None
 
         if response.status_code == 200:
             response_json = response.json()
             response_json["requested_at"] = time()
             return response_json
         else:
-            raise InvalidResponseException(
+            raise AuthenticationException(
                 f"Invalid response received: {response.json()}"
             )
 
@@ -305,7 +317,7 @@ class KKBox:
             logger.debug(f"Parsing response JSON: {response.json()}")
             response.raise_for_status()
         except requests.RequestException as e:
-            raise NetworkException(f"Network error occurred: {e}")
+            return None
 
         if response.status_code != 200:
             raise KKBoxException(f"Failed to search for music: {response.json()}")

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy/lastfm.py

@@ -95,7 +95,7 @@ class LastFm:
             response = self.__session.get(query_url, timeout=30)
             response.raise_for_status()
         except requests.RequestException as e:
-            logger.error(f"Failed to fetch user profile: {e}")
+            logger.warning(f"Failed to fetch user profile: {e}")
             return None
 
         response_json = response.json()
@@ -110,6 +110,7 @@ class LastFm:
             album_title=result.get("album", {}).get("#text"),
             artists=", ".join(separate_artists(result.get("artist", {}).get("#text"))),
             id=result.get("mbid"),
+            timestamp=result.get("date", {}).get("uts"),
             title=result.get("name"),
             url=result.get("url"),
             is_playing=result.get("@attr", {}).get("nowplaying", False),

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy/logger.py

@@ -2,7 +2,7 @@ import logging
 
 # Create a logger for the library
 logger = logging.getLogger("yutipy")
-logger.setLevel(logging.WARNING)
+logger.setLevel(logging.CRITICAL)
 
 
 def enable_logging(level=logging.INFO, handler=None):
@@ -37,6 +37,6 @@ def enable_logging(level=logging.INFO, handler=None):
 
 def disable_logging():
     """Disable logging for the library."""
-    logger.setLevel(logging.CRITICAL)
+    logger.setLevel(logging.NOTSET)
     for handler in logger.handlers[:]:  # Remove all handlers
         logger.removeHandler(handler)

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy/models.py

@@ -74,8 +74,11 @@ class UserPlaying(MusicInfo):
 
     Attributes
     ----------
+    timetamp : Optional[int]
+        Unix Timestamp (in seconds) when playback was started.
     is_playing : Optional[bool]
         Whether the music is currently playing or paused.
     """
 
+    timestamp: Optional[int] = None
     is_playing: Optional[bool] = None

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy/musicyt.py

@@ -11,9 +11,9 @@ from yutipy.exceptions import (
     InvalidValueException,
     MusicYTException,
 )
+from yutipy.logger import logger
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import are_strings_similar, is_valid_string
-from yutipy.logger import logger
 
 
 class MusicYT:
@@ -87,8 +87,8 @@ class MusicYT:
         try:
             results = self.ytmusic.search(query=query, limit=limit)
         except exceptions.YTMusicServerError as e:
-            logger.error(f"Something went wrong while searching YTMusic: {e}")
-            raise MusicYTException(f"Something went wrong while searching YTMusic: {e}")
+            logger.warning(f"Something went wrong while searching YTMusic: {e}")
+            return None
 
         for result in results:
             if self._is_relevant_result(artist, song, result):
@@ -181,9 +181,15 @@ class MusicYT:
             The extracted music information.
         """
         if result["resultType"] in ["song", "video"]:
-            return self._get_song(result)
+            try:
+                return self._get_song(result)
+            except InvalidResponseException:
+                return None
         else:
-            return self._get_album(result)
+            try:
+                return self._get_album(result)
+            except InvalidResponseException:
+                return None
 
     def _get_song(self, result: dict) -> MusicInfo:
         """
@@ -200,7 +206,9 @@ class MusicYT:
             The extracted music information.
         """
         title = result.get("title")
-        artist_names = ", ".join([artist.get("name") for artist in result.get("artists", [])])
+        artist_names = ", ".join(
+            [artist.get("name") for artist in result.get("artists", [])]
+        )
         video_id = result.get("videoId")
         song_url = f"https://music.youtube.com/watch?v={video_id}"
         lyrics_id = self.ytmusic.get_watch_playlist(video_id)

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy/spotify.py

@@ -14,9 +14,7 @@ from dotenv import load_dotenv
 
 from yutipy.exceptions import (
     AuthenticationException,
-    InvalidResponseException,
     InvalidValueException,
-    NetworkException,
     SpotifyAuthException,
     SpotifyException,
 )
@@ -100,6 +98,13 @@ class Spotify:
                 self.__access_token = token_info.get("access_token")
                 self.__token_expires_in = token_info.get("expires_in")
                 self.__token_requested_at = token_info.get("requested_at")
+
+                try:
+                    self.save_access_token(token_info)
+                except NotImplementedError:
+                    logger.warning(
+                        "`save_access_token` is not implemented, falling back to in-memory storage. Access token will not be saved."
+                    )
         else:
             logger.warning(
                 "`defer_load` is set to `True`. Make sure to call `load_token_after_init()`."
@@ -144,6 +149,13 @@ class Spotify:
             self.__token_expires_in = token_info.get("expires_in")
             self.__token_requested_at = token_info.get("requested_at")
 
+            try:
+                self.save_access_token(token_info)
+            except NotImplementedError:
+                logger.warning(
+                    "`save_access_token` is not implemented, falling back to in-memory storage. Access token will not be saved."
+                )
+
     def __authorization_header(self) -> dict:
         """
         Generates the authorization header for Spotify API requests.
@@ -184,8 +196,8 @@ class Spotify:
             logger.debug(f"Authentication response status code: {response.status_code}")
             response.raise_for_status()
         except requests.RequestException as e:
-            logger.error(f"Network error during Spotify authentication: {e}")
-            raise NetworkException(f"Network error occurred: {e}")
+            logger.warning(f"Network error during Spotify authentication: {e}")
+            return None
 
         if response.status_code == 200:
             response_json = response.json()
@@ -198,19 +210,27 @@ class Spotify:
 
     def __refresh_access_token(self):
         """Refreshes the token if it has expired."""
-        if time() - self.__token_requested_at >= self.__token_expires_in:
-            token_info = self.__get_access_token()
+        try:
+            if time() - self.__token_requested_at >= self.__token_expires_in:
+                token_info = self.__get_access_token()
 
-            try:
-                self.save_access_token(token_info)
-            except NotImplementedError as e:
-                logger.warning(e)
+                try:
+                    self.save_access_token(token_info)
+                except NotImplementedError as e:
+                    logger.warning(e)
 
-            self.__access_token = token_info.get("access_token")
-            self.__token_expires_in = token_info.get("expires_in")
-            self.__token_requested_at = token_info.get("requested_at")
+                self.__access_token = token_info.get("access_token")
+                self.__token_expires_in = token_info.get("expires_in")
+                self.__token_requested_at = token_info.get("requested_at")
 
-        logger.info("The access token is still valid, no need to refresh.")
+            logger.info("The access token is still valid, no need to refresh.")
+        except TypeError:
+            logger.debug(
+                f"token requested at: {self.__token_requested_at} | token expires in: {self.__token_expires_in}"
+            )
+            logger.info(
+                "Something went wrong while trying to refresh the token. Set logging level to `DEBUG` to see the issue."
+            )
 
     def save_access_token(self, token_info: dict) -> None:
         """
@@ -321,7 +341,7 @@ class Spotify:
                 )
                 response.raise_for_status()
             except requests.RequestException as e:
-                raise NetworkException(f"Network error occurred: {e}")
+                return None
 
             if response.status_code != 200:
                 raise SpotifyException(f"Failed to search for music: {response.json()}")
@@ -388,7 +408,7 @@ class Spotify:
             )
             response.raise_for_status()
         except requests.RequestException as e:
-            raise NetworkException(f"Network error occurred: {e}")
+            return None
 
         if response.status_code != 200:
             raise SpotifyException(
@@ -421,7 +441,7 @@ class Spotify:
                 )
                 response.raise_for_status()
             except requests.RequestException as e:
-                raise NetworkException(f"Network error occurred: {e}")
+                return None
 
             if response.status_code != 200:
                 return None
@@ -800,15 +820,15 @@ class SpotifyAuth:
             logger.debug(f"Authentication response status code: {response.status_code}")
             response.raise_for_status()
         except requests.RequestException as e:
-            logger.error(f"Network error during Spotify authentication: {e}")
-            raise NetworkException(f"Network error occurred: {e}")
+            logger.warning(f"Network error during Spotify authentication: {e}")
+            return None
 
         if response.status_code == 200:
             response_json = response.json()
             response_json["requested_at"] = time()
             return response_json
         else:
-            raise InvalidResponseException(
+            raise AuthenticationException(
                 f"Invalid response received: {response.json()}"
             )
 
@@ -1036,11 +1056,11 @@ class SpotifyAuth:
             response = self.__session.get(query_url, headers=header, timeout=30)
             response.raise_for_status()
         except requests.RequestException as e:
-            logger.error(f"Failed to fetch user profile: {e}")
+            logger.warning(f"Failed to fetch user profile: {e}")
             return None
 
         if response.status_code != 200:
-            logger.error(f"Unexpected response: {response.json()}")
+            logger.warning(f"Unexpected response: {response.json()}")
             return None
 
         response_json = response.json()
@@ -1085,16 +1105,16 @@ class SpotifyAuth:
             response = self.__session.get(query_url, headers=header, timeout=30)
             response.raise_for_status()
         except requests.RequestException as e:
-            raise NetworkException(f"Network error occurred: {e}")
+            return None
 
         if response.status_code == 204:
             logger.info("Requested user is currently not listening to any music.")
             return None
         if response.status_code != 200:
             try:
-                logger.error(f"Unexpected response: {response.json()}")
+                logger.warning(f"Unexpected response: {response.json()}")
             except requests.exceptions.JSONDecodeError:
-                logger.error(
+                logger.warning(
                     f"Response Code: {response.status_code}, Reason: {response.reason}"
                 )
             return None
@@ -1108,6 +1128,8 @@ class SpotifyAuth:
                 guess,
                 use_translation=False,
             )
+            # Spotify returns timestamp in milliseconds, so convert milliseconds to seconds:
+            timestamp = response_json.get("timestamp") / 1000.0
             return UserPlaying(
                 album_art=result.get("album", {}).get("images", [])[0].get("url"),
                 album_title=result.get("album", {}).get("name"),
@@ -1124,6 +1146,7 @@ class SpotifyAuth:
                 lyrics=None,
                 release_date=result.get("album", {}).get("release_date"),
                 tempo=None,
+                timestamp=timestamp,
                 title=result.get("name"),
                 type=result.get("type"),
                 upc=result.get("external_ids", {}).get("upc"),

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy/yutipy_music.py

@@ -22,8 +22,23 @@ class YutipyMusic:
     Instead of calling each service separately, you can use this class to get the information from all services at once.
     """
 
-    def __init__(self) -> None:
-        """Initializes the YutipyMusic class."""
+    def __init__(
+    self,
+    custom_kkbox_class = KKBox,
+    custom_spotify_class = Spotify,
+) -> None:
+        """
+        Initializes the YutipyMusic class.
+
+        Parameters
+        ----------
+        custom_kkbox_class : Optional[type], optional
+            A custom class inherited from ``KKBox`` to override the default KKBox implementation.
+            This class should implement ``load_access_token()`` and ``save_access_token()`` methods. Default is ``KKBox``.
+        custom_spotify_class : Optional[type], optional
+            A custom class inherited from ``Spotify`` to override the default Spotify implementation.
+            This class should implement ``load_access_token()`` and ``save_access_token()`` methods. Default is ``Spotify``.
+        """
         self.music_info = MusicInfos()
         self.normalize_non_english = True
         self.album_art_priority = ["deezer", "ytmusic", "itunes"]
@@ -34,8 +49,8 @@ class YutipyMusic:
         }
 
         try:
-            self.services["kkbox"] = KKBox()
-        except (KKBoxException) as e:
+            self.services["kkbox"] = custom_kkbox_class()
+        except KKBoxException as e:
             logger.warning(
                 f"{self.__class__.__name__}: Skipping KKBox due to KKBoxException: {e}"
             )
@@ -44,8 +59,8 @@ class YutipyMusic:
             self.album_art_priority.insert(idx, "kkbox")
 
         try:
-            self.services["spotify"] = Spotify()
-        except (SpotifyException) as e:
+            self.services["spotify"] = custom_spotify_class()
+        except SpotifyException as e:
             logger.warning(
                 f"{self.__class__.__name__}: Skipping Spotify due to SpotifyException: {e}"
             )
@@ -114,7 +129,7 @@ class YutipyMusic:
                     result = future.result()
                     self._combine_results(result, service_name)
                 except Exception as e:
-                    logger.error(
+                    logger.warning(
                         f"Error occurred while searching with {service_name}: {e}"
                     )
 

{yutipy-2.2.2 → yutipy-2.2.4}/yutipy.egg-info/PKG-INFO

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