yutipy 2.3.0__tar.gz → 2.3.1__tar.gz

{yutipy-2.3.0 → yutipy-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 2.3.0
+Version: 2.3.1
 Summary: A simple Python package to interact with various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>

{yutipy-2.3.0 → yutipy-2.3.1}/docs/api_reference.rst

@@ -30,7 +30,7 @@ KKBox
     :members:
     :inherited-members:
     :noindex:
-    :exclude-members: is_session_closed
+    :exclude-members: is_session_closed, SERVICE_NAME, ACCESS_TOKEN_URL
 
 Lastfm
 ------
@@ -57,13 +57,13 @@ Spotify
     :members:
     :inherited-members:
     :noindex:
-    :exclude-members: is_session_closed
+    :exclude-members: is_session_closed, SERVICE_NAME, ACCESS_TOKEN_URL
 
 .. autoclass:: yutipy.spotify.SpotifyAuth
     :members:
     :inherited-members:
     :noindex:
-    :exclude-members: is_session_closed
+    :exclude-members: is_session_closed, SERVICE_NAME, ACCESS_TOKEN_URL, USER_AUTH_URL
 
 YouTube Music
 -------------

{yutipy-2.3.0 → yutipy-2.3.1}/docs/conf.py

@@ -35,6 +35,7 @@ autodoc_default_options = {
     "inherited-members": True,
     "show-inheritance": True,
 }
+autoclass_content = "both"
 
 # sphinx-copybutton optional configurations
 copybutton_prompt_text = r">>> |\.\.\. "

{yutipy-2.3.0 → yutipy-2.3.1}/yutipy/base_clients.py

@@ -409,11 +409,6 @@ class BaseAuthClient:
 
     def _refresh_access_token(self):
         """Refreshes the token if it has expired."""
-        try:
-            self.load_token_after_init()
-        except NotImplementedError as e:
-            logger.warning(e)
-
         if not self._access_token or not self._refresh_token:
             logger.warning(
                 "No access token or refresh token found. You must authenticate to obtain a new token."

{yutipy-2.3.0 → yutipy-2.3.1}/yutipy/deezer.py

@@ -15,11 +15,17 @@ from yutipy.lrclib import LrcLib
 class Deezer:
     """A class to interact with the Deezer API."""
 
-    def __init__(self) -> None:
-        """Initializes the Deezer class and sets up the session."""
+    def __init__(self, fetch_lyrics: bool = True) -> None:
+        """
+        Parameters
+        ----------
+        fetch_lyrics : bool, optional
+            Whether to fetch lyrics (using `LRCLIB <https://lrclib.net>`__) if the music platform does not provide lyrics (default is True).
+        """
         self.api_url = "https://api.deezer.com"
         self._is_session_closed = False
         self.normalize_non_english = True
+        self.fetch_lyrics = fetch_lyrics
         self.__session = requests.Session()
         self._translation_session = requests.Session()
 
@@ -304,12 +310,13 @@ class Deezer:
             music_info.release_date = album_info.get("release_date")
             music_info.genre = album_info.get("genre")
 
-        with LrcLib() as lrc_lib:
-            lyrics = lrc_lib.get_lyrics(
-                artist=music_info.artists, song=music_info.title
-            )
-        if lyrics:
-            music_info.lyrics = lyrics.get("plainLyrics")
+        if self.fetch_lyrics:
+            with LrcLib() as lrc_lib:
+                lyrics = lrc_lib.get_lyrics(
+                    artist=music_info.artists, song=music_info.title
+                )
+            if lyrics:
+                music_info.lyrics = lyrics.get("plainLyrics")
 
         return music_info
 

{yutipy-2.3.0 → yutipy-2.3.1}/yutipy/itunes.py

@@ -8,19 +8,30 @@ import requests
 
 from yutipy.exceptions import InvalidValueException, ItunesException
 from yutipy.logger import logger
-from yutipy.models import MusicInfo
-from yutipy.utils.helpers import are_strings_similar, guess_album_type, is_valid_string, separate_artists
 from yutipy.lrclib import LrcLib
+from yutipy.models import MusicInfo
+from yutipy.utils.helpers import (
+    are_strings_similar,
+    guess_album_type,
+    is_valid_string,
+    separate_artists,
+)
 
 
 class Itunes:
     """A class to interact with the iTunes API."""
 
-    def __init__(self) -> None:
-        """Initializes the iTunes class and sets up the session."""
+    def __init__(self, fetch_lyrics: bool = True) -> None:
+        """
+        Parameters
+        ----------
+        fetch_lyrics : bool, optional
+            Whether to fetch lyrics (using `LRCLIB <https://lrclib.net>`__) if the music platform does not provide lyrics (default is True).
+        """
         self.api_url = "https://itunes.apple.com"
         self.normalize_non_english = True
         self._is_session_closed = False
+        self.fetch_lyrics = fetch_lyrics
         self.__session = requests.Session()
         self.__translation_session = requests.Session()
 
@@ -169,12 +180,13 @@ class Itunes:
                 url=result.get("trackViewUrl", result["collectionViewUrl"]),
             )
 
-            with LrcLib() as lrc_lib:
-                lyrics = lrc_lib.get_lyrics(
-                    artist=music_info.artists, song=music_info.title
-                )
-            if lyrics:
-                music_info.lyrics = lyrics.get("plainLyrics")
+            if self.fetch_lyrics:
+                with LrcLib() as lrc_lib:
+                    lyrics = lrc_lib.get_lyrics(
+                        artist=music_info.artists, song=music_info.title
+                    )
+                if lyrics:
+                    music_info.lyrics = lyrics.get("plainLyrics")
 
             return music_info
         return None

{yutipy-2.3.0 → yutipy-2.3.1}/yutipy/kkbox.py

@@ -11,9 +11,9 @@ from dotenv import load_dotenv
 from yutipy.base_clients import BaseClient
 from yutipy.exceptions import InvalidValueException, KKBoxException
 from yutipy.logger import logger
+from yutipy.lrclib import LrcLib
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import are_strings_similar, is_valid_string
-from yutipy.lrclib import LrcLib
 
 load_dotenv()
 
@@ -30,11 +30,13 @@ class KKBox(BaseClient):
     """
 
     def __init__(
-        self, client_id: str = None, client_secret: str = None, defer_load: bool = False
+        self,
+        client_id: str = None,
+        client_secret: str = None,
+        defer_load: bool = False,
+        fetch_lyrics: bool = True,
     ) -> None:
         """
-        Initializes the KKBox class and sets up the session.
-
         Parameters
         ----------
         client_id : str, optional
@@ -43,9 +45,12 @@ class KKBox(BaseClient):
             The Client secret for the KKBOX Open API. Defaults to ``KKBOX_CLIENT_SECRET`` from .env file.
         defer_load : bool, optional
             Whether to defer loading the access token during initialization. Default is ``False``.
+        fetch_lyrics : bool, optional
+            Whether to fetch lyrics (using `LRCLIB <https://lrclib.net>`__) if the music platform does not provide lyrics (default is True).
         """
         self.client_id = client_id or KKBOX_CLIENT_ID
         self.client_secret = client_secret or KKBOX_CLIENT_SECRET
+        self.fetch_lyrics = fetch_lyrics
 
         if not self.client_id:
             raise KKBoxException(
@@ -274,12 +279,13 @@ class KKBox(BaseClient):
                 url=track.get("url"),
             )
 
-            with LrcLib() as lrc_lib:
-                lyrics = lrc_lib.get_lyrics(
-                    artist=music_info.artists, song=music_info.title
-                )
-            if lyrics:
-                music_info.lyrics = lyrics.get("plainLyrics")
+            if self.fetch_lyrics:
+                with LrcLib() as lrc_lib:
+                    lyrics = lrc_lib.get_lyrics(
+                        artist=music_info.artists, song=music_info.title
+                    )
+                if lyrics:
+                    music_info.lyrics = lyrics.get("plainLyrics")
             return music_info
         return None
 

{yutipy-2.3.0 → yutipy-2.3.1}/yutipy/lastfm.py

@@ -1,8 +1,8 @@
 __all__ = ["LastFm", "LastFmException"]
 
 import os
-from time import time
 from pprint import pprint
+from time import time
 from typing import Optional
 
 import requests
@@ -28,12 +28,6 @@ class LastFm:
 
     def __init__(self, api_key: str = None):
         """
-        Initializes the LastFm class.
-
-        Args:
-            lastfm_api_key (str, optional): The Last.fm API key. If not provided,
-                it will be fetched from the environment variable `LASTFM_API_KEY`.
-
         Parameters
         ----------
         lastfm_api_key : str, optional
@@ -141,7 +135,9 @@ class LastFm:
         response_json = response.json()
         result = response_json.get("recenttracks", {}).get("track", [])[0]
         is_playing = result.get("@attr", {}).get("nowplaying", False)
-        is_playing = True if isinstance(is_playing, str) and is_playing == "true" else False
+        is_playing = (
+            True if isinstance(is_playing, str) and is_playing == "true" else False
+        )
         if result and is_playing:
             album_art = [
                 img.get("#text")

{yutipy-2.3.0 → yutipy-2.3.1}/yutipy/lrclib.py

@@ -21,8 +21,7 @@ class LrcLib:
         app_version: str = None,
         app_url: str = "https://github.com/CheapNightbot/yutipy",
     ) -> None:
-        """Initializes the LrcLib with the API URL and application details.
-
+        """
         Parameters
         ----------
         app_name : str
@@ -135,14 +134,13 @@ class LrcLib:
                 use_translation=normalize_non_english,
                 translation_session=self._translation_session,
             ):
-                if album:
-                    if not are_strings_similar(
-                        result.get("albumName"),
-                        album,
-                        use_translation=normalize_non_english,
-                        translation_session=self._translation_session,
-                    ):
-                        continue
+                if album and not are_strings_similar(
+                    result.get("albumName"),
+                    album,
+                    use_translation=normalize_non_english,
+                    translation_session=self._translation_session,
+                ):
+                    continue
                 return result
         return None
 

{yutipy-2.3.0 → yutipy-2.3.1}/yutipy/musicyt.py

@@ -20,12 +20,18 @@ from yutipy.lrclib import LrcLib
 class MusicYT:
     """A class to interact with the YouTube Music API."""
 
-    def __init__(self) -> None:
-        """Initializes the YouTube Music class and sets up the session."""
+    def __init__(self, fetch_lyrics: bool = True) -> None:
+        """
+        Parameters
+        ----------
+        fetch_lyrics : bool, optional
+            Whether to fetch lyrics (using `LRCLIB <https://lrclib.net>`__) if the music platform does not provide lyrics (default is True).
+        """
         self.ytmusic = YTMusic()
         self._is_session_closed = False
         self.normalize_non_english = True
         self.__translation_session = requests.Session()
+        self.fetch_lyrics = fetch_lyrics
 
     def __enter__(self) -> "MusicYT":
         """Enters the runtime context related to this object."""
@@ -248,7 +254,7 @@ class MusicYT:
             url=song_url,
         )
 
-        if not music_info.lyrics:
+        if not music_info.lyrics and self.fetch_lyrics:
             with LrcLib() as lrc_lib:
                 lyrics = lrc_lib.get_lyrics(
                     artist=music_info.artists, song=music_info.title

{yutipy-2.3.0 → yutipy-2.3.1}/yutipy/spotify.py

@@ -15,6 +15,7 @@ from yutipy.exceptions import (
     SpotifyException,
 )
 from yutipy.logger import logger
+from yutipy.lrclib import LrcLib
 from yutipy.models import MusicInfo, UserPlaying
 from yutipy.utils.helpers import (
     are_strings_similar,
@@ -22,7 +23,6 @@ from yutipy.utils.helpers import (
     is_valid_string,
     separate_artists,
 )
-from yutipy.lrclib import LrcLib
 
 load_dotenv()
 
@@ -40,11 +40,13 @@ class Spotify(BaseClient):
     """
 
     def __init__(
-        self, client_id: str = None, client_secret: str = None, defer_load: bool = False
+        self,
+        client_id: str = None,
+        client_secret: str = None,
+        defer_load: bool = False,
+        fetch_lyrics: bool = True,
     ) -> None:
         """
-        Initializes the Spotify class (using Client Credentials grant type/flow) and sets up the session.
-
         Parameters
         ----------
         client_id : str, optional
@@ -53,9 +55,12 @@ class Spotify(BaseClient):
             The Client secret for the Spotify API. Defaults to ``SPOTIFY_CLIENT_SECRET`` from environment variable or the ``.env`` file.
         defer_load : bool, optional
             Whether to defer loading the access token during initialization, by default ``False``
+        fetch_lyrics : bool, optional
+            Whether to fetch lyrics (using `LRCLIB <https://lrclib.net>`__) if the music platform does not provide lyrics (default is True).
         """
         self.client_id = client_id or SPOTIFY_CLIENT_ID
         self.client_secret = client_secret or SPOTIFY_CLIENT_SECRET
+        self.fetch_lyrics = fetch_lyrics
 
         if not self.client_id:
             raise SpotifyException(
@@ -344,12 +349,13 @@ class Spotify(BaseClient):
                 url=track["external_urls"]["spotify"],
             )
 
-            with LrcLib() as lrc_lib:
-                lyrics = lrc_lib.get_lyrics(
-                    artist=music_info.artists, song=music_info.title
-                )
-            if lyrics:
-                music_info.lyrics = lyrics.get("plainLyrics")
+            if self.fetch_lyrics:
+                with LrcLib() as lrc_lib:
+                    lyrics = lrc_lib.get_lyrics(
+                        artist=music_info.artists, song=music_info.title
+                    )
+                if lyrics:
+                    music_info.lyrics = lyrics.get("plainLyrics")
             return music_info
         return None
 
@@ -438,10 +444,9 @@ class SpotifyAuth(BaseAuthClient):
         redirect_uri: str = None,
         scopes: list[str] = None,
         defer_load: bool = False,
+        fetch_lyrics: bool = True,
     ):
         """
-        Initializes the SpotifyAuth class (using Authorization Code grant type/flow) and sets up the session.
-
         Parameters
         ----------
         client_id : str, optional
@@ -454,11 +459,14 @@ class SpotifyAuth(BaseAuthClient):
             A list of scopes for the Spotify API. For example: `['user-read-email', 'user-read-private']`.
         defer_load : bool, optional
             Whether to defer loading the access token during initialization. Default is ``False``.
+        fetch_lyrics : bool, optional
+            Whether to fetch lyrics using `LRCLIB <https://lrclib.net>`__ if the music platform does not provide lyrics (default is True).
         """
         self.client_id = client_id or os.getenv("SPOTIFY_CLIENT_ID")
         self.client_secret = client_secret or os.getenv("SPOTIFY_CLIENT_SECRET")
         self.redirect_uri = redirect_uri or os.getenv("SPOTIFY_REDIRECT_URI")
         self.scopes = scopes
+        self.fetch_lyrics = fetch_lyrics
 
         if not self.client_id:
             raise SpotifyAuthException(
@@ -600,12 +608,13 @@ class SpotifyAuth(BaseAuthClient):
                 url=result.get("external_urls", {}).get("spotify"),
             )
 
-            with LrcLib() as lrc_lib:
-                lyrics = lrc_lib.get_lyrics(
-                    artist=user_playing.artists, song=user_playing.title
-                )
-            if lyrics:
-                user_playing.lyrics = lyrics.get("plainLyrics")
+            if self.fetch_lyrics:
+                with LrcLib() as lrc_lib:
+                    lyrics = lrc_lib.get_lyrics(
+                        artist=user_playing.artists, song=user_playing.title
+                    )
+                if lyrics:
+                    user_playing.lyrics = lyrics.get("plainLyrics")
             return user_playing
         return None
 

{yutipy-2.3.0 → yutipy-2.3.1}/yutipy/yutipy_music.py

@@ -8,11 +8,12 @@ from yutipy.deezer import Deezer
 from yutipy.exceptions import InvalidValueException, KKBoxException, SpotifyException
 from yutipy.itunes import Itunes
 from yutipy.kkbox import KKBox
+from yutipy.logger import logger
+from yutipy.lrclib import LrcLib
 from yutipy.models import MusicInfo, MusicInfos
 from yutipy.musicyt import MusicYT
 from yutipy.spotify import Spotify
 from yutipy.utils.helpers import is_valid_string
-from yutipy.logger import logger
 
 
 class YutipyMusic:
@@ -28,8 +29,6 @@ class YutipyMusic:
         custom_spotify_class=Spotify,
     ) -> None:
         """
-        Initializes the YutipyMusic class.
-
         Parameters
         ----------
         custom_kkbox_class : Optional[type], optional
@@ -43,13 +42,15 @@ class YutipyMusic:
         self.normalize_non_english = True
         self.album_art_priority = ["deezer", "ytmusic", "itunes"]
         self.services = {
-            "deezer": Deezer(),
-            "itunes": Itunes(),
-            "ytmusic": MusicYT(),
+            "deezer": Deezer(fetch_lyrics=False),
+            "itunes": Itunes(fetch_lyrics=False),
+            "ytmusic": MusicYT(fetch_lyrics=False),
         }
 
         try:
-            self.services["kkbox"] = custom_kkbox_class()
+            self.services["kkbox"] = custom_kkbox_class(
+                defer_load=True, fetch_lyrics=False
+            )
         except KKBoxException as e:
             logger.warning(
                 f"{self.__class__.__name__}: Skipping KKBox due to KKBoxException: {e}"
@@ -59,7 +60,9 @@ class YutipyMusic:
             self.album_art_priority.insert(idx, "kkbox")
 
         try:
-            self.services["spotify"] = custom_spotify_class()
+            self.services["spotify"] = custom_spotify_class(
+                defer_load=True, fetch_lyrics=False
+            )
         except SpotifyException as e:
             logger.warning(
                 f"{self.__class__.__name__}: Skipping Spotify due to SpotifyException: {e}"
@@ -134,11 +137,18 @@ class YutipyMusic:
                     )
 
         if len(self.music_info.url) == 0:
-            logger.warning(
+            logger.info(
                 f"No matching results found across all platforms for artist='{artist}' and song='{song}'"
             )
             return None
 
+        # Fetch lyrics only once using LrcLib if not already present
+        if not self.music_info.lyrics:
+            with LrcLib() as lrc_lib:
+                lyrics_result = lrc_lib.get_lyrics(artist, song)
+            if lyrics_result:
+                self.music_info.lyrics = lyrics_result.get("plainLyrics")
+
         return self.music_info
 
     def _combine_results(self, result: Optional[MusicInfo], service_name: str) -> None:
@@ -199,10 +209,10 @@ class YutipyMusic:
 
 if __name__ == "__main__":
     import logging
-    from yutipy.logger import enable_logging
-
     from dataclasses import asdict
 
+    from yutipy.logger import enable_logging
+
     enable_logging(level=logging.DEBUG)
     yutipy_music = YutipyMusic()
 

{yutipy-2.3.0 → yutipy-2.3.1}/yutipy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 2.3.0
+Version: 2.3.1
 Summary: A simple Python package to interact with various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>