U 'ci+@sdddddddgZddlZddlZddlZddlZdd lmZdd lmZe e Z Gd ddZ Gd dde Z Gd dde ZGddde ZGddde ZGddde ZGddde ZdS) CacheHandlerCacheFileHandlerDjangoSessionCacheHandlerFlaskSessionCacheHandlerMemoryCacheHandlerRedisCacheHandlerMemcacheCacheHandlerN) RedisError)CLIENT_CREDS_ENV_VARSc@s eZdZdZddZddZdS)ra An abstraction layer for handling the caching and retrieval of authorization tokens. Custom extensions of this class must implement get_cached_token and save_token_to_cache methods with the same input and output structure as the CacheHandler class. cCs tdS)z@ Get and return a token_info dictionary object. NNotImplementedErrorselfr9/tmp/pip-unpacked-wheel-5vxoxy0m/spotipy/cache_handler.pyget_cached_token szCacheHandler.get_cached_tokencCs tdS)zS Save a token_info dictionary object to the cache and return None. Nr r token_inforrrsave_token_to_cache'sz CacheHandler.save_token_to_cacheN)__name__ __module__ __qualname____doc__rrrrrrrs c@s*eZdZdZd ddZddZddZdS) rzd Handles reading and writing cached Spotify authorization tokens as json files on disk. NcCsF||_|r||_n0d}|p&ttd}|r<|dt|7}||_dS)a Parameters: * cache_path: May be supplied, will otherwise be generated (takes precedence over `username`) * username: May be supplied or set as environment variable (will set `cache_path` to `.cache-{username}`) * encoder_cls: May be supplied as a means of overwriting the default serializer used for writing tokens to disk z.cacheZclient_username-N) encoder_cls cache_pathosgetenvr str)rrusernamerrrr__init__4s zCacheFileHandler.__init__c Csd}z0t|jdd}|}W5QRXt|}Wnztk r}z6|jtjkrft d|jnt d|jW5d}~XYn(tj k rt d|jYnX|S)Nutf-8encodingzcache does not exist at: zCouldn't read cache at: z$Couldn't decode JSON from cache at: ) openrreadjsonloadsOSErrorerrnoENOENTloggerdebugwarningJSONDecodeError)rrfZtoken_info_stringerrorrrrrKs "z!CacheFileHandler.get_cached_tokenc CszDt|jddd}|tj||jdW5QRXt|jdWnJtk rjt d|jYn&t k rt d|jYnXdS)Nwr!r")clsiz"Couldn't write token to cache at: z+Couldn't set permissions to cache file at: ) r$rwriter&dumpsrrchmodr(r+r-FileNotFoundError)rrr/rrrr]s z$CacheFileHandler.save_token_to_cache)NNNrrrrr rrrrrrr.s c@s*eZdZdZd ddZddZddZdS) rz A cache handler that simply stores the token info in memory as an instance attribute of this class. The token info will be lost when this instance is freed. NcCs ||_dS)zg Parameters: * token_info: The token info to store in memory. Can be None. Nrrrrrr pszMemoryCacheHandler.__init__cCs|jSNr8r rrrrwsz#MemoryCacheHandler.get_cached_tokencCs ||_dSr9r8rrrrrzsz&MemoryCacheHandler.save_token_to_cache)Nr7rrrrris c@s(eZdZdZddZddZddZdS) rz A cache handler that stores the token info in the session framework provided by Django. Read more at https://docs.djangoproject.com/en/3.2/topics/http/sessions/ cCs ||_dS)z Parameters: * request: HttpRequest object provided by Django for every incoming request N)request)rr:rrrr sz"DjangoSessionCacheHandler.__init__cCs8d}z|jjd}Wntk r2tdYnX|SNrzToken not found in the session)r:sessionKeyErrorr+r,rrrrrs z*DjangoSessionCacheHandler.get_cached_tokenc CsHz||jjd<Wn2tk rB}ztd|W5d}~XYnXdSNrError saving token to cache: )r:r< Exceptionr+r-rrerrrrsz-DjangoSessionCacheHandler.save_token_to_cacheNr7rrrrr~s c@s(eZdZdZddZddZddZdS) rzd A cache handler that stores the token info in the session framework provided by flask. cCs ||_dSr9)r<)rr<rrrr sz!FlaskSessionCacheHandler.__init__cCs6d}z|jd}Wntk r0tdYnX|Sr;)r<r=r+r,rrrrrs z)FlaskSessionCacheHandler.get_cached_tokenc CsFz||jd<Wn2tk r@}ztd|W5d}~XYnXdSr>)r<r@r+r-rArrrrsz,FlaskSessionCacheHandler.save_token_to_cacheNr7rrrrrs c@s*eZdZdZd ddZddZddZdS) rzB A cache handler that stores the token info in the Redis. NcCs||_|r|nd|_dS)a Parameters: * redis: Redis object provided by redis-py library (https://github.com/redis/redis-py) * key: May be supplied, will otherwise be generated (takes precedence over `token_info`) rN)rediskey)rrCrDrrrr szRedisCacheHandler.__init__c Cs^d}z"|j|j}|r$t|WSWn2tk rX}ztd|W5d}~XYnX|S)Nz Error getting token from cache: )rCgetrDr&r'r r+r-rArrrrs"z"RedisCacheHandler.get_cached_tokenc CsRz|j|jt|Wn2tk rL}ztd|W5d}~XYnXdS)Nr?)rCsetrDr&r4r r+r-rArrrrsz%RedisCacheHandler.save_token_to_cache)Nr7rrrrrs  c@s0eZdZdZd ddddZddZdd ZdS) rzWA Cache handler that stores the token info in Memcache using the pymemcache client N)returncCs||_|r|nd|_dS)a* Parameters: * memcache: memcache client object provided by pymemcache (https://pymemcache.readthedocs.io/en/latest/getting_started.html) * key: May be supplied, will otherwise be generated (takes precedence over `token_info`) rN)memcacherD)rrHrDrrrr szMemcacheCacheHandler.__init__c Csjddlm}z&|j|j}|r0t|WSWn2|k rd}zt d|W5d}~XYnXdS)Nr MemcacheErrorzError getting token to cache: ) pymemcacherJrHrErDr&r'decoder+r-)rrJrrBrrrrs z%MemcacheCacheHandler.get_cached_tokenc Cs^ddlm}z|j|jt|Wn2|k rX}ztd|W5d}~XYnXdS)NrrIr?) rKrJrHrFrDr&r4r+r-)rrrJrBrrrrs  z(MemcacheCacheHandler.save_token_to_cache)Nr7rrrrrs  )__all__r)r&loggingrrCr Z spotipy.utilr getLoggerrr+rrrrrrrrrrrs*    ; "