✨(project) add playlist support

We are now able to explore and play Deezer playlists!

Author: jmaupetit

src/onzr/cli.py

@@ -42,6 +42,7 @@
     ArtistShort,
     Collection,
     PlayerControl,
+    PlaylistShort,
     ServerState,
     TrackShort,
 )
@@ -172,8 +173,16 @@ def print_collection_table(collection: Collection, title="Collection"):
         sorted_collection.extend(albums_without_release_date)
         collection = sorted_collection
 
+    if isinstance(sample, PlaylistShort):
+        table.add_column("Title", style=theme.title_color.as_hex())
+        table.add_column("Public", style="italic")
+        table.add_column("# tracks", style="bold")
+        table.add_column("User", style=theme.secondary_color.as_hex())
+
     for item in collection:
-        table.add_row(*map(str, item.model_dump(exclude_none=True).values()))
+        table.add_row(
+            *map(str, item.model_dump(exclude_none=True, exclude={"tracks"}).values())
+        )
 
     console.print(table)
 
@@ -259,6 +268,9 @@ def search(
     track: Annotated[
         str, typer.Option("--track", "-t", help="Search by track title.")
     ] = "",
+    playlist: Annotated[
+        str, typer.Option("--playlist", "-p", help="Search by playlist name.")
+    ] = "",
     strict: Annotated[
         bool, typer.Option("--strict", "-s", help="Only consider strict matches.")
     ] = False,
@@ -285,7 +297,7 @@ def search(
     if not quiet:
         console.print("🔍 start searching…")
     try:
-        results = deezer.search(artist, album, track, strict, release)
+        results = deezer.search(artist, album, track, playlist, strict, release)
     except ValueError as err:
         raise typer.Exit(code=ExitCodes.INVALID_ARGUMENTS) from err
 
@@ -391,6 +403,37 @@ def album(
     print_collection_table(collection, title="Album tracks")
 
 
+@cli.command()
+def playlist(
+    playlist_id: str,
+    quiet: Annotated[bool, typer.Option("--quiet", "-q", help="Quiet output.")] = False,
+    ids: Annotated[
+        bool, typer.Option("--ids", "-i", help="Show only result IDs.")
+    ] = False,
+):
+    """Get playlist tracks."""
+    if ids:
+        quiet = True
+
+    if playlist_id == "-":
+        logger.debug("Reading playlist id from stdin…")
+        playlist_id = click.get_text_stream("stdin").read().strip()
+        logger.debug(f"{playlist_id=}")
+
+    deezer = get_deezer_client(quiet=quiet)
+    playlist = deezer.playlist(int(playlist_id))
+
+    if playlist.tracks is None:
+        console.print("This playlist contains no tracks.")
+        raise typer.Exit(code=ExitCodes.INVALID_ARGUMENTS)
+
+    if ids:
+        print_collection_ids(playlist.tracks)
+        return
+
+    print_collection_table(playlist.tracks, title=f"{playlist.title}")
+
+
 @cli.command()
 def mix(
     artist: list[str],

src/onzr/deezer.py

@@ -25,12 +25,14 @@
     DeezerArtistTopResponse,
     DeezerSearchAlbumResponse,
     DeezerSearchArtistResponse,
+    DeezerSearchPlaylistResponse,
     DeezerSearchResponse,
     DeezerSearchTrackResponse,
     DeezerSong,
     DeezerTrack,
     to_albums,
     to_artists,
+    to_playlists,
     to_tracks,
 )
 
@@ -99,7 +101,6 @@ def _fast_login(self):
     def _collection_details(
         self,
         collection: Collection,
-        # ) -> Generator[TrackShort, None, None] | Generator[AlbumShort, None, None]:
     ) -> Collection:
         """Add detailled informations to collection.
 
@@ -270,11 +271,25 @@ def track(self, track_id: int) -> TrackShort:
             DeezerTrack, self._api(DeezerTrack, self.api.get_track, track_id)
         ).to_short()
 
+    def playlist(self, playlist_id: int) -> PlaylistShort:
+        """Get playlist tracks."""
+        response = self.api.get_playlist(playlist_id)
+        logger.debug(f"{response=}")
+        return PlaylistShort(
+            id=response["id"],
+            title=response["title"],
+            public=response["public"],
+            nb_tracks=response["nb_tracks"],
+            user=response["creator"]["name"],
+            tracks=list(self._to_tracks(response["tracks"]["data"])),
+        )
+
     def search(
         self,
         artist: str = "",
         album: str = "",
         track: str = "",
+        playlist: str = "",
         strict: bool = False,
         fetch_release_date: bool = False,
     ) -> Collection:
@@ -335,6 +350,19 @@ def search(
                     ),
                 )
             )
+        elif playlist:
+            results = list(
+                to_playlists(
+                    cast(
+                        DeezerSearchPlaylistResponse,
+                        self._api(
+                            DeezerSearchPlaylistResponse,
+                            self.api.search_playlist,
+                            playlist,
+                        ),
+                    ),
+                )
+            )
 
         if (self.always_fetch_release_date or fetch_release_date) and not artist:
             results = self._collection_details(results)

src/onzr/models/core.py

@@ -93,7 +93,20 @@ class TrackShort(BaseModel):
     release_date: Optional[date] = None
 
 
-Collection: TypeAlias = List[ArtistShort] | List[AlbumShort] | List[TrackShort]
+class PlaylistShort(BaseModel):
+    """A small model to represent a playlist."""
+
+    id: int
+    title: str
+    public: bool
+    nb_tracks: int
+    user: str
+    tracks: Optional[List[TrackShort]] = None
+
+
+Collection: TypeAlias = (
+    List[ArtistShort] | List[AlbumShort] | List[TrackShort] | List[PlaylistShort]
+)
 
 
 class TrackInfo(BaseModel):

src/onzr/models/deezer.py

@@ -7,7 +7,14 @@
 from annotated_types import Ge, Gt
 from pydantic import BaseModel, PlainSerializer, PositiveInt
 
-from .core import AlbumShort, ArtistShort, StreamQuality, TrackInfo, TrackShort
+from .core import (
+    AlbumShort,
+    ArtistShort,
+    PlaylistShort,
+    StreamQuality,
+    TrackInfo,
+    TrackShort,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -79,6 +86,32 @@ def to_short(self) -> TrackShort:
         )
 
 
+class DeezerUser(BaseDeezerModel):
+    """Deezer API user."""
+
+    name: str
+
+
+class DeezerPlaylist(BaseDeezerModel):
+    """Deezer API playlist."""
+
+    id: PositiveInt
+    title: str
+    public: bool
+    nb_tracks: Annotated[int, Ge(0)]
+    user: DeezerUser
+
+    def to_short(self) -> PlaylistShort:
+        """Get PlaylistShort."""
+        return PlaylistShort(
+            id=self.id,
+            title=self.title,
+            public=self.public,
+            nb_tracks=self.nb_tracks,
+            user=self.user.name,
+        )
+
+
 class DeezerAlbumResponse(BaseDeezerAPIResponse):
     """Deezer album response."""
 
@@ -113,6 +146,7 @@ def get_tracks(self) -> Generator[TrackShort, None, None]:
 DeezerAdvancedSearchResponse = DeezerAPIResponseCollection[DeezerTrack]
 DeezerSearchAlbumResponse = DeezerAPIResponseCollection[DeezerAlbum]
 DeezerSearchArtistResponse = DeezerAPIResponseCollection[DeezerArtist]
+DeezerSearchPlaylistResponse = DeezerAPIResponseCollection[DeezerPlaylist]
 DeezerSearchTrackResponse = DeezerAPIResponseCollection[DeezerTrack]
 DeezerSearchResponse: TypeAlias = (
     DeezerAdvancedSearchResponse
@@ -133,12 +167,7 @@ def to_tracks(
 ) -> Generator[TrackShort, None, None]:
     """Convert deezer API response tracks collection to short tracks."""
     for track in collection.data:
-        yield TrackShort(
-            id=track.id,
-            title=track.title,
-            album=track.album.title,
-            artist=track.artist.name,
-        )
+        yield track.to_short()
 
 
 def to_albums(
@@ -162,10 +191,15 @@ def to_artists(
 ) -> Generator[ArtistShort, None, None]:
     """Get artists collection iterator."""
     for artist in collection.data:
-        yield ArtistShort(
-            id=artist.id,
-            name=artist.name,
-        )
+        yield artist.to_short()
+
+
+def to_playlists(
+    collection: DeezerSearchPlaylistResponse,
+) -> Generator[PlaylistShort, None, None]:
+    """Get playlists collection iterator."""
+    for playlist in collection.data:
+        yield playlist.to_short()
 
 
 # Deezer API Gateway models