Add privacy setting option for playlist creation and copy functions

This commit introduces the ability to specify the privacy setting for playlists when creating or copying them in the `spotify2ytmusic` tool. It allows users to choose between PRIVATE, PUBLIC, or UNLISTED for the visibility of their newly created playlists on YouTube Music.  PRIVATE remains the default.

Author: linsomniac

spotify2ytmusic/backend.py

@@ -32,19 +32,27 @@ def get_ytmusic() -> YTMusic:
         sys.exit(1)
 
 
-def _ytmusic_create_playlist(yt: YTMusic, title: str, description: str) -> str:
+def _ytmusic_create_playlist(
+    yt: YTMusic, title: str, description: str, privacy_status: str = "PRIVATE"
+) -> str:
     """Wrapper on ytmusic.create_playlist
 
     This wrapper does retries with back-off because sometimes YouTube Music will
     rate limit requests or otherwise fail.
+
+    privacy_status can be: PRIVATE, PUBLIC, or UNLISTED
     """
 
-    def _create(yt: YTMusic, title: str, description: str) -> Union[str, dict]:
+    def _create(
+        yt: YTMusic, title: str, description: str, privacy_status: str
+    ) -> Union[str, dict]:
         exception_sleep = 5
         for _ in range(10):
             try:
                 """Create a playlist on YTMusic, retrying if it fails."""
-                id = yt.create_playlist(title=title, description=description)
+                id = yt.create_playlist(
+                    title=title, description=description, privacy_status=privacy_status
+                )
                 return id
             except Exception as e:
                 print(
@@ -57,7 +65,7 @@ def _create(yt: YTMusic, title: str, description: str) -> Union[str, dict]:
             "s2yt error": 'ERROR: Could not create playlist "{title}" after multiple retries'
         }
 
-    id = _create(yt, title, description)
+    id = _create(yt, title, description, privacy_status)
     #  create_playlist returns a dict if there was an error
     if isinstance(id, dict):
         print(f"ERROR: Failed to create playlist (name: {title}): {id}")
@@ -73,16 +81,20 @@ def load_playlists_json(filename: str = "playlists.json", encoding: str = "utf-8
     return json.load(open(filename, "r", encoding=encoding))
 
 
-def create_playlist(pl_name: str) -> None:
+def create_playlist(pl_name: str, privacy_status: str = "PRIVATE") -> None:
     """Create a YTMusic playlist
 
 
     Args:
         `pl_name` (str): The name of the playlist to create. It should be different to "".
+
+        `privacy_status` (str: PRIVATE, PUBLIC, UNLISTED) The privacy setting of created playlist.
     """
     yt = get_ytmusic()
 
-    id = _ytmusic_create_playlist(yt, title=pl_name, description=pl_name)
+    id = _ytmusic_create_playlist(
+        yt, title=pl_name, description=pl_name, privacy_status=privacy_status
+    )
     print(f"Playlist ID: {id}")
 
 
@@ -405,6 +417,7 @@ def copy_playlist(
     track_sleep: float = 0.1,
     yt_search_algo: int = 0,
     reverse_playlist: bool = True,
+    privacy_status: str = "PRIVATE",
 ):
     """
     Copy a Spotify playlist to a YTMusic playlist
@@ -429,9 +442,11 @@ def copy_playlist(
                     pl_name = pl["name"]
 
         ytmusic_playlist_id = _ytmusic_create_playlist(
-            yt, title=pl_name, description=pl_name
+            yt,
+            title=pl_name,
+            description=pl_name,
+            privacy_status=privacy_status,
         )
-        time.sleep(1)  # seems to be needed to avoid missing playlist ID error
 
         #  create_playlist returns a dict if there was an error
         if isinstance(ytmusic_playlist_id, dict):
@@ -459,6 +474,7 @@ def copy_all_playlists(
     spotify_playlists_encoding: str = "utf-8",
     yt_search_algo: int = 0,
     reverse_playlist: bool = True,
+    privacy_status: str = "PRIVATE",
 ):
     """
     Copy all Spotify playlists (except Liked Songs) to YTMusic playlists
@@ -477,8 +493,9 @@ def copy_all_playlists(
         dst_pl_id = get_playlist_id_by_name(yt, pl_name)
         print(f"Looking up playlist '{pl_name}': id={dst_pl_id}")
         if dst_pl_id is None:
-            dst_pl_id = _ytmusic_create_playlist(yt, title=pl_name, description=pl_name)
-            time.sleep(1)  # seems to be needed to avoid missing playlist ID error
+            dst_pl_id = _ytmusic_create_playlist(
+                yt, title=pl_name, description=pl_name, privacy_status=privacy_status
+            )
 
             #  create_playlist returns a dict if there was an error
             if isinstance(dst_pl_id, dict):

spotify2ytmusic/cli.py

@@ -40,12 +40,25 @@ def create_playlist():
     """
     Create a YTMusic playlist
     """
-    if len(sys.argv) != 2:
-        print(f"usage: {os.path.basename(sys.argv[0])} <YT PLAYLIST NAME>")
-        sys.exit(1)
 
-    pl_name = sys.argv[1]
-    backend.create_playlist(pl_name)
+    def parse_arguments():
+        parser = ArgumentParser()
+        parser.add_argument(
+            "--privacy",
+            default="PRIVATE",
+            help="The privacy seting of created playlists (PRIVATE, PUBLIC, UNLISTED, default PRIVATE)",
+        )
+        parser.add_argument(
+            "playlist_name",
+            type=str,
+            help="Name of playlist to create.",
+        )
+
+        return parser.parse_args()
+
+    args = parse_arguments()
+
+    backend.create_playlist(args.playlist_name, privacy_status=args.privacy)
 
 
 def search():
@@ -229,6 +242,11 @@ def parse_arguments():
             help="Do not reverse playlist on load, regular playlists are reversed normally "
             "so they end up in the same order as on Spotify.",
         )
+        parser.add_argument(
+            "--privacy",
+            default="PRIVATE",
+            help="The privacy seting of created playlists (PRIVATE, PUBLIC, UNLISTED, default PRIVATE)",
+        )
 
         return parser.parse_args()
 
@@ -240,6 +258,7 @@ def parse_arguments():
         dry_run=args.dry_run,
         spotify_playlists_encoding=args.spotify_playlists_encoding,
         reverse_playlist=not args.no_reverse_playlist,
+        privacy_status=args.privacy,
     )
 
 
@@ -278,6 +297,11 @@ def parse_arguments():
             help="Do not reverse playlist on load, regular playlists are reversed normally "
             "so they end up in the same order as on Spotify.",
         )
+        parser.add_argument(
+            "--privacy",
+            default="PRIVATE",
+            help="The privacy seting of created playlists (PRIVATE, PUBLIC, UNLISTED, default PRIVATE)",
+        )
 
         return parser.parse_args()
 
@@ -287,6 +311,7 @@ def parse_arguments():
         dry_run=args.dry_run,
         spotify_playlists_encoding=args.spotify_playlists_encoding,
         reverse_playlist=not args.no_reverse_playlist,
+        privacy_status=args.privacy,
     )