close spotDL#1406 (spotDL#1436)

Author: xnetcat

spotdl/console/__init__.py

@@ -21,15 +21,13 @@ def console_entry_point():
     args_dict = vars(arguments)
 
     if arguments.ffmpeg:
-        args_dict['ffmpeg'] = str(Path(arguments.ffmpeg).absolute())
+        args_dict["ffmpeg"] = str(Path(arguments.ffmpeg).absolute())
     else:
-        args_dict['ffmpeg'] = "ffmpeg"
+        args_dict["ffmpeg"] = "ffmpeg"
 
     # Check if ffmpeg has correct version, if not exit
     if (
-        ffmpeg.has_correct_version(
-            arguments.ignore_ffmpeg_version, args_dict['ffmpeg']
-        )
+        ffmpeg.has_correct_version(arguments.ignore_ffmpeg_version, args_dict["ffmpeg"])
         is False
     ):
         sys.exit(1)
@@ -84,6 +82,7 @@ def graceful_exit(signal, frame):
             arguments.generate_m3u,
             arguments.lyrics_provider,
             arguments.search_threads,
+            arguments.path_template,
         )
 
         # Start downloading

spotdl/download/downloader.py

@@ -220,16 +220,19 @@ async def download_song(self, song_object: SongObject) -> None:
 
             downloaded_file_path = Path(downloaded_file_path_string)
 
-            if downloaded_file_path.suffix == ".m4a" and self.arguments["output_format"] != "m4a":
+            if (
+                downloaded_file_path.suffix == ".m4a"
+                and self.arguments["output_format"] == "m4a"
+            ):
+                downloaded_file_path.rename(converted_file_path)
+                ffmpeg_success = True
+            else:
                 ffmpeg_success = await ffmpeg.convert(
                     downloaded_file_path=downloaded_file_path,
                     converted_file_path=converted_file_path,
                     output_format=self.arguments["output_format"],
                     ffmpeg_path=self.arguments["ffmpeg"],
                 )
-            else:
-                downloaded_file_path.rename(converted_file_path)
-                ffmpeg_success = True
 
             if display_progress_tracker:
                 display_progress_tracker.notify_conversion_completion()

spotdl/download/embed_metadata.py

@@ -1,4 +1,5 @@
 import base64
+from pathlib import Path
 
 from urllib.request import urlopen
 from mutagen.oggopus import OggOpus

spotdl/download/ffmpeg.py

@@ -68,11 +68,9 @@ async def convert(
         "mp3": ["-codec:a", "libmp3lame"],
         "flac": ["-codec:a", "flac"],
         "ogg": ["-codec:a", "libvorbis"],
-        "opus": [
-            "-vn", "-c:a", "copy"
-        ] if downloaded_file_path.endswith(".opus") else [
-            "-c:a", "libopus"
-        ],
+        "opus": ["-vn", "-c:a", "copy"]
+        if downloaded_file_path.endswith(".opus")
+        else ["-c:a", "libopus"],
         "m4a": ["-codec:a", "aac", "-vn"],
         "wav": [],
     }

spotdl/parsers/argument_parser.py

@@ -2,7 +2,7 @@
 
 import pkg_resources
 
-help_notice = r"""  # noqa: E501
+help_notice = r"""
 To download a song run,
     spotdl [trackUrl]
     ex. spotdl https://open.spotify.com/track/0VjIjW4GlUZAMYd2vXMi3b
@@ -78,7 +78,7 @@
 
 spotDL downloads up to 4 songs in parallel, so for a faster experience,
 download albums and playlist, rather than tracks.
-"""
+"""  # noqa: E501
 
 
 def parse_arguments():

spotdl/parsers/query_parser.py

@@ -6,7 +6,13 @@
 
 
 def parse_query(
-    query: List[str], format, use_youtube, generate_m3u, lyrics_provider, threads
+    query: List[str],
+    format,
+    use_youtube,
+    generate_m3u,
+    lyrics_provider,
+    threads,
+    path_template,
 ) -> List[SongObject]:
     """
     Parse query and return list containing song object
@@ -21,7 +27,13 @@ def parse_query(
 
         songs_list.extend(
             parse_request(
-                request, format, use_youtube, generate_m3u, lyrics_provider, threads
+                request,
+                format,
+                use_youtube,
+                generate_m3u,
+                lyrics_provider,
+                threads,
+                path_template,
             )
         )
 
@@ -46,6 +58,7 @@ def parse_request(
     generate_m3u: bool = False,
     lyrics_provider: str = None,
     threads: int = 1,
+    path_template: str = None,
 ) -> List[SongObject]:
     song_list: List[SongObject] = []
     if (
@@ -81,12 +94,24 @@ def parse_request(
     elif "open.spotify.com" in request and "album" in request:
         print("Fetching Album...")
         song_list = song_gatherer.from_album(
-            request, output_format, use_youtube, lyrics_provider, generate_m3u, threads
+            request,
+            output_format,
+            use_youtube,
+            lyrics_provider,
+            generate_m3u,
+            threads,
+            path_template,
         )
     elif "open.spotify.com" in request and "playlist" in request:
         print("Fetching Playlist...")
         song_list = song_gatherer.from_playlist(
-            request, output_format, use_youtube, lyrics_provider, generate_m3u, threads
+            request,
+            output_format,
+            use_youtube,
+            lyrics_provider,
+            generate_m3u,
+            threads,
+            path_template,
         )
     elif "open.spotify.com" in request and "artist" in request:
         print("Fetching artist...")

spotdl/providers/provider_utils.py

@@ -38,7 +38,9 @@ def _match_percentage(str1: str, str2: str, score_cutoff: float = 0) -> float:
             if each_letter.isalnum() or each_letter.isspace()
         )
 
-        return fuzz.partial_ratio(new_str1, new_str2, processor=None, score_cutoff=score_cutoff)
+        return fuzz.partial_ratio(
+            new_str1, new_str2, processor=None, score_cutoff=score_cutoff
+        )
 
 
 def _parse_duration(duration: str) -> float:

spotdl/providers/yt_provider.py

@@ -116,7 +116,7 @@ def _order_yt_results(
             # ! (remix)' would return 100, so we're absolutely corrent in matching
             # ! artists to song name.
             if _match_percentage(
-                unidecode(artist.lower()), unidecode(result.title).lower(), 85
+                str(unidecode(artist.lower())), str(unidecode(result.title).lower()), 85
             ):
                 artist_match_number += 1
 
@@ -129,7 +129,7 @@ def _order_yt_results(
         song_title = _create_song_title(song_name, song_artists).lower()
         name_match = round(
             _match_percentage(
-                unidecode(result.title.lower()), unidecode(song_title), 60
+                str(unidecode(result.title.lower())), str(unidecode(song_title)), 60
             ),
             ndigits=3,
         )

spotdl/providers/ytm_provider.py

@@ -160,7 +160,7 @@ def _order_ytm_results(
         if result["type"] == "song":
             for artist in song_artists:
                 artist_match_number += _match_percentage(
-                    unidecode(artist.lower()), unidecode(result["artist"]).lower()
+                    str(unidecode(artist.lower())), unidecode(result["artist"].lower())
                 )
         else:
             # ! i.e if video
@@ -169,7 +169,7 @@ def _order_ytm_results(
                 # ! (remix)' would return 100, so we're absolutely corrent in matching
                 # ! artists to song name.
                 artist_match_number += _match_percentage(
-                    unidecode(artist.lower()), unidecode(result["name"]).lower()
+                    str(unidecode(artist.lower())), unidecode(result["name"].lower())
                 )
 
             # we didn't find artist in the video title, so we fallback to
@@ -178,7 +178,7 @@ def _order_ytm_results(
             if artist_match_number == 0:
                 for artist in song_artists:
                     artist_match_number += _match_percentage(
-                        unidecode(artist.lower()),
+                        str(unidecode(artist.lower())),
                         unidecode(result["artist"].lower()),
                     )
 
@@ -192,12 +192,16 @@ def _order_ytm_results(
         # this needs more testing
         if result["type"] == "song":
             name_match = round(
-                _match_percentage(unidecode(result["name"]), unidecode(song_name), 60),
+                _match_percentage(
+                    unidecode(result["name"]), str(unidecode(song_name)), 60
+                ),
                 ndigits=3,
             )
         else:
             name_match = round(
-                _match_percentage(unidecode(result["name"]), unidecode(song_title), 60),
+                _match_percentage(
+                    unidecode(result["name"]), str(unidecode(song_title)), 60
+                ),
                 ndigits=3,
             )
 

spotdl/search/song_gatherer.py

@@ -11,8 +11,11 @@
     lyrics_providers,
 )
 from spotdl.search import SongObject, SpotifyClient
-from spotdl.providers.provider_utils import _get_converted_file_path
 from spotdl.utils.song_name_utils import format_name
+from spotdl.providers.provider_utils import (
+    _get_converted_file_path,
+    _parse_path_template,
+)
 
 
 def from_spotify_url(
@@ -141,6 +144,7 @@ def from_album(
     lyrics_provider: str = None,
     generate_m3u: bool = False,
     threads: int = 1,
+    path_template: str = None,
 ) -> List[SongObject]:
     """
     Create and return list containing SongObject for every song in the album
@@ -188,7 +192,7 @@ def get_tracks(track):
             )
 
             if generate_m3u:
-                file_path = _get_converted_file_path(song, output_format)
+                file_path = _parse_path_template(path_template, song, output_format)
 
                 return song, f"{file_path}\n"
 
@@ -197,31 +201,8 @@ def get_tracks(track):
             return None, None
         except OSError:
             if generate_m3u:
-                file_path = (
-                    str(
-                        provider_utils._create_song_title(
-                            track["name"],
-                            [artist["name"] for artist in track["artists"]],
-                        )
-                    )
-                    + "."
-                    + output_format
-                    if output_format is not None
-                    else "mp3"
-                )
-
-                if len(file_path) > 256:
-                    file_path = (
-                        str(
-                            provider_utils._create_song_title(
-                                track["name"], [track["artists"][0]["name"]]
-                            )
-                        )
-                        + "."
-                        + output_format
-                        if output_format is not None
-                        else "mp3"
-                    )
+                song_obj = SongObject({*track}, album_response, {}, None, "", None)
+                file_path = _parse_path_template(path_template, song_obj, output_format)
 
                 return None, f"{file_path}\n"
 
@@ -233,7 +214,7 @@ def get_tracks(track):
     album_text = ""
     for result in results:
         if result[1] is not None:
-            album_text += format_name(result[1])
+            album_text += result[1]
 
         if result[0] is not None and result[0].youtube_link is not None:
             tracks.append(result[0])
@@ -263,6 +244,7 @@ def from_playlist(
     lyrics_provider: str = None,
     generate_m3u: bool = False,
     threads: int = 1,
+    path_template: str = None,
 ) -> List[SongObject]:
     """
     Create and return list containing SongObject for every song in the playlist
@@ -320,7 +302,7 @@ def get_song(track):
             )
 
             if generate_m3u:
-                file_path = _get_converted_file_path(song, output_format)
+                file_path = _parse_path_template(path_template, song, output_format)
 
                 return song, f"{file_path}\n"
 
@@ -329,32 +311,10 @@ def get_song(track):
             return None, None
         except OSError:
             if generate_m3u:
-                file_path = (
-                    str(
-                        provider_utils._create_song_title(
-                            track["track"]["name"],
-                            [artist["name"] for artist in track["track"]["artists"]],
-                        )
-                    )
-                    + "."
-                    + output_format
-                    if output_format is not None
-                    else "mp3"
+                song_obj = SongObject(
+                    {*track["track"]}, {}, {}, None, "", playlist_response
                 )
-
-                if len(file_path) > 256:
-                    file_path = (
-                        str(
-                            provider_utils._create_song_title(
-                                track["track"]["name"],
-                                [track["track"]["artists"][0]["name"]],
-                            )
-                        )
-                        + "."
-                        + output_format
-                        if output_format is not None
-                        else "mp3"
-                    )
+                file_path = _parse_path_template(path_template, song_obj, output_format)
 
                 return None, f"{file_path}\n"
 
@@ -366,7 +326,7 @@ def get_song(track):
     playlist_text = ""
     for result in results:
         if result[1] is not None:
-            playlist_text += format_name(result[1])
+            playlist_text += result[1]
 
         if result[0] is not None and result[0].youtube_link is not None:
             tracks.append(result[0])