Compare commits

..

No commits in common. "master" and "2.25.2" have entirely different histories.

7 changed files with 67 additions and 154 deletions

View File

@ -12,4 +12,4 @@ jobs:
- uses: dangoslen/changelog-enforcer@v3.6.1
with:
changeLogPath: 'CHANGELOG.md'
skipLabels: 'skip-changelog'
skipLabel: 'skip-changelog'

View File

@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Unreleased
Add your changes below.
### Added
@ -14,19 +15,6 @@ Add your changes below.
### Removed
## [2.26.0] - 2026-03-03
### Added
- Created generic methods to get user saved items
### Fixed
- Updated `/tracks` endpoints to `/items`
- Switching IDs to URIs to use `/me/library` endpoint
- Fixed playlist limit to 50 (according to API)
- Added warnings for deprecated methods
### Removed
## [2.25.2] - 2025-11-26
### Added

View File

@ -39,7 +39,8 @@ To give you a flavour of what we mean, here are some examples of what PRs go whe
Just choose v3 if you are unsure which branch to work on.
### Create virtual environment, install dependencies, run tests
### Create virtual environment, install dependencies, run tests:
```bash
$ virtualenv --python=python3 env
@ -50,7 +51,7 @@ $ source env/bin/activate
### Lint
pip install ".[test]"
pip install .[test]
To automatically fix some of the code style:
@ -89,6 +90,7 @@ Don't forget to add a short description of your change in the [CHANGELOG](CHANGE
- Commit changes
- Push tag to trigger PyPI build & release workflow
- Create github release <https://github.com/plamere/spotipy/releases> with the changelog content
- Create github release https://github.com/plamere/spotipy/releases with the changelog content
for the version and a short name that describes the main addition
- Verify doc uses latest <https://readthedocs.org/projects/spotipy/>
- Verify doc uses latest https://readthedocs.org/projects/spotipy/

View File

@ -1,3 +1,3 @@
Sphinx~=8.1.3
sphinx-rtd-theme~=3.1.0
sphinx-rtd-theme~=3.0.2
redis>=3.5.3

View File

@ -13,15 +13,15 @@ extra_reqs = {
],
'test': [
'autopep8>=2.3.2',
'flake8>=7.3.0',
'flake8-use-fstring>=1.4',
'isort>=7.0.0'
'flake8>=7.1.1',
'flake8-string-format>=0.3.0',
'isort>=5.13.2'
]
}
setup(
name='spotipy',
version='2.26.0',
version='2.25.2',
description='A light weight Python library for the Spotify Web API',
long_description=long_description,
long_description_content_type="text/markdown",

View File

@ -400,7 +400,7 @@ class Spotify:
return self._get("artists/?ids=" + ",".join(tlist))
def artist_albums(
self, artist_id, album_type=None, include_groups=None, country=None, limit=10, offset=0
self, artist_id, album_type=None, include_groups=None, country=None, limit=20, offset=0
):
""" Get Spotify catalog information about an artist's albums
@ -445,11 +445,6 @@ class Spotify:
- country - limit the response to one particular country.
"""
warnings.warn(
"You're using `artist_top_tracks(...)`, "
"which is marked as deprecated by Spotify.",
DeprecationWarning,
)
trid = self._get_id("artist", artist_id)
return self._get("artists/" + trid + "/top-tracks", country=country)
@ -652,11 +647,6 @@ class Spotify:
Parameters:
- user - the id of the usr
"""
warnings.warn(
"You're using `user(...)`, "
"which is marked as deprecated by Spotify.",
DeprecationWarning,
)
return self._get("users/" + user)
def current_user_playlists(self, limit=50, offset=0):
@ -690,7 +680,7 @@ class Spotify:
self,
playlist_id,
fields=None,
limit=50,
limit=100,
offset=0,
market=None,
additional_types=("track",)
@ -722,7 +712,7 @@ class Spotify:
self,
playlist_id,
fields=None,
limit=50,
limit=100,
offset=0,
market=None,
additional_types=("track", "episode")
@ -740,7 +730,7 @@ class Spotify:
"""
plid = self._get_id("playlist", playlist_id)
return self._get(
f"playlists/{plid}/items",
f"playlists/{plid}/tracks",
limit=limit,
offset=offset,
fields=fields,
@ -836,12 +826,6 @@ class Spotify:
- limit - the number of items to return
- offset - the index of the first item to return
"""
warnings.warn(
"You're using `user_playlists(...)`, "
"which is marked as deprecated by Spotify. Use "
"current_user_playlists(...) instead.",
DeprecationWarning,
)
return self._get(
f"users/{user}/playlists", limit=limit, offset=offset
)
@ -856,12 +840,6 @@ class Spotify:
- collaborative - is the created playlist collaborative
- description - the description of the playlist
"""
warnings.warn(
"You're using `user_playlist_create(...)`, "
"which is marked as deprecated by Spotify. Use "
"current_user_playlist_create(...) instead.",
DeprecationWarning,
)
data = {
"name": name,
"public": public,
@ -871,24 +849,6 @@ class Spotify:
return self._post(f"users/{user}/playlists", payload=data)
def current_user_playlist_create(self, name, public=True, collaborative=False, description=""):
""" Creates a playlist for the current user
Parameters:
- name - the name of the playlist
- public - is the created playlist public
- collaborative - is the created playlist collaborative
- description - the description of the playlist
"""
data = {
"name": name,
"public": public,
"collaborative": collaborative,
"description": description
}
return self._post("me/playlists", payload=data)
def user_playlist_change_details(
self,
user,
@ -1211,7 +1171,7 @@ class Spotify:
plid = self._get_id("playlist", playlist_id)
ftracks = [self._get_uri("track", tid) for tid in items]
return self._post(
f"playlists/{plid}/items",
f"playlists/{plid}/tracks",
payload=ftracks,
position=position,
)
@ -1227,7 +1187,7 @@ class Spotify:
ftracks = [self._get_uri("track", tid) for tid in items]
payload = {"uris": ftracks}
return self._put(
f"playlists/{plid}/items", payload=payload
f"playlists/{plid}/tracks", payload=payload
)
def playlist_reorder_items(
@ -1258,7 +1218,7 @@ class Spotify:
if snapshot_id:
payload["snapshot_id"] = snapshot_id
return self._put(
f"playlists/{plid}/items", payload=payload
f"playlists/{plid}/tracks", payload=payload
)
def playlist_remove_all_occurrences_of_items(
@ -1275,11 +1235,11 @@ class Spotify:
plid = self._get_id("playlist", playlist_id)
ftracks = [self._get_uri("track", tid) for tid in items]
payload = {"items": [{"uri": track} for track in ftracks]}
payload = {"tracks": [{"uri": track} for track in ftracks]}
if snapshot_id:
payload["snapshot_id"] = snapshot_id
return self._delete(
f"playlists/{plid}/items", payload=payload
f"playlists/{plid}/tracks", payload=payload
)
def playlist_remove_specific_occurrences_of_items(
@ -1306,14 +1266,14 @@ class Spotify:
"positions": tr["positions"],
}
)
payload = {"items": ftracks}
payload = {"tracks": ftracks}
if snapshot_id:
payload["snapshot_id"] = snapshot_id
return self._delete(
f"playlists/{plid}/items", payload=payload
f"playlists/{plid}/tracks", payload=payload
)
def current_user_follow_playlist(self, playlist_id):
def current_user_follow_playlist(self, playlist_id, public=True):
"""
Add the current authenticated user as a follower of a playlist.
@ -1321,7 +1281,10 @@ class Spotify:
- playlist_id - the id of the playlist
"""
return self._put("me/library", uris=self._get_uri("playlist", playlist_id))
return self._put(
f"playlists/{playlist_id}/followers",
payload={"public": public}
)
def playlist_is_following(
self, playlist_id, user_ids
@ -1335,27 +1298,9 @@ class Spotify:
if they follow the playlist. Maximum: 5 ids.
"""
warnings.warn(
"You're using `playlist_is_following(..., user_ids=...)`, "
"which is marked as deprecated by Spotify. Use ",
"current_user_follow_playlist(...) instead.",
DeprecationWarning,
)
endpoint = f"playlists/{playlist_id}/followers/contains?ids={','.join(user_ids)}"
return self._get(endpoint)
def current_user_saved_items(self, uris):
"""
Check if the current user is following the given artists, users, or playlists
Parameters:
- uris - a list of URIs to check for following status. Maximum: 40 ids.
"""
valid_uris = [uri for uri in uris if self._is_uri(uri)]
return self._get("me/library/contains", uris=",".join(valid_uris))
def me(self):
""" Get detailed profile information about the current user.
An alias for the 'current_user' method.
@ -1402,8 +1347,8 @@ class Spotify:
- albums - a list of album URIs, URLs or IDs
"""
alist = [self._get_uri("album", a) for a in albums]
return self._put("me/library", uris=",".join(alist))
alist = [self._get_id("album", a) for a in albums]
return self._put("me/albums?ids=" + ",".join(alist))
def current_user_saved_albums_delete(self, albums=[]):
""" Remove one or more albums from the current user's
@ -1412,8 +1357,8 @@ class Spotify:
Parameters:
- albums - a list of album URIs, URLs or IDs
"""
alist = [self._get_uri("album", a) for a in albums]
return self._delete("me/library", uris=",".join(alist))
alist = [self._get_id("album", a) for a in albums]
return self._delete("me/albums/?ids=" + ",".join(alist))
def current_user_saved_albums_contains(self, albums=[]):
""" Check if one or more albums is already saved in
@ -1422,8 +1367,8 @@ class Spotify:
Parameters:
- albums - a list of album URIs, URLs or IDs
"""
alist = [self._get_uri("album", a) for a in albums]
return self._get("me/library/contains", uris=",".join(alist))
alist = [self._get_id("album", a) for a in albums]
return self._get("me/albums/contains?ids=" + ",".join(alist))
def current_user_saved_tracks(self, limit=20, offset=0, market=None):
""" Gets a list of the tracks saved in the current authorized user's
@ -1446,8 +1391,8 @@ class Spotify:
"""
tlist = []
if tracks is not None:
tlist = [self._get_uri("track", t) for t in tracks]
return self._put("me/library", uris=",".join(tlist))
tlist = [self._get_id("track", t) for t in tracks]
return self._put("me/tracks/?ids=" + ",".join(tlist))
def current_user_saved_tracks_delete(self, tracks=None):
""" Remove one or more tracks from the current user's
@ -1458,8 +1403,8 @@ class Spotify:
"""
tlist = []
if tracks is not None:
tlist = [self._get_uri("track", t) for t in tracks]
return self._delete("me/library", uris=",".join(tlist))
tlist = [self._get_id("track", t) for t in tracks]
return self._delete("me/tracks/?ids=" + ",".join(tlist))
def current_user_saved_tracks_contains(self, tracks=None):
""" Check if one or more tracks is already saved in
@ -1470,8 +1415,8 @@ class Spotify:
"""
tlist = []
if tracks is not None:
tlist = [self._get_uri("track", t) for t in tracks]
return self._get("me/library/contains", uris=",".join(tlist))
tlist = [self._get_id("track", t) for t in tracks]
return self._get("me/tracks/contains?ids=" + ",".join(tlist))
def current_user_saved_episodes(self, limit=20, offset=0, market=None):
""" Gets a list of the episodes saved in the current authorized user's
@ -1494,8 +1439,8 @@ class Spotify:
"""
elist = []
if episodes is not None:
elist = [self._get_uri("episode", e) for e in episodes]
return self._put("me/library", uris=",".join(elist))
elist = [self._get_id("episode", e) for e in episodes]
return self._put("me/episodes/?ids=" + ",".join(elist))
def current_user_saved_episodes_delete(self, episodes=None):
""" Remove one or more episodes from the current user's
@ -1506,8 +1451,8 @@ class Spotify:
"""
elist = []
if episodes is not None:
elist = [self._get_uri("episode", e) for e in episodes]
return self._delete("me/library", uris=",".join(elist))
elist = [self._get_id("episode", e) for e in episodes]
return self._delete("me/episodes/?ids=" + ",".join(elist))
def current_user_saved_episodes_contains(self, episodes=None):
""" Check if one or more episodes is already saved in
@ -1539,8 +1484,8 @@ class Spotify:
Parameters:
- shows - a list of show URIs, URLs or IDs
"""
slist = [self._get_uri("show", s) for s in shows]
return self._put("me/library", uris=",".join(slist))
slist = [self._get_id("show", s) for s in shows]
return self._put("me/shows?ids=" + ",".join(slist))
def current_user_saved_shows_delete(self, shows=[]):
""" Remove one or more shows from the current user's
@ -1549,8 +1494,8 @@ class Spotify:
Parameters:
- shows - a list of show URIs, URLs or IDs
"""
slist = [self._get_uri("show", s) for s in shows]
return self._delete("me/library", uris=",".join(slist))
slist = [self._get_id("show", s) for s in shows]
return self._delete("me/shows/?ids=" + ",".join(slist))
def current_user_saved_shows_contains(self, shows=[]):
""" Check if one or more shows is already saved in
@ -1559,8 +1504,8 @@ class Spotify:
Parameters:
- shows - a list of show URIs, URLs or IDs
"""
slist = [self._get_uri("show", s) for s in shows]
return self._get("me/library/contains", uris=",".join(slist))
slist = [self._get_id("show", s) for s in shows]
return self._get("me/shows/contains?ids=" + ",".join(slist))
def current_user_followed_artists(self, limit=20, after=None):
""" Gets a list of the artists followed by the current authorized user
@ -1583,11 +1528,11 @@ class Spotify:
Parameters:
- ids - a list of artist URIs, URLs or IDs
"""
ulist = []
idlist = []
if ids is not None:
ulist = [self._get_uri("artist", i) for i in ids]
idlist = [self._get_id("artist", i) for i in ids]
return self._get(
"me/library/contains", uris=",".join(ulist)
"me/following/contains", ids=",".join(idlist), type="artist"
)
def current_user_following_users(self, ids=None):
@ -1598,11 +1543,11 @@ class Spotify:
Parameters:
- ids - a list of user URIs, URLs or IDs
"""
ulist = []
idlist = []
if ids is not None:
ulist = [self._get_uri("user", i) for i in ids]
idlist = [self._get_id("user", i) for i in ids]
return self._get(
"me/library/contains", uris=",".join(ulist)
"me/following/contains", ids=",".join(idlist), type="user"
)
def current_user_top_artists(
@ -1659,32 +1604,28 @@ class Spotify:
Parameters:
- ids - a list of artist IDs
"""
alist = [self._get_uri("artist", a) for a in ids]
return self._put("me/library", uris=",".join(alist))
return self._put("me/following?type=artist&ids=" + ",".join(ids))
def user_follow_users(self, ids=[]):
""" Follow one or more users
Parameters:
- ids - a list of user IDs
"""
ulist = [self._get_uri("user", a) for a in ids]
return self._put("me/library", uris=",".join(ulist))
return self._put("me/following?type=user&ids=" + ",".join(ids))
def user_unfollow_artists(self, ids=[]):
""" Unfollow one or more artists
Parameters:
- ids - a list of artist IDs
"""
alist = [self._get_uri("artist", a) for a in ids]
return self._delete("me/library", uris=",".join(alist))
return self._delete("me/following?type=artist&ids=" + ",".join(ids))
def user_unfollow_users(self, ids=[]):
""" Unfollow one or more users
Parameters:
- ids - a list of user IDs
"""
ulist = [self._get_uri("user", a) for a in ids]
return self._delete("me/library", uris=",".join(ulist))
return self._delete("me/following?type=user&ids=" + ",".join(ids))
def featured_playlists(
self, locale=None, country=None, timestamp=None, limit=20, offset=0
@ -1740,11 +1681,6 @@ class Spotify:
(the first object). Use with limit to get the next set of
items.
"""
warnings.warn(
"You're using `new_release(...)`, "
"which is marked as deprecated by Spotify.",
DeprecationWarning,
)
return self._get(
"browse/new-releases", country=country, limit=limit, offset=offset
)
@ -1760,11 +1696,6 @@ class Spotify:
language code and an ISO 3166-1 alpha-2 country code, joined
by an underscore.
"""
warnings.warn(
"You're using `category(...)`, "
"which is marked as deprecated by Spotify.",
DeprecationWarning,
)
return self._get(
"browse/categories/" + category_id,
country=country,
@ -1787,11 +1718,6 @@ class Spotify:
(the first object). Use with limit to get the next set of
items.
"""
warnings.warn(
"You're using `categories(...)`, "
"which is marked as deprecated by Spotify.",
DeprecationWarning,
)
return self._get(
"browse/categories",
country=country,

View File

@ -8,9 +8,6 @@ commands=python -m unittest discover -v tests/unit
max-line-length = 99
exclude=
.git,
.venv,
build,
dist,
docs,
examples,
spotipy.egg-info
examples