Feature/song names (spotDL#1429)

Co-authored-by: Silverarmor <[email protected]>
Co-authored-by: Jakub Kot <[email protected]>
Co-authored-by: Yasser Tahiri <[email protected]>
Co-authored-by: Peyton Creery <[email protected]>
Co-authored-by: Arbaaz Shafiq <[email protected]>
Co-authored-by: Jakub Kot <[email protected]>

Author: 6 people

spotdl/download/tracking_file_handler.py

@@ -2,6 +2,7 @@
 from typing import Optional, List
 
 from spotdl.search import SongObject, song_gatherer
+from spotdl.utils.song_name_utils import format_name
 
 
 class DownloadTracker:
@@ -79,9 +80,7 @@ def backup_to_disk(self):
         if not self.save_file:
             song_name = self.song_list[0].song_name
 
-            song_name = "".join(char for char in song_name if char not in "/?\\*|<>")
-
-            song_name = song_name.replace('"', "'").replace(":", " - ")
+            song_name = format_name(song_name)
 
             self.save_file = Path(song_name + ".spotdlTrackingFile")
 

spotdl/providers/__init__.py

@@ -6,3 +6,4 @@
     _match_percentage,
     _parse_duration,
 )
+from spotdl.utils.song_name_utils import format_name

spotdl/providers/provider_utils.py

@@ -5,6 +5,8 @@
 
 from rapidfuzz import fuzz
 
+from spotdl.utils.song_name_utils import format_name
+
 
 def _match_percentage(str1: str, str2: str, score_cutoff: float = 0) -> float:
     """
@@ -58,20 +60,11 @@ def _parse_duration(duration: str) -> float:
 
 def _create_song_title(song_name: str, song_artists: List[str]) -> str:
     joined_artists = ", ".join(song_artists)
-    return f"{joined_artists} - {song_name}"
+    return _sanitize_filename(f"{joined_artists} - {song_name}")
 
 
 def _sanitize_filename(input_str: str) -> str:
-    output = input_str
-
-    # ! this is windows specific (disallowed chars)
-    output = "".join(char for char in output if char not in "/?\\*|<>")
-
-    # ! double quotes (") and semi-colons (:) are also disallowed characters but we would
-    # ! like to retain their equivalents, so they aren't removed in the prior loop
-    output = output.replace('"', "'").replace(":", "-")
-
-    return output
+    return format_name(input_str)
 
 
 def _get_smaller_file_path(input_song, output_format: str) -> Path:

spotdl/search/__init__.py

@@ -9,3 +9,4 @@
     from_saved_tracks,
     from_dump,
 )  # noqa: F401
+from spotdl.utils.song_name_utils import format_name  # noqa: F401

spotdl/search/song_gatherer.py

@@ -12,6 +12,7 @@
 )
 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
 
 
 def from_spotify_url(
@@ -232,7 +233,7 @@ def get_tracks(track):
     album_text = ""
     for result in results:
         if result[1] is not None:
-            album_text += "".join(char for char in result[1] if char not in "/?\\*|<>")
+            album_text += format_name(result[1])
 
         if result[0] is not None and result[0].youtube_link is not None:
             tracks.append(result[0])
@@ -245,7 +246,7 @@ def get_tracks(track):
         else:
             album_name = album_tracks[0]["name"]
 
-        album_name = "".join(char for char in album_name if char not in "/?\\*|<>")
+        album_name = format_name(album_name)
 
         album_file = Path(f"{album_name}.m3u")
 
@@ -365,9 +366,7 @@ def get_song(track):
     playlist_text = ""
     for result in results:
         if result[1] is not None:
-            playlist_text += "".join(
-                char for char in result[1] if char not in "/?\\*|<>"
-            )
+            playlist_text += format_name(result[1])
 
         if result[0] is not None and result[0].youtube_link is not None:
             tracks.append(result[0])
@@ -380,9 +379,7 @@ def get_song(track):
         else:
             playlist_name = playlist_tracks[0]["track"]["name"]
 
-        playlist_name = "".join(
-            char for char in playlist_name if char not in "/?\\*|<>"
-        )
+        playlist_name = format_name(playlist_name)
 
         playlist_file = Path(f"{playlist_name}.m3u")
 

spotdl/search/song_object.py

@@ -1,5 +1,7 @@
 from typing import List, Optional
 
+from spotdl.utils.song_name_utils import format_name
+
 
 class SongObject:
 
@@ -204,13 +206,4 @@ def create_file_name(song_name: str, song_artists: List[str]) -> str:
 
         converted_file_name = artist_string + " - " + song_name
 
-        # ! this is windows specific (disallowed chars)
-        converted_file_name = "".join(
-            char for char in converted_file_name if char not in "/?\\*|<>"
-        )
-
-        # ! double quotes (") and semi-colons (:) are also disallowed characters but we would
-        # ! like to retain their equivalents, so they aren't removed in the prior loop
-        converted_file_name = converted_file_name.replace('"', "'").replace(":", "-")
-
-        return converted_file_name
+        return format_name(converted_file_name)

spotdl/utils/__init__.py

@@ -0,0 +1,11 @@
+def format_name(input_str: str) -> str:
+    output = input_str
+
+    # ! this is windows specific (disallowed chars)
+    output = "".join(char for char in output if char not in "/?\\*|<>#")
+
+    # ! double quotes (") and semi-colons (:) are also disallowed characters but we would
+    # ! like to retain their equivalents, so they aren't removed in the prior loop
+    output = output.replace('"', "'").replace(":", " - ")
+
+    return output