Skip to content

fix: handle renamed "item" key in playlist tracks #775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maxmaxme wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: handle renamed "item" key in playlist tracks #775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion src/spotifyaio/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ class PlaylistTracks(DataClassORJSONMixin):
@classmethod
def __pre_deserialize__(cls, d: dict[str, Any]) -> dict[str, Any]:
"""Pre deserialize hook."""
items = [item for item in d["items"] if not item["is_local"]]
items = [item for item in (d.get("items") or []) if not item.get("is_local")]
return {"items": items}


Expand All @@ -452,6 +452,19 @@ class PlaylistTrack(DataClassORJSONMixin):
added_by: AddedBy
track: Annotated[Item, Discriminator(field="type", include_subtypes=True)]

@classmethod
def __pre_deserialize__(cls, d: dict[str, Any]) -> dict[str, Any]:
"""Pre deserialize hook.

Spotify's February 2026 Web API migration renamed the per-entry track
wrapper from "track" to "item". Normalize the new shape back so the
legacy "track" field keeps working; the old shape (still sent during
the deprecation window) passes through unchanged.
"""
if "track" not in d and "item" in d:
return {**d, "track": d["item"]}
return d


@dataclass
class PlaylistTrackResponse(DataClassORJSONMixin):
Expand Down
193 changes: 192 additions & 1 deletion tests/__snapshots__/test_spotify.ambr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9656,6 +9656,117 @@
'uri': 'spotify:playlist:0pM0KTMXM7K5qr3sL2DPw1',
})
# ---
# name: test_get_playlist[playlist_4.json]
dict({
'collaborative': False,
'description': '',
'external_urls': dict({
'spotify': 'https://open.spotify.com/playlist/1Cp6VQCKf2VL4sP09jN9oX',
}),
'images': list([
dict({
'height': None,
'url': 'https://i.scdn.co/image/ab67616d00001e022f41071676f4f50842581fb4',
'width': None,
}),
]),
'items': dict({
'items': list([
dict({
'added_at': datetime.datetime(2025, 7, 29, 21, 11, 55, tzinfo=datetime.timezone.utc),
'added_by': dict({
'external_urls': dict({
'spotify': 'https://open.spotify.com/user/1112264649',
}),
'href': 'https://api.spotify.com/v1/users/1112264649',
'uri': 'spotify:user:1112264649',
'user_id': '1112264649',
}),
'track': dict({
'album': dict({
'album_id': '7cynQpUNbqg7ZqYQu11Yng',
'album_type': <AlbumType.SINGLE: 'single'>,
'artists': list([
dict({
'artist_id': '7zrkALJ9ayRjzysp4QYoEg',
'name': 'Maribou State',
'uri': 'spotify:artist:7zrkALJ9ayRjzysp4QYoEg',
}),
dict({
'artist_id': '6SKEuFZYhaTytrhtJjgnO2',
'name': 'Andreya Triana',
'uri': 'spotify:artist:6SKEuFZYhaTytrhtJjgnO2',
}),
]),
'images': list([
dict({
'height': 640,
'url': 'https://i.scdn.co/image/ab67616d0000b2732f41071676f4f50842581fb4',
'width': 640,
}),
dict({
'height': 300,
'url': 'https://i.scdn.co/image/ab67616d00001e022f41071676f4f50842581fb4',
'width': 300,
}),
dict({
'height': 64,
'url': 'https://i.scdn.co/image/ab67616d000048512f41071676f4f50842581fb4',
'width': 64,
}),
]),
'name': 'All I Need',
'release_date': '2025-01-13',
'release_date_precision': <ReleaseDatePrecision.DAY: 'day'>,
'total_tracks': 5,
'uri': 'spotify:album:7cynQpUNbqg7ZqYQu11Yng',
}),
'artists': list([
dict({
'artist_id': '7zrkALJ9ayRjzysp4QYoEg',
'name': 'Maribou State',
'uri': 'spotify:artist:7zrkALJ9ayRjzysp4QYoEg',
}),
dict({
'artist_id': '6SKEuFZYhaTytrhtJjgnO2',
'name': 'Andreya Triana',
'uri': 'spotify:artist:6SKEuFZYhaTytrhtJjgnO2',
}),
]),
'disc_number': 1,
'duration_ms': 227934,
'explicit': False,
'external_urls': dict({
'spotify': 'https://open.spotify.com/track/3ZL9gPzeCnKG9l5SB1SlcZ',
}),
'href': 'https://api.spotify.com/v1/tracks/3ZL9gPzeCnKG9l5SB1SlcZ',
'is_local': False,
'name': 'All I Need',
'track_id': '3ZL9gPzeCnKG9l5SB1SlcZ',
'track_number': 1,
'type': <ItemType.TRACK: 'track'>,
'uri': 'spotify:track:3ZL9gPzeCnKG9l5SB1SlcZ',
}),
}),
]),
}),
'name': 'To find',
'object_type': 'playlist',
'owner': dict({
'display_name': 'Joost Lekkerkerker',
'external_urls': dict({
'spotify': 'https://open.spotify.com/user/1112264649',
}),
'href': 'https://api.spotify.com/v1/users/1112264649',
'object_type': 'user',
'owner_id': '1112264649',
'uri': 'spotify:user:1112264649',
}),
'playlist_id': '1Cp6VQCKf2VL4sP09jN9oX',
'public': True,
'uri': 'spotify:playlist:1Cp6VQCKf2VL4sP09jN9oX',
})
# ---
# name: test_get_playlist_cover_image
list([
dict({
Expand All @@ -9665,7 +9776,87 @@
}),
])
# ---
# name: test_get_playlist_items
# name: test_get_playlist_items[playlist_items.json]
list([
dict({
'added_at': datetime.datetime(2025, 7, 29, 21, 11, 55, tzinfo=datetime.timezone.utc),
'added_by': dict({
'external_urls': dict({
'spotify': 'https://open.spotify.com/user/1112264649',
}),
'href': 'https://api.spotify.com/v1/users/1112264649',
'uri': 'spotify:user:1112264649',
'user_id': '1112264649',
}),
'track': dict({
'album': dict({
'album_id': '7cynQpUNbqg7ZqYQu11Yng',
'album_type': <AlbumType.SINGLE: 'single'>,
'artists': list([
dict({
'artist_id': '7zrkALJ9ayRjzysp4QYoEg',
'name': 'Maribou State',
'uri': 'spotify:artist:7zrkALJ9ayRjzysp4QYoEg',
}),
dict({
'artist_id': '6SKEuFZYhaTytrhtJjgnO2',
'name': 'Andreya Triana',
'uri': 'spotify:artist:6SKEuFZYhaTytrhtJjgnO2',
}),
]),
'images': list([
dict({
'height': 640,
'url': 'https://i.scdn.co/image/ab67616d0000b2732f41071676f4f50842581fb4',
'width': 640,
}),
dict({
'height': 300,
'url': 'https://i.scdn.co/image/ab67616d00001e022f41071676f4f50842581fb4',
'width': 300,
}),
dict({
'height': 64,
'url': 'https://i.scdn.co/image/ab67616d000048512f41071676f4f50842581fb4',
'width': 64,
}),
]),
'name': 'All I Need',
'release_date': '2025-01-13',
'release_date_precision': <ReleaseDatePrecision.DAY: 'day'>,
'total_tracks': 5,
'uri': 'spotify:album:7cynQpUNbqg7ZqYQu11Yng',
}),
'artists': list([
dict({
'artist_id': '7zrkALJ9ayRjzysp4QYoEg',
'name': 'Maribou State',
'uri': 'spotify:artist:7zrkALJ9ayRjzysp4QYoEg',
}),
dict({
'artist_id': '6SKEuFZYhaTytrhtJjgnO2',
'name': 'Andreya Triana',
'uri': 'spotify:artist:6SKEuFZYhaTytrhtJjgnO2',
}),
]),
'disc_number': 1,
'duration_ms': 227934,
'explicit': False,
'external_urls': dict({
'spotify': 'https://open.spotify.com/track/3ZL9gPzeCnKG9l5SB1SlcZ',
}),
'href': 'https://api.spotify.com/v1/tracks/3ZL9gPzeCnKG9l5SB1SlcZ',
'is_local': False,
'name': 'All I Need',
'track_id': '3ZL9gPzeCnKG9l5SB1SlcZ',
'track_number': 1,
'type': <ItemType.TRACK: 'track'>,
'uri': 'spotify:track:3ZL9gPzeCnKG9l5SB1SlcZ',
}),
}),
])
# ---
# name: test_get_playlist_items[playlist_items_2.json]
list([
dict({
'added_at': datetime.datetime(2025, 7, 29, 21, 11, 55, tzinfo=datetime.timezone.utc),
Expand Down
Loading