mirror of
https://github.com/spotipy-dev/spotipy.git
synced 2026-06-19 01:03:53 +00:00
a7b25d0f6e
* Refactor functions into static methods of AuthBase
Functions is_token_expired was a loose function that was added to
SpotifyClientCredentials, SpotifyPKCE, and SpotifyImplicitGrant classes
through a method on each class that passed the call to the loose
is_token_expired function. Function _is_scope_subset was duplicated on
SpotifyClientCredentials, SpotifyPKCE, and SpotifyImplicitGrant classes.
Refactoring is_token_expired and _is_scope_subset to be static methods
on SpotifyAuthBase means both are available for all derived classes and
require less boilerplate.
* Create CacheHandler to abstract caching tokens
Previous code only supported caching to and from json files in a given
directory. In addition, the get_cached_token method mixed getting and
getting the token in the same method.
This change creates a CacheHandler class to abstract out the caching
implementation and allow the user to cache tokens in any way they
see fit. For example, the user could create a MongoCache class to store
and retrieve tokens from a Mongo database and specify that
cache_handler=MongoCache in creating an auth_manager object.
To implement the CacheHandler abstraction, the following changes are
implemented:
The validation code in each get_cached_token method in SpotifyOAuth,
SpotifyPKCE, and SpotifyImplicitGrant is moved into a validate_token
method in each class.
The CacheHandler class is created with get_cached_token and
save_token_to_cache methods.
Previous instances of self.get_cached_token() are now replaced with
self.validate_token(self.cache_handler.get_cached_token()) to preserve
the getting and validation behaviour.
cache_handler is added as an argument to SpotifyOAuth, SpotifyPKCE, and
SpotifyImplicitGrant. Specifying a cache_handler now overrides any
specification of cache_path and/or username.
To preserve backwards compatibility in handling cache files, a
CacheFileHandler class extending CacheHandler is created. If no
cache_handler is specified, the cache_path and username arguments are
used to create an instance of CacheFileHandler. It may be worth
deprecating the cache_path and username fields in favour of using
CacheFileHandler.
Tests are also modified and extended to cover the new functionality. A
sample MemoryCache CacheHandler is created to test getting and saving to
a custom CacheHandler.
* Fix cache_handler subclass check for Python 2
* Split assert message to fix line over max length
* Split cache handlers into cache_handler.py
* flake8 and autopep fixes
* Fix init to allow importing CacheHandler
When spotipy is installed as a package, CacheHandler is not accessible
from a `from spotipy import CacheHandler` statement because the import
is not specified in the __init__.py file. This commit adds CacheHandler
and CacheFileHandler to the init file so the user can import them.
* flake8 fix
* Add cache_path & username deprecation warning
When cache_path or username are specified in the constructors of
SpotifyOAuth, SpotifyPKCE, or SpotifyImplicitGrant, the constructor
creates a CacheFileHandler instance under the hood. The user is
currently able to create a CacheFileHandler instance in two ways:
1. By creating it outside the SpotifyOAuth (or etc.) constructor and
passing it as the cache_handler
2. By passing cache_path and username to the constructor
Ideally, there would be one and only one obvious way to specify a
CacheFileHandler instance and the cache_handler approach allows any
CacheHandler to be used, so passing the cache_path or username to the
constructor should be deprecated.
* Update flask example to use CacheFileHandler
* Update changelog with deprecation warning info
* Restore token caching methods on auth_manager
Change
|
||
|---|---|---|
| .. | ||
| add_a_saved_album.py | ||
| add_a_saved_track.py | ||
| add_tracks_to_playlist.py | ||
| app.py | ||
| artist_albums.py | ||
| artist_discography.py | ||
| artist_recommendations.py | ||
| audio_analysis_for_track.py | ||
| audio_features_for_track.py | ||
| audio_features.py | ||
| change_playlist_details.py | ||
| client_credentials_flow.py | ||
| contains_a_saved_track.py | ||
| create_playlist.py | ||
| delete_a_saved_track.py | ||
| headless.py | ||
| multiple_accounts.py | ||
| my_playlists.py | ||
| my_top_artists.py | ||
| my_top_tracks.py | ||
| player.py | ||
| playlist_all_non_local_tracks.py | ||
| playlist_tracks.py | ||
| read_a_playlist.py | ||
| remove_specific_tracks_from_playlist.py | ||
| remove_tracks_from_playlist.py | ||
| replace_tracks_in_playlist.py | ||
| search.py | ||
| show_album.py | ||
| show_artist_top_tracks.py | ||
| show_artist.py | ||
| show_featured_playlists.py | ||
| show_my_saved_tracks.py | ||
| show_new_releases.py | ||
| show_related.py | ||
| show_track_info.py | ||
| show_tracks.py | ||
| show_user.py | ||
| simple0.py | ||
| simple1.py | ||
| simple2.py | ||
| simple3.py | ||
| simple4.py | ||
| test.py | ||
| title_chain.py | ||
| tracks.py | ||
| user_playlists_contents.py | ||
| user_playlists.py | ||
| user_public_playlists.py | ||
| user_saved_albums_delete.py | ||