yutipy 1.3.1__tar.gz → 1.4.0__tar.gz

yutipy-1.4.0/.github/release-drafter.yml

@@ -0,0 +1,16 @@
+name-template: 'v$NEXT_PATCH_VERSION'
+tag-template: 'v$NEXT_PATCH_VERSION'
+categories:
+  - title: '🚀 New Features'
+    label: 'feature'
+  - title: '🐛 Bug Fixes'
+    label: 'bug'
+  - title: '🧰 Maintenance'
+    label: 'maintenance'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+template: |
+  ## What's Changed
+
+  $CHANGES
+
+  **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...$NEW_TAG

{yutipy-1.3.1 → yutipy-1.4.0}/.github/workflows/release.yml

@@ -1,6 +1,9 @@
-name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+name: Publish Python 🐍 distribution 📦 to PyPI
 
-on: push
+on:
+  push:
+    tags:
+      - '*'
 
 jobs:
   build:
@@ -51,12 +54,25 @@ jobs:
         path: dist/
     - name: Publish distribution 📦 to PyPI
       uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
+  draft-release:
+    name: Draft Release Notes
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    needs:
+    - publish-to-pypi
+    steps:
+    - name: Draft Release Notes
+      uses: release-drafter/release-drafter@b1476f6e6eb133afa41ed8589daba6dc69b4d3f5 # v6.1.0
+      with:
+        config-name: .github/release-drafter.yml
   github-release:
     name: >-
       Sign the Python 🐍 distribution 📦 with Sigstore
       and upload them to GitHub Release
     needs:
     - publish-to-pypi
+    - draft-release
     runs-on: ubuntu-latest
 
     permissions:
@@ -82,7 +98,7 @@ jobs:
         gh release create
         "$GITHUB_REF_NAME"
         --repo "$GITHUB_REPOSITORY"
-        --notes ""
+        --notes-file .github/release-drafter.yml
         --generate-notes
     - name: Upload artifact signatures to GitHub Release
       env:

{yutipy-1.3.1 → yutipy-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 1.3.1
+Version: 1.4.0
 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.1 → yutipy-1.4.0}/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.1 → yutipy-1.4.0}/tests/test_deezer.py

@@ -21,6 +21,13 @@ def test_search_invalid(deezer):
     assert result is None
 
 
+def test_search_translation_matching(deezer):
+    result = deezer.search("Porter Robinson", "Shelter", normalize_non_english=False)
+    assert result.id != 1355346522
+    result = deezer.search("Porter Robinson", "Shelter", normalize_non_english=True)
+    assert result.id == 1355346522 or 2404408865
+
+
 def test_get_upc_isrc_track(deezer):
     track_id = 781592622
     result = deezer._get_upc_isrc(track_id, "track")

{yutipy-1.3.1 → yutipy-1.4.0}/tests/test_musicyt.py

@@ -49,3 +49,8 @@ def test_search_empty_song(music_yt):
 
     with raises(InvalidValueException):
         music_yt.search(artist, song)
+
+
+def test_close_session(music_yt):
+    music_yt.close_session()
+    assert music_yt.is_session_closed

{yutipy-1.3.1 → yutipy-1.4.0}/tests/test_utils.py

@@ -7,10 +7,17 @@ def test_are_strings_similar():
     assert are_strings_similar("Hello World", "Hello") is True
 
 
+def test_are_strings_similar_translation():
+    assert are_strings_similar("ポーター", "Porter") is True
+
+
 def test_separate_artists():
     assert separate_artists("Artist A & Artist B") == ["Artist A", "Artist B"]
     assert separate_artists("Artist A ft. Artist B") == ["Artist A", "Artist B"]
     assert separate_artists("Artist A") == ["Artist A"]
     assert separate_artists("Artist A and Artist B") == ["Artist A", "Artist B"]
     assert separate_artists("Artist A / Artist B") == ["Artist A", "Artist B"]
-    assert separate_artists("Artist A, Artist B", custom_separator=",") == ["Artist A", "Artist B"]
+    assert separate_artists("Artist A, Artist B", custom_separator=",") == [
+        "Artist A",
+        "Artist B",
+    ]

yutipy-1.4.0/tests/test_yutipy_music.py

@@ -0,0 +1,48 @@
+import pytest
+from yutipy.yutipy_music import YutipyMusic
+from yutipy.models import MusicInfos
+from yutipy.exceptions import InvalidValueException
+
+
+@pytest.fixture
+def yutipy_music():
+    return YutipyMusic()
+
+
+def test_search_valid(yutipy_music):
+    artist = "Adele"
+    song = "Hello"
+    result = yutipy_music.search(artist, song)
+    assert result is not None
+    assert isinstance(result, MusicInfos)
+    assert "Hello" in result.title
+    assert "Adele" in result.artists
+
+
+def test_search_invalid(yutipy_music):
+    artist = "Nonexistent Artist"
+    song = "Nonexistent Song"
+    result = yutipy_music.search(artist, song)
+    assert result is None
+
+
+def test_search_empty_artist(yutipy_music):
+    artist = ""
+    song = "Hello"
+
+    with pytest.raises(InvalidValueException):
+        yutipy_music.search(artist, song)
+
+
+def test_search_empty_song(yutipy_music):
+    artist = "Adele"
+    song = ""
+
+    with pytest.raises(InvalidValueException):
+        yutipy_music.search(artist, song)
+
+
+def test_close_sessions(yutipy_music):
+    yutipy_music.close_sessions()
+    for service in yutipy_music.services.values():
+        assert service.is_session_closed

{yutipy-1.3.1 → yutipy-1.4.0}/yutipy/deezer.py

@@ -21,6 +21,8 @@ class Deezer:
         self._session = requests.Session()
         self.api_url = "https://api.deezer.com"
         self._is_session_closed = False
+        self.normalize_non_english = True
+        self._translation_session = requests.Session()
 
     def __enter__(self) -> "Deezer":
         """Enters the runtime context related to this object."""
@@ -34,6 +36,7 @@ class Deezer:
         """Closes the current session."""
         if not self.is_session_closed:
             self._session.close()
+            self._translation_session.close()
             self._is_session_closed = True
 
     @property
@@ -41,7 +44,13 @@ 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,
+        normalize_non_english: bool = True,
+    ) -> Optional[MusicInfo]:
         """
         Searches for a song by artist and title.
 
@@ -51,6 +60,11 @@ 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``.
+        normalize_non_english : bool, optional
+            Whether to normalize non-English characters for comparison. Default is ``True``.
+
 
         Returns
         -------
@@ -62,11 +76,13 @@ class Deezer:
                 "Artist and song names must be valid strings and can't be empty."
             )
 
+        self.normalize_non_english = normalize_non_english
+
         search_types = ["track", "album"]
 
         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:
@@ -205,8 +221,18 @@ class Deezer:
         """
         for result in results:
             if not (
-                are_strings_similar(result["title"], song)
-                and are_strings_similar(result["artist"]["name"], artist)
+                are_strings_similar(
+                    result["title"],
+                    song,
+                    use_translation=self.normalize_non_english,
+                    translation_session=self._translation_session,
+                )
+                and are_strings_similar(
+                    result["artist"]["name"],
+                    artist,
+                    use_translation=self.normalize_non_english,
+                    translation_session=self._translation_session,
+                )
             ):
                 continue
 

{yutipy-1.3.1 → yutipy-1.4.0}/yutipy/itunes.py

@@ -22,6 +22,8 @@ class Itunes:
         self._session = requests.Session()
         self.api_url = "https://itunes.apple.com"
         self._is_session_closed = False
+        self.normalize_non_english = True
+        self._translation_session = requests.Session()
 
     def __enter__(self) -> "Itunes":
         """Enters the runtime context related to this object."""
@@ -35,6 +37,7 @@ class Itunes:
         """Closes the current session."""
         if not self.is_session_closed:
             self._session.close()
+            self._translation_session.close()
             self._is_session_closed = True
 
     @property
@@ -42,7 +45,13 @@ 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,
+        normalize_non_english: bool = True,
+    ) -> Optional[MusicInfo]:
         """
         Searches for a song by artist and title.
 
@@ -52,6 +61,10 @@ 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``.
+        normalize_non_english : bool, optional
+            Whether to normalize non-English characters for comparison. Default is ``True``.
 
         Returns
         -------
@@ -63,10 +76,12 @@ class Itunes:
                 "Artist and song names must be valid strings and can't be empty."
             )
 
+        self.normalize_non_english = normalize_non_english
+
         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:
@@ -111,9 +126,17 @@ class Itunes:
         for result in results:
             if not (
                 are_strings_similar(
-                    result.get("trackName", result["collectionName"]), song
+                    result.get("trackName", result["collectionName"]),
+                    song,
+                    use_translation=self.normalize_non_english,
+                    translation_session=self._translation_session,
+                )
+                and are_strings_similar(
+                    result["artistName"],
+                    artist,
+                    use_translation=self.normalize_non_english,
+                    translation_session=self._translation_session,
                 )
-                and are_strings_similar(result["artistName"], artist)
             ):
                 continue
 

{yutipy-1.3.1 → yutipy-1.4.0}/yutipy/kkbox.py

@@ -57,6 +57,8 @@ class KKBox:
         self.__start_time = time.time()
         self._is_session_closed = False
         self.valid_territories = ["HK", "JP", "MY", "SG", "TW"]
+        self.normalize_non_english = True
+        self._translation_session = requests.Session()
 
     def __enter__(self):
         """Enters the runtime context related to this object."""
@@ -70,6 +72,7 @@ class KKBox:
         """Closes the current session."""
         if not self.is_session_closed:
             self._session.close()
+            self._translation_session.close()
             self._is_session_closed = True
 
     @property
@@ -134,7 +137,12 @@ 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,
+        normalize_non_english: bool = True,
     ) -> Optional[MusicInfo]:
         """
         Searches for a song by artist and title.
@@ -148,6 +156,10 @@ 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``.
+        normalize_non_english : bool, optional
+            Whether to normalize non-English characters for comparison. Default is ``True``.
 
         Returns
         -------
@@ -159,9 +171,13 @@ class KKBox:
                 "Artist and song names must be valid strings and can't be empty."
             )
 
+        self.normalize_non_english = normalize_non_english
+
         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:
@@ -285,12 +301,24 @@ class KKBox:
         Optional[MusicInfo]
             The music information if found, otherwise None.
         """
-        if not are_strings_similar(track["name"], song):
+        if not are_strings_similar(
+            track["name"],
+            song,
+            use_translation=self.normalize_non_english,
+            translation_session=self._translation_session,
+        ):
             return None
 
         artists_name = track["album"]["artist"]["name"]
         matching_artists = (
-            artists_name if are_strings_similar(artists_name, artist) else None
+            artists_name
+            if are_strings_similar(
+                artists_name,
+                artist,
+                use_translation=self.normalize_non_english,
+                translation_session=self._translation_session,
+            )
+            else None
         )
 
         if matching_artists:
@@ -333,12 +361,24 @@ class KKBox:
         Optional[MusicInfo]
             The music information if found, otherwise None.
         """
-        if not are_strings_similar(album["name"], song):
+        if not are_strings_similar(
+            album["name"],
+            song,
+            use_translation=self.normalize_non_english,
+            translation_session=self._translation_session,
+        ):
             return None
 
         artists_name = album["artist"]["name"]
         matching_artists = (
-            artists_name if are_strings_similar(artists_name, artist) else None
+            artists_name
+            if are_strings_similar(
+                artists_name,
+                artist,
+                use_translation=self.normalize_non_english,
+                translation_session=self._translation_session,
+            )
+            else None
         )
 
         if matching_artists:

{yutipy-1.3.1 → yutipy-1.4.0}/yutipy/musicyt.py

@@ -2,6 +2,7 @@ import os
 from pprint import pprint
 from typing import Optional
 
+import requests
 from ytmusicapi import YTMusic, exceptions
 
 from yutipy.exceptions import (
@@ -19,8 +20,28 @@ class MusicYT:
     def __init__(self) -> None:
         """Initializes the YouTube Music class and sets up the session."""
         self.ytmusic = YTMusic()
-
-    def search(self, artist: str, song: str) -> Optional[MusicInfo]:
+        self._is_session_closed = False
+        self.normalize_non_english = True
+        self._translation_session = requests.Session()
+
+    def close_session(self) -> None:
+        """Closes the current session(s)."""
+        if not self.is_session_closed:
+            self._translation_session.close()
+            self._is_session_closed = True
+
+    @property
+    def is_session_closed(self) -> bool:
+        """Checks if the session is closed."""
+        return self._is_session_closed
+
+    def search(
+        self,
+        artist: str,
+        song: str,
+        limit: int = 10,
+        normalize_non_english: bool = True,
+    ) -> Optional[MusicInfo]:
         """
         Searches for a song by artist and title.
 
@@ -30,6 +51,10 @@ 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``.
+        normalize_non_english : bool, optional
+            Whether to normalize non-English characters for comparison. Default is ``True``.
 
         Returns
         -------
@@ -41,10 +66,12 @@ class MusicYT:
                 "Artist and song names must be valid strings and can't be empty."
             )
 
+        self.normalize_non_english = normalize_non_english
+
         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}")
 
@@ -76,8 +103,18 @@ class MusicYT:
             return False
 
         return any(
-            are_strings_similar(result.get("title"), song)
-            and are_strings_similar(_artist.get("name"), artist)
+            are_strings_similar(
+                result.get("title"),
+                song,
+                use_translation=self.normalize_non_english,
+                translation_session=self._translation_session,
+            )
+            and are_strings_similar(
+                _artist.get("name"),
+                artist,
+                use_translation=self.normalize_non_english,
+                translation_session=self._translation_session,
+            )
             for _artist in result.get("artists", [])
         )
 

{yutipy-1.3.1 → yutipy-1.4.0}/yutipy/spotify.py

@@ -62,6 +62,8 @@ class Spotify:
         self.__header, self.__expires_in = self.__authenticate()
         self.__start_time = time.time()
         self._is_session_closed = False
+        self.normalize_non_english = True
+        self._translation_session = requests.Session()
 
     def __enter__(self):
         """Enters the runtime context related to this object."""
@@ -72,9 +74,10 @@ class Spotify:
         self.close_session()
 
     def close_session(self) -> None:
-        """Closes the current session."""
+        """Closes the current session(s)."""
         if not self.is_session_closed:
             self._session.close()
+            self._translation_session.close()
             self._is_session_closed = True
 
     @property
@@ -138,7 +141,13 @@ 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,
+        normalize_non_english: bool = True,
+    ) -> Optional[MusicInfo]:
         """
         Searches for a song by artist and title.
 
@@ -148,6 +157,10 @@ 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``.
+        normalize_non_english : bool, optional
+            Whether to normalize non-English characters for comparison. Default is ``True``.
 
         Returns
         -------
@@ -159,10 +172,12 @@ class Spotify:
                 "Artist and song names must be valid strings and can't be empty."
             )
 
+        self.normalize_non_english = normalize_non_english
+
         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:
@@ -192,7 +207,13 @@ class Spotify:
         return music_info
 
     def search_advanced(
-        self, artist: str, song: str, isrc: str = None, upc: str = None
+        self,
+        artist: str,
+        song: str,
+        isrc: str = None,
+        upc: str = None,
+        limit: int = 1,
+        normalize_non_english: bool = True,
     ) -> Optional[MusicInfo]:
         """
         Searches for a song by artist, title, ISRC, or UPC.
@@ -207,6 +228,10 @@ class Spotify:
             The ISRC of the track.
         upc : str, optional
             The UPC of the album.
+        limit: int, optional
+            The number of items to retrieve from API. ``limit >=1 and <= 50``. Default is ``1``.
+        normalize_non_english : bool, optional
+            Whether to normalize non-English characters for comparison. Default is ``True``.
 
         Returns
         -------
@@ -218,12 +243,14 @@ class Spotify:
                 "Artist and song names must be valid strings and can't be empty."
             )
 
+        self.normalize_non_english = normalize_non_english
+
         self.__refresh_token_if_expired()
 
         if isrc:
-            query = f"?q={artist} {song} isrc:{isrc}&type=track&limit=1"
+            query = f"?q={artist} {song} isrc:{isrc}&type=track&limit={limit}"
         elif upc:
-            query = f"?q={artist} {song} upc:{upc}&type=album&limit=1"
+            query = f"?q={artist} {song} upc:{upc}&type=album&limit={limit}"
         else:
             raise InvalidValueException("ISRC or UPC must be provided.")
 
@@ -337,14 +364,25 @@ class Spotify:
         Optional[MusicInfo]
             The music information if found, otherwise None.
         """
-        if not are_strings_similar(track["name"], song):
+        if not are_strings_similar(
+            track["name"],
+            song,
+            use_translation=self.normalize_non_english,
+            translation_session=self._translation_session,
+        ):
             return None
 
         artists_name = [x["name"] for x in track["artists"]]
         matching_artists = [
             x["name"]
             for x in track["artists"]
-            if are_strings_similar(x["name"], artist) or x["id"] in artist_ids
+            if are_strings_similar(
+                x["name"],
+                artist,
+                use_translation=self.normalize_non_english,
+                translation_session=self._translation_session,
+            )
+            or x["id"] in artist_ids
         ]
 
         if matching_artists:
@@ -389,14 +427,25 @@ class Spotify:
         Optional[MusicInfo]
             The music information if found, otherwise None.
         """
-        if not are_strings_similar(album["name"], song):
+        if not are_strings_similar(
+            album["name"],
+            song,
+            use_translation=self.normalize_non_english,
+            translation_session=self._translation_session,
+        ):
             return None
 
         artists_name = [x["name"] for x in album["artists"]]
         matching_artists = [
             x["name"]
             for x in album["artists"]
-            if are_strings_similar(x["name"], artist) or x["id"] in artist_ids
+            if are_strings_similar(
+                x["name"],
+                artist,
+                use_translation=self.normalize_non_english,
+                translation_session=self._translation_session,
+            )
+            or x["id"] in artist_ids
         ]
 
         if matching_artists:

{yutipy-1.3.1 → yutipy-1.4.0}/yutipy/utils/cheap_utils.py

@@ -7,6 +7,7 @@ def translate_text(
     text: str,
     sl: str = None,
     dl: str = "en",
+    session: requests.Session = None,
 ) -> dict:
     """
     Translate text from one language to another.
@@ -15,7 +16,8 @@ def translate_text(
         text (str): The text to be translated.
         sl (str, optional): The source language code (e.g., 'en' for English, 'es' for Spanish). If not provided, the API will attempt to detect the source language.
         dl (str, optional): The destination language code (default is 'en' for English).
-
+        session (requests.Session, optional): A `requests.Session` object to use for making the API request. If not provided, a new session will be created and closed within the function.
+            Providing your own session can improve performance by reusing the same session for multiple requests. Don't forget to close the session afterwards.
 
      Returns:
         dict: A dictionary containing the following keys:
@@ -24,12 +26,17 @@ def translate_text(
             - 'destination-text': The translated text.
             - 'destination-language': The destination language code.
     """
+    default_session = False
+    if session is None:
+        default_session = True
+        session = requests.Session()
+
     if sl:
         url = f"https://ftapi.pythonanywhere.com/translate?sl={sl}&dl={dl}&text={text}"
     else:
         url = f"https://ftapi.pythonanywhere.com/translate?dl={dl}&text={text}"
 
-    response = requests.get(url)
+    response = session.get(url)
     response_json = response.json()
     result = {
         "source-text": response_json["source-text"],
@@ -37,10 +44,20 @@ def translate_text(
         "destination-text": response_json["destination-text"],
         "destination-language": response_json["destination-language"],
     }
+
+    if default_session:
+        session.close()
+
     return result
 
 
-def are_strings_similar(str1: str, str2: str, threshold: int = 80) -> bool:
+def are_strings_similar(
+    str1: str,
+    str2: str,
+    threshold: int = 80,
+    use_translation: bool = True,
+    translation_session: requests.Session = None,
+) -> bool:
     """
     Determine if two strings are similar based on a given threshold.
 
@@ -48,12 +65,24 @@ def are_strings_similar(str1: str, str2: str, threshold: int = 80) -> bool:
         str1 (str): First string to compare.
         str2 (str): Second string to compare.
         threshold (int, optional): Similarity threshold. Defaults to 80.
+        use_translation (bool, optional): Use translations to compare strings. Defaults to ``True``
+        translation_session (requests.Session, optional): A `requests.Session` object to use for making the API request. If not provided, a new session will be created and closed within the function.
+            Providing your own session can improve performance by reusing the same session for multiple requests. Don't forget to close the session afterwards.
 
     Returns:
         bool: True if the strings are similar, otherwise False.
     """
-    str1 = translate_text(str1)["destination-text"]
-    str2 = translate_text(str2)["destination-text"]
+    if use_translation:
+        str1 = (
+            translate_text(str1, session=translation_session)["destination-text"]
+            if translation_session
+            else translate_text(str1)["destination-text"]
+        )
+        str2 = (
+            translate_text(str2, session=translation_session)["destination-text"]
+            if translation_session
+            else translate_text(str2)["destination-text"]
+        )
 
     similarity_score = fuzz.WRatio(str1, str2, processor=default_process)
     return similarity_score > threshold

yutipy-1.4.0/yutipy/utils/logger.py

@@ -0,0 +1,4 @@
+import logging
+
+logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
+logger = logging.getLogger(__name__)

{yutipy-1.3.1 → yutipy-1.4.0}/yutipy/yutipy_music.py

@@ -2,14 +2,17 @@ from concurrent.futures import ThreadPoolExecutor, as_completed
 from pprint import pprint
 from typing import Optional
 
+import requests
+
 from yutipy.deezer import Deezer
-from yutipy.exceptions import InvalidValueException
+from yutipy.exceptions import InvalidValueException, KKBoxException, SpotifyException
 from yutipy.itunes import Itunes
 from yutipy.kkbox import KKBox
 from yutipy.models import MusicInfo, MusicInfos
 from yutipy.musicyt import MusicYT
 from yutipy.spotify import Spotify
 from yutipy.utils.cheap_utils import is_valid_string
+from yutipy.utils.logger import logger
 
 
 class YutipyMusic:
@@ -22,9 +25,53 @@ 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", "ytmusic", "itunes"]
+        self.services = {
+            "deezer": Deezer(),
+            "itunes": Itunes(),
+            "ytmusic": MusicYT(),
+        }
+
+        try:
+            self.services["kkbox"] = KKBox()
+        except KKBoxException as e:
+            logger.warning(
+                f"{self.__class__.__name__}: Skipping KKBox due to KKBoxException: {e}"
+            )
+        else:
+            idx = self.album_art_priority.index("ytmusic")
+            self.album_art_priority.insert(idx, "kkbox")
+
+        try:
+            self.services["spotify"] = Spotify()
+        except SpotifyException as e:
+            logger.warning(
+                f"{self.__class__.__name__}: Skipping Spotify due to SpotifyException: {e}"
+            )
+        else:
+            idx = self.album_art_priority.index("ytmusic")
+            self.album_art_priority.insert(idx, "spotify")
+        self.normalize_non_english = True
+        self._translation_session = requests.Session()
+
+        # Assign the translation session to each service
+        for service in self.services.values():
+            if hasattr(service, "_translation_session"):
+                service._translation_session = self._translation_session
+
+    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,
+        normalize_non_english: bool = True,
+    ) -> Optional[MusicInfos]:
         """
         Searches for a song by artist and title.
 
@@ -34,6 +81,10 @@ 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``.
+        normalize_non_english : bool, optional
+            Whether to normalize non-English characters for comparison. Default is ``True``.
 
         Returns
         -------
@@ -45,18 +96,18 @@ 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"),
-        ]
+        self.normalize_non_english = normalize_non_english
 
         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,
+                    normalize_non_english=self.normalize_non_english,
+                ): name
+                for name, service in self.services.items()
             }
 
             for future in as_completed(futures):
@@ -117,9 +168,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.1 → yutipy-1.4.0}/yutipy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 1.3.1
+Version: 1.4.0
 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.1 → yutipy-1.4.0}/yutipy.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ pyproject.toml
 requirements-dev.txt
 requirements.txt
 .github/FUNDING.yml
+.github/release-drafter.yml
 .github/ISSUE_TEMPLATE/bug_report.md
 .github/ISSUE_TEMPLATE/feature_request.md
 .github/workflows/pytest-unit-testing.yml
@@ -32,6 +33,7 @@ tests/test_models.py
 tests/test_musicyt.py
 tests/test_spotify.py
 tests/test_utils.py
+tests/test_yutipy_music.py
 yutipy/__init__.py
 yutipy/deezer.py
 yutipy/exceptions.py
@@ -47,4 +49,5 @@ yutipy.egg-info/dependency_links.txt
 yutipy.egg-info/requires.txt
 yutipy.egg-info/top_level.txt
 yutipy/utils/__init__.py
-yutipy/utils/cheap_utils.py
+yutipy/utils/cheap_utils.py
+yutipy/utils/logger.py