-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
song.py
368 lines (285 loc) · 9.62 KB
/
song.py
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
"""
Song module that hold the Song and SongList classes.
"""
import json
from dataclasses import asdict, dataclass
from typing import Any, Dict, List, Optional, Tuple
from spotdl.utils.spotify import SpotifyClient
__all__ = ["Song", "SongList", "SongError"]
class SongError(Exception):
"""
Base class for all exceptions related to songs.
"""
class SongListError(Exception):
"""
Base class for all exceptions related to song lists.
"""
@dataclass
class Song:
"""
Song class. Contains all the information about a song.
"""
name: str
artists: List[str]
artist: str
genres: List[str]
disc_number: int
disc_count: int
album_name: str
album_artist: str
duration: int
year: int
date: str
track_number: int
tracks_count: int
song_id: str
explicit: bool
publisher: str
url: str
isrc: Optional[str]
cover_url: Optional[str]
copyright_text: Optional[str]
download_url: Optional[str] = None
lyrics: Optional[str] = None
popularity: Optional[int] = None
album_id: Optional[str] = None
list_name: Optional[str] = None
list_url: Optional[str] = None
list_position: Optional[int] = None
list_length: Optional[int] = None
@classmethod
def from_url(cls, url: str) -> "Song":
"""
Creates a Song object from a URL.
### Arguments
- url: The URL of the song.
### Returns
- The Song object.
"""
if "open.spotify.com" not in url or "track" not in url:
raise SongError(f"Invalid URL: {url}")
# query spotify for song, artist, album details
spotify_client = SpotifyClient()
# get track info
raw_track_meta = spotify_client.track(url)
if raw_track_meta is None:
raise SongError(
"Couldn't get metadata, check if you have passed correct track id"
)
if raw_track_meta["duration_ms"] == 0 or raw_track_meta["name"].strip() == "":
raise SongError(f"Track no longer exists: {url}")
# get artist info
primary_artist_id = raw_track_meta["artists"][0]["id"]
raw_artist_meta: Dict[str, Any] = spotify_client.artist(primary_artist_id) # type: ignore
# get album info
album_id = raw_track_meta["album"]["id"]
raw_album_meta: Dict[str, Any] = spotify_client.album(album_id) # type: ignore
# create song object
return cls(
name=raw_track_meta["name"],
artists=[artist["name"] for artist in raw_track_meta["artists"]],
artist=raw_track_meta["artists"][0]["name"],
album_id=album_id,
album_name=raw_album_meta["name"],
album_artist=raw_album_meta["artists"][0]["name"],
copyright_text=raw_album_meta["copyrights"][0]["text"]
if raw_album_meta["copyrights"]
else None,
genres=raw_album_meta["genres"] + raw_artist_meta["genres"],
disc_number=raw_track_meta["disc_number"],
disc_count=int(raw_album_meta["tracks"]["items"][-1]["disc_number"]),
duration=raw_track_meta["duration_ms"] / 1000,
year=int(raw_album_meta["release_date"][:4]),
date=raw_album_meta["release_date"],
track_number=raw_track_meta["track_number"],
tracks_count=raw_album_meta["total_tracks"],
isrc=raw_track_meta.get("external_ids", {}).get("isrc"),
song_id=raw_track_meta["id"],
explicit=raw_track_meta["explicit"],
publisher=raw_album_meta["label"],
url=raw_track_meta["external_urls"]["spotify"],
popularity=raw_track_meta["popularity"],
cover_url=max(
raw_album_meta["images"], key=lambda i: i["width"] * i["height"]
)["url"]
if raw_album_meta["images"]
else None,
)
@staticmethod
def search(search_term: str):
"""
Searches for Songs from a search term.
### Arguments
- search_term: The search term to use.
### Returns
- The raw search results
"""
spotify_client = SpotifyClient()
raw_search_results = spotify_client.search(search_term)
if raw_search_results is None:
raise SongError(f"Spotipy error, no response: {search_term}")
return raw_search_results
@classmethod
def from_search_term(cls, search_term: str) -> "Song":
"""
Creates a list of Song objects from a search term.
### Arguments
- search_term: The search term to use.
### Returns
- The Song object.
"""
raw_search_results = Song.search(search_term)
if len(raw_search_results["tracks"]["items"]) == 0:
raise SongError(f"No results found for: {search_term}")
return Song.from_url(
"http://open.spotify.com/track/"
+ raw_search_results["tracks"]["items"][0]["id"]
)
@classmethod
def list_from_search_term(cls, search_term: str) -> "List[Song]":
"""
Creates a list of Song objects from a search term.
### Arguments
- search_term: The search term to use.
### Returns
- The list of Song objects.
"""
raw_search_results = Song.search(search_term)
songs = []
for idx, _ in enumerate(raw_search_results.get("tracks", []).get("items", [])):
songs.append(
Song.from_url(
"http://open.spotify.com/track/"
+ raw_search_results["tracks"]["items"][idx]["id"]
)
)
return songs
@classmethod
def from_data_dump(cls, data: str) -> "Song":
"""
Create a Song object from a data dump.
### Arguments
- data: The data dump.
### Returns
- The Song object.
"""
# Create dict from json string
data_dict = json.loads(data)
# Return product object
return cls(**data_dict)
@classmethod
def from_dict(cls, data: Dict[str, Any]) -> "Song":
"""
Create a Song object from a dictionary.
### Arguments
- data: The dictionary.
### Returns
- The Song object.
"""
# Return product object
return cls(**data)
@classmethod
def from_missing_data(cls, **kwargs) -> "Song":
"""
Create a Song object from a dictionary with missing data.
For example, data dict doesn't contain all the required
attributes for the Song class.
### Arguments
- data: The dictionary.
### Returns
- The Song object.
"""
song_data: Dict[str, Any] = {}
for key in cls.__dataclass_fields__: # pylint: disable=E1101
song_data.setdefault(key, kwargs.get(key))
return cls(**song_data)
@property
def display_name(self) -> str:
"""
Returns a display name for the song.
### Returns
- The display name.
"""
return f"{self.artist} - {self.name}"
@property
def json(self) -> Dict[str, Any]:
"""
Returns a dictionary of the song's data.
### Returns
- The dictionary.
"""
return asdict(self)
@dataclass(frozen=True)
class SongList:
"""
SongList class. Base class for all other song lists subclasses.
"""
name: str
url: str
urls: List[str]
songs: List[Song]
@classmethod
def from_url(cls, url: str, fetch_songs: bool = True):
"""
Create a SongList object from a url.
### Arguments
- url: The url of the list.
- fetch_songs: Whether to fetch missing metadata for songs.
### Returns
- The SongList object.
"""
metadata, songs = cls.get_metadata(url)
urls = [song.url for song in songs]
if fetch_songs:
songs = [Song.from_url(song.url) for song in songs]
return cls(**metadata, urls=urls, songs=songs)
@classmethod
def from_search_term(cls, search_term: str, fetch_songs: bool = True):
"""
Creates a SongList object from a search term.
### Arguments
- search_term: The search term to use.
### Returns
- The SongList object.
"""
list_type = cls.__name__.lower()
spotify_client = SpotifyClient()
raw_search_results = spotify_client.search(search_term, type=list_type)
if (
raw_search_results is None
or len(raw_search_results.get(f"{list_type}s", {}).get("items", [])) == 0
):
raise SongListError(
f"No {list_type} matches found on spotify for '{search_term}'"
)
list_id = raw_search_results[f"{list_type}s"]["items"][0]["id"]
return cls.from_url(
f"http://open.spotify.com/{list_type}/{list_id}",
fetch_songs,
)
@property
def length(self) -> int:
"""
Get list length (number of songs).
### Returns
- The list length.
"""
return max(len(self.urls), len(self.songs))
@property
def json(self) -> Dict[str, Any]:
"""
Returns a dictionary of the song list's data.
### Returns
- The dictionary.
"""
return asdict(self)
@staticmethod
def get_metadata(url: str) -> Tuple[Dict[str, Any], List[Song]]:
"""
Get metadata for a song list.
### Arguments
- url: The url of the song list.
### Returns
- The metadata.
"""
raise NotImplementedError