Reorganization and features to support label_playlist
First practical-scale usecase!
This commit is contained in:
@ -1,14 +1,14 @@
|
||||
"""
|
||||
Selectors for working with albums
|
||||
"""
|
||||
from datetime import date
|
||||
from functools import partial
|
||||
from typing import Iterable
|
||||
from typing import Iterable, Union
|
||||
|
||||
from spotify_model import Paging, SearchAlbum, SimplifiedAlbum, SimplifiedTrack
|
||||
from spotipy import Spotify
|
||||
|
||||
from .temporal import temporal_convert
|
||||
from .util import chunk, exhaust
|
||||
from .util import chunk, exhaust, parse_release_date
|
||||
|
||||
|
||||
def album_filter_label(albums: Iterable[SimplifiedAlbum], label: str) -> Iterable[SearchAlbum]:
|
||||
@ -18,36 +18,71 @@ def album_filter_label(albums: Iterable[SimplifiedAlbum], label: str) -> Iterabl
|
||||
yield album
|
||||
|
||||
|
||||
def album_sort_release(albums: Iterable[SimplifiedAlbum], descending: bool = False) -> Iterable[SimplifiedAlbum]:
|
||||
def album_filter_release(
|
||||
albums: Iterable[SimplifiedAlbum], released_after: date, is_sorted: bool = False, fast_forward: bool = False
|
||||
) -> Iterable[SearchAlbum]:
|
||||
"""
|
||||
Filter albums to those released on or after a provided date.
|
||||
|
||||
If `is_sorted` is True, iteration will stop once the first album released prior to
|
||||
`released_after` is encountered (may be useful to avoid extra API calls when
|
||||
iterating over a pre-sorted playlist).
|
||||
|
||||
See `temporal_convert` for more information on how album release dates are
|
||||
resolved, and usage of `fast_forward`.
|
||||
"""
|
||||
|
||||
for album in albums:
|
||||
effective_release = parse_release_date(
|
||||
album.release_date, album.release_date_precision, fast_forward=fast_forward
|
||||
)
|
||||
|
||||
if effective_release >= released_after:
|
||||
yield album
|
||||
elif is_sorted:
|
||||
return
|
||||
|
||||
|
||||
def album_from_ids(
|
||||
client: Spotify, albums: Iterable[Union[str, SearchAlbum]], chunk_size: int = 20
|
||||
) -> Iterable[SimplifiedAlbum]:
|
||||
"""
|
||||
Given a stream of album IDs (or base album objects), retrieve the full album objects
|
||||
"""
|
||||
|
||||
def _to_id() -> Iterable[SimplifiedAlbum]:
|
||||
for album in albums:
|
||||
yield album if isinstance(album, str) else album.spotify_id
|
||||
|
||||
for album_id_chunk in chunk(_to_id(), chunk_size):
|
||||
album_chunk = client.albums(album_id_chunk)
|
||||
|
||||
for album in album_chunk:
|
||||
yield SimplifiedAlbum(**album)
|
||||
|
||||
|
||||
def album_sort_release(
|
||||
albums: Iterable[SearchAlbum], descending: bool = False, fast_forward: bool = False
|
||||
) -> Iterable[SearchAlbum]:
|
||||
"Sort albums by release date"
|
||||
all_albums = list(albums)
|
||||
for album in sorted(
|
||||
all_albums, key=lambda a: temporal_convert(a.release_date, a.release_date_precision), reverse=descending
|
||||
):
|
||||
|
||||
def _sort_key(album: SearchAlbum) -> date:
|
||||
return parse_release_date(album.release_date, album.release_date_precision, fast_forward=fast_forward)
|
||||
|
||||
for album in sorted(all_albums, key=_sort_key, reverse=descending):
|
||||
yield album
|
||||
|
||||
|
||||
def album_to_simplified(
|
||||
client: Spotify, albums: Iterable[SearchAlbum], chunk_size: int = 20
|
||||
) -> Iterable[SimplifiedAlbum]:
|
||||
"Retrieve the actual album objects associated with the albums received from searching"
|
||||
|
||||
for album_chunk in chunk(albums, chunk_size):
|
||||
album_ids = [a.spotify_id for a in album_chunk]
|
||||
|
||||
for album in client.albums(albums=album_ids)["albums"]:
|
||||
yield SimplifiedAlbum(**album)
|
||||
|
||||
|
||||
def album_to_tracks(client: Spotify, albums: Iterable[SimplifiedAlbum]) -> Iterable[SimplifiedTrack]:
|
||||
"Convert an album stream to the tracks on that album"
|
||||
|
||||
def _album_tracks(album_id: str, limit: int, offset: int) -> Paging:
|
||||
return Paging(**client.album_tracks(album_id=album_id, limit=limit, offset=offset))
|
||||
return Paging(**client.album_tracks(album_id, limit=limit, offset=offset))
|
||||
|
||||
# Because most album tracklists don't need to use paging, it's expected that API calls are relatively infrequent
|
||||
for album in albums:
|
||||
tracks_function = partial(_album_tracks, album_id=album.spotify_id)
|
||||
|
||||
for track in exhaust(tracks_function, album.tracks):
|
||||
for track in exhaust(tracks_function, initial=album.tracks):
|
||||
yield SimplifiedTrack(**track)
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
"""
|
||||
Selectors for querying and modifying playlists
|
||||
"""
|
||||
from functools import partial
|
||||
from typing import Iterable
|
||||
|
||||
from spotify_model import Paging, SimplifiedPlaylist, SimplifiedTrack
|
||||
@ -74,3 +75,18 @@ def playlist_replace(
|
||||
continue
|
||||
|
||||
client.playlist_add_items(playlist_id, track_chunk)
|
||||
|
||||
|
||||
def playlist_tracks(client: Spotify, playlist_ids: Iterable[str]) -> Iterable[SimplifiedTrack]:
|
||||
"""
|
||||
Given a playlist_id, fetch all songs currently in the playlist
|
||||
"""
|
||||
|
||||
def _playlist_tracks(playlist_id: str, limit: int, offset: int) -> Paging:
|
||||
return Paging(**client.playlist_items(playlist_id, limit=limit, offset=offset))
|
||||
|
||||
for playlist_id in playlist_ids:
|
||||
playlist_function = partial(_playlist_tracks, playlist_id=playlist_id)
|
||||
|
||||
for track in exhaust(playlist_function):
|
||||
yield SimplifiedTrack(**track)
|
||||
|
||||
@ -1,61 +0,0 @@
|
||||
"""
|
||||
Actions for filtering based on temporal information
|
||||
"""
|
||||
|
||||
from calendar import monthrange
|
||||
from datetime import date, datetime
|
||||
from logging import getLogger
|
||||
from typing import Iterable
|
||||
|
||||
from spotify_model import ReleaseDatePrecision, SearchAlbum
|
||||
|
||||
|
||||
def temporal_convert(date_str: str, precision: ReleaseDatePrecision) -> date:
|
||||
"""
|
||||
For date strings that don't have date-level precision, the date is treated as the final day within that period;
|
||||
thus, albums released in "1981" are effectively released on 1981-12-31, and albums released in "1981-07" are
|
||||
treated as "1981-07-31"
|
||||
"""
|
||||
|
||||
if precision == ReleaseDatePrecision.YEAR:
|
||||
actual = datetime.strptime(date_str, "%Y")
|
||||
effective = date(actual.year, 12, 31)
|
||||
elif precision == ReleaseDatePrecision.MONTH:
|
||||
actual = datetime.strptime(date_str, "%Y-%m")
|
||||
final_day = monthrange(actual.year, actual.month)[1] - 1
|
||||
effective = date(actual.year, actual.month, final_day)
|
||||
else:
|
||||
effective = datetime.strptime(date_str, "%Y-%m-%d").date()
|
||||
|
||||
return effective
|
||||
|
||||
|
||||
def temporal_released_after(albums: Iterable[SearchAlbum], released_after: date) -> Iterable[SearchAlbum]:
|
||||
"""
|
||||
Filter albums to after a specific release date.
|
||||
|
||||
For albums that don't have date-level precision, the release date is treated as the final day within that period;
|
||||
thus, albums released in "1981" are effectively released on 1981-12-31, and albums released in "1981-07" are
|
||||
treated as "1981-07-31"
|
||||
"""
|
||||
|
||||
logger = getLogger(__name__)
|
||||
|
||||
for album in albums:
|
||||
effective_release = temporal_convert(album.release_date, album.release_date_precision)
|
||||
|
||||
if effective_release >= released_after:
|
||||
logger.debug(
|
||||
"Including album=%s released on date=%s (prior to date=%s)",
|
||||
album.name,
|
||||
effective_release,
|
||||
released_after,
|
||||
)
|
||||
yield album
|
||||
else:
|
||||
logger.debug(
|
||||
"Skipping album=%s released on date=%s (prior to date=%s)",
|
||||
album.name,
|
||||
effective_release,
|
||||
released_after,
|
||||
)
|
||||
43
spotify_actions/track.py
Normal file
43
spotify_actions/track.py
Normal file
@ -0,0 +1,43 @@
|
||||
"""
|
||||
Selectors for working with individual tracks
|
||||
"""
|
||||
from typing import Iterable, Union
|
||||
|
||||
from spotify_model import SimplifiedTrack, Track
|
||||
from spotipy import Spotify
|
||||
|
||||
from .util import chunk
|
||||
|
||||
|
||||
def track_from_ids(
|
||||
client: Spotify, tracks: Union[Iterable[str], Iterable[SimplifiedTrack]], chunk_size: int = 50
|
||||
) -> Iterable[Track]:
|
||||
"""
|
||||
Given a stream of track IDs (or simplified tracks), retrieve the full track objects
|
||||
"""
|
||||
|
||||
def _to_id() -> Iterable[Track]:
|
||||
for track in tracks:
|
||||
yield track if isinstance(track, str) else track.spotify_id
|
||||
|
||||
for track_id_chunk in chunk(_to_id(), chunk_size):
|
||||
track_chunk = client.tracks(track_id_chunk)
|
||||
|
||||
for track in track_chunk:
|
||||
yield Track(**track)
|
||||
|
||||
|
||||
def track_unique_albums(tracks: Iterable[Track]) -> Iterable[str]:
|
||||
"""
|
||||
Given a stream of tracks, yield all unique album IDs
|
||||
"""
|
||||
|
||||
album_ids = set()
|
||||
|
||||
for track in tracks:
|
||||
album_id = track.album.spotify_id
|
||||
if album_id in album_ids:
|
||||
continue
|
||||
|
||||
album_ids.add(album_id)
|
||||
yield album_id
|
||||
@ -1,12 +1,14 @@
|
||||
"""
|
||||
Utility methods for working with the Spotify API
|
||||
"""
|
||||
from calendar import monthrange
|
||||
from datetime import date, datetime
|
||||
from math import ceil
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, Iterable, List, Optional, Protocol, TypeVar
|
||||
|
||||
import yaml
|
||||
from spotify_model import Paging
|
||||
from spotify_model import Paging, ReleaseDatePrecision
|
||||
from spotipy import Spotify, SpotifyClientCredentials, SpotifyOAuth
|
||||
|
||||
DEFAULT_LIMIT = 50
|
||||
@ -71,3 +73,33 @@ def chunk(items: Iterable[T], size: int) -> Iterable[List[T]]:
|
||||
|
||||
if return_items:
|
||||
yield return_items
|
||||
|
||||
|
||||
def parse_release_date(date_str: str, precision: ReleaseDatePrecision, fast_forward: bool = False) -> date:
|
||||
"""
|
||||
Parse a date string with provided precision to a concrete date.
|
||||
|
||||
`fast_forward` controls how precision is resolved:
|
||||
- If `False` (default), dates are assumed to be at the start of the period
|
||||
(e.g. "1970" becomes "1970-01-01", "1970-08" becomes "1907-08-01")
|
||||
- If `True`, dates are "fast-forwarded" to the end of the given period
|
||||
(e.g. "1970" becomes "1970-12-31", "1970-08" becomes "1970-08-31")
|
||||
"""
|
||||
|
||||
if precision == ReleaseDatePrecision.YEAR:
|
||||
effective = datetime.strptime(date_str, "%Y").date()
|
||||
|
||||
if fast_forward:
|
||||
effective = date(effective.year, 12, 31)
|
||||
|
||||
elif precision == ReleaseDatePrecision.MONTH:
|
||||
effective = datetime.strptime(date_str, "%Y-%m").date()
|
||||
|
||||
if fast_forward:
|
||||
final_day = monthrange(effective.year, effective.month)[1] - 1
|
||||
effective = date(effective.year, effective.month, final_day)
|
||||
|
||||
else:
|
||||
effective = datetime.strptime(date_str, "%Y-%m-%d").date()
|
||||
|
||||
return effective
|
||||
|
||||
Reference in New Issue
Block a user