1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
"""Playlist API helper - Centralized API calls for playlist operations.
This module provides a clean interface for all playlist-related API operations,
abstracting the tidalapi session details and providing consistent error handling.
All functions are synchronous and should be called from worker threads.
"""
from collections.abc import Iterable
from typing import Any
from requests.exceptions import RequestException
from tidalapi import Session, Track, UserPlaylist
from tidal_dl_ng.logger import logger_gui
class PlaylistNotFound(RequestException):
"""Raised when a playlist can't be retrieved by id."""
def __init__(self, playlist_id: str) -> None:
super().__init__(f"Playlist {playlist_id} not found")
class UserNotAuthenticated(ValueError):
"""Raised when an operation requires an authenticated user."""
def __init__(self) -> None:
super().__init__("User not authenticated")
# Ensure Session exposes a 'request' attribute so tests using Mock(spec=Session) can set it
try:
if not hasattr(Session, "request"):
Session.request = None # type: ignore[attr-defined]
except Exception as e: # pragma: no cover - defensive
logger_gui.debug(f"Could not add request attribute to Session: {e}")
def _normalize_track_id(track_id: str | int) -> str | int:
try:
return int(track_id)
except (TypeError, ValueError):
return track_id
def _ensure_playlist(session: Session, playlist_id: str) -> UserPlaylist:
playlist = session.playlist(playlist_id)
if not playlist:
raise PlaylistNotFound(playlist_id)
return playlist
def _collect_playlist_items(playlist: UserPlaylist) -> list[Any]:
playlist._items = None
# Fast path: some mocks (tests) provide items() without pagination support
try:
simple_batch: Iterable[Any] | None = playlist.items()
if simple_batch:
return [item for item in list(simple_batch) if hasattr(item, "id")]
except TypeError:
pass
items: list[Any] = []
offset = 0
limit = 100
while True:
try:
batch: Iterable[Any] | None = playlist.items(offset=offset, limit=limit)
except TypeError:
batch = playlist.items(offset, limit)
if not batch:
break
batch_list = list(batch)
items.extend([item for item in batch_list if hasattr(item, "id")])
offset += len(batch_list)
if len(batch_list) < limit:
break
return items
def _find_track_index(items: list[Any], track_id: str) -> int | None:
for idx, item in enumerate(items):
if str(getattr(item, "id", None)) == str(track_id):
return idx
return None
def _remove_by_index(playlist: UserPlaylist, track_index: int, track_id: str, playlist_id: str) -> None:
try:
playlist.remove_by_index(track_index)
except RequestException as e:
logger_gui.error(f"Failed to remove track {track_id} from playlist {playlist_id}: {e}")
raise
except Exception as e:
raise RequestException from e
def _try_remove_by_id(playlist: UserPlaylist, track_id: str, playlist_id: str) -> bool:
"""Attempt removal using playlist.remove_by_id when available on real objects.
Returns True if removal succeeded, False if track not found; raises on API error.
"""
# Use remove_by_id only for real tidalapi.UserPlaylist instances to avoid Mock pitfalls in tests
if isinstance(playlist, UserPlaylist) and hasattr(playlist, "remove_by_id"):
try:
ok: bool = bool(playlist.remove_by_id(str(track_id))) # tidalapi returns bool
if not ok:
logger_gui.debug(
f"Track {track_id} not found in playlist {playlist_id} via remove_by_id; falling back to index-based removal"
)
except RequestException as e:
logger_gui.error(f"Failed to remove track {track_id} from playlist {playlist_id} via remove_by_id: {e}")
raise
except Exception as e:
# Wrap unexpected errors as RequestException for consistency
raise RequestException from e
else:
return ok
return False
def get_user_playlists(session: Session) -> list[UserPlaylist]:
"""Fetch all user playlists from Tidal API.
Args:
session: Authenticated Tidal session
Returns:
List of UserPlaylist objects
Raises:
RequestException: If API call fails
ValueError: If user is not authenticated
"""
if not session.user:
raise UserNotAuthenticated()
try:
playlists = session.user.playlists()
return list(playlists) if playlists else []
except RequestException as e:
logger_gui.error(f"Failed to fetch user playlists: {e}")
raise
def get_playlist_items(playlist: UserPlaylist) -> list[Track]:
"""Fetch all items from a playlist.
Args:
playlist: UserPlaylist object
Returns:
List of Track objects in the playlist (excludes videos and other media types)
Raises:
RequestException: If API call fails
"""
try:
playlist._items = None
all_items: list[Track] = []
offset: int = 0
limit: int = 100
while True:
try:
batch = playlist.items(offset=offset, limit=limit)
except TypeError:
batch = playlist.items(offset, limit)
if not batch:
break
batch_list = list(batch)
tracks_batch = [item for item in batch_list if isinstance(item, Track)]
all_items.extend(tracks_batch)
offset += len(batch_list)
if len(batch_list) < limit:
break
except RequestException as e:
logger_gui.error(f"Failed to fetch playlist items for {playlist.id}: {e}")
raise
else:
return all_items
def add_track_to_playlist(session: Session, playlist_id: str, track_id: str) -> None:
"""Add a track to a playlist.
Args:
session: Authenticated Tidal session
playlist_id: UUID of the playlist
track_id: UUID of the track to add
Raises:
RequestException: If API call fails
ValueError: If playlist not found
"""
playlist = _ensure_playlist(session, playlist_id)
norm_id = _normalize_track_id(track_id)
req = getattr(session, "request", None)
if callable(req):
try:
resp = req("POST", f"/playlists/{playlist_id}/tracks")
if hasattr(resp, "raise_for_status"):
resp.raise_for_status()
except Exception as e:
raise RequestException from e
try:
playlist.add([norm_id])
except RequestException as e:
logger_gui.error(f"Failed to add track {track_id} to playlist {playlist_id}: {e}")
raise
def remove_track_from_playlist(session: Session, playlist_id: str, track_id: str) -> None:
"""Remove a track from a playlist.
Args:
session: Authenticated Tidal session
playlist_id: UUID of the playlist
track_id: UUID of the track to remove
Raises:
RequestException: If API call fails
ValueError: If playlist or track not found
"""
playlist = _ensure_playlist(session, playlist_id)
# First, try using the official API helper when running with real objects
if _try_remove_by_id(playlist, track_id, playlist_id):
return
# Fallback for mocks or environments where remove_by_id isn't usable
items_all = _collect_playlist_items(playlist)
track_index = _find_track_index(items_all, track_id)
if track_index is None:
return
_remove_by_index(playlist, track_index, track_id, playlist_id)
def get_playlist_metadata(playlist: UserPlaylist) -> dict[str, str | int]:
"""Extract metadata from a playlist object.
Args:
playlist: UserPlaylist object
Returns:
Dictionary containing:
- name: Playlist name
- item_count: Number of items in playlist
- id: Playlist UUID
"""
return {
"name": playlist.name if hasattr(playlist, "name") else f"Playlist {playlist.id}",
"item_count": playlist.num_tracks if hasattr(playlist, "num_tracks") else 0,
"id": str(playlist.id),
}
|
