spotifywebapiPython 1.0.178__py3-none-any.whl → 1.0.180__py3-none-any.whl

spotifywebapipython/spotifyclient.py

@@ -1164,6 +1164,7 @@ class SpotifyClient:
         - 500 Internal Server Error. You should never receive this error because our clever coders catch them all ... but if you are unlucky enough to get one, please report it to us through a comment at the bottom of this page.  
         - 502 Bad Gateway - The server was acting as a gateway or proxy and received an invalid response from the upstream server.  
         - 503 Service Unavailable - The server is currently unable to handle the request due to a temporary condition which will be alleviated after some delay. You can choose to resend the request again.  
+        - 504 Gateway Timeout - The server is currently unable to handle the request due to a temporary condition which will be alleviated after some delay. You can choose to resend the request again.  
         """
         apiMethodName:str = 'MakeRequest'
         apiMethodParms:SIMethodParmListContext = None
@@ -1228,49 +1229,86 @@ class SpotifyClient:
             # in the logic below, ensure that ALL urllib3.request method calls conform to version 1.26.18.
             # urllib3 version 2.0 is not supported!  see internal developer notes for more details.
 
-            # call the appropriate poolmanager request method.
-            if msg.HasUrlParameters:
+            # request retry loop for failed requests that are temporary in nature (504 Gateway Timeout, etc).
+            loopTotalDelay:float = 0
+            LOOP_DELAY:float = 0.200
+            LOOP_TIMEOUT:float = 1.000
+            while True:
+
+                # call the appropriate poolmanager request method.
+                if msg.HasUrlParameters:
                 
-                # add querystring parameters to url; if url already has a partial parm
-                # string (e.g. has a '?xxx=...') then use the append separator (e.g. '...&xxx=...').
-                urlQS:str = urlencode(msg.UrlParameters)
-                urlParmSep:str = '?'
-                if (url.find('?') > 0):
-                    urlParmSep = '&'
-                url = url + urlParmSep + urlQS
+                    # add querystring parameters to url; if url already has a partial parm
+                    # string (e.g. has a '?xxx=...') then use the append separator (e.g. '...&xxx=...').
+                    urlQS:str = urlencode(msg.UrlParameters)
+                    urlParmSep:str = '?'
+                    if (url.find('?') > 0):
+                        urlParmSep = '&'
+                    url = url + urlParmSep + urlQS
                 
-                _logsi.LogDictionary(SILevel.Verbose, "SpotifyClient http request: '%s' (with urlparms)" % (url), msg.UrlParameters, prettyPrint=True)
-                response = self._Manager.request_encode_url(method, url, headers=msg.RequestHeaders)
+                    _logsi.LogDictionary(SILevel.Verbose, "SpotifyClient http request: '%s' (with urlparms)" % (url), msg.UrlParameters, prettyPrint=True)
+                    response = self._Manager.request_encode_url(method, url, headers=msg.RequestHeaders)
                 
-            elif msg.HasRequestData:
+                elif msg.HasRequestData:
 
-                if msg.IsRequestDataEncoded:
+                    if msg.IsRequestDataEncoded:
 
-                    _logsi.LogText(SILevel.Verbose, "SpotifyClient http request: '%s' (with body encoded)" % (url), msg.RequestData)
-                    response = self._Manager.request(method, url, body=msg.RequestData, headers=msg.RequestHeaders)
+                        _logsi.LogText(SILevel.Verbose, "SpotifyClient http request: '%s' (with body encoded)" % (url), msg.RequestData)
+                        response = self._Manager.request(method, url, body=msg.RequestData, headers=msg.RequestHeaders)
                    
-                else:
+                    else:
 
-                    _logsi.LogDictionary(SILevel.Verbose, "SpotifyClient http request: '%s' (with body)" % (url), msg.RequestData, prettyPrint=True)
-                    response = self._Manager.request_encode_body(method, url, fields=msg.RequestData, headers=msg.RequestHeaders, encode_multipart=False)
+                        _logsi.LogDictionary(SILevel.Verbose, "SpotifyClient http request: '%s' (with body)" % (url), msg.RequestData, prettyPrint=True)
+                        response = self._Manager.request_encode_body(method, url, fields=msg.RequestData, headers=msg.RequestHeaders, encode_multipart=False)
                                     
-            elif msg.HasRequestJson:
+                elif msg.HasRequestJson:
 
-                _logsi.LogDictionary(SILevel.Verbose, "SpotifyClient http request: '%s' (with json body)" % (url), msg.RequestJson, prettyPrint=True)
+                    _logsi.LogDictionary(SILevel.Verbose, "SpotifyClient http request: '%s' (with json body)" % (url), msg.RequestJson, prettyPrint=True)
 
-                # add content-type=json header and convert the dictionary to json format.
-                if not ("content-type" in map(str.lower, msg.RequestHeaders.keys())):
-                    #headers = HTTPHeaderDict(headers)
-                    msg.RequestHeaders["Content-Type"] = "application/json"
-                reqBody:str = json.dumps(msg.RequestJson, separators=(",", ":"), ensure_ascii=False).encode("utf-8")
-                _logsi.LogBinary(SILevel.Debug, "SpotifyClient http request JSON body", reqBody)
-                response = self._Manager.request(method, url, body=reqBody, headers=msg.RequestHeaders)
+                    # add content-type=json header and convert the dictionary to json format.
+                    if not ("content-type" in map(str.lower, msg.RequestHeaders.keys())):
+                        #headers = HTTPHeaderDict(headers)
+                        msg.RequestHeaders["Content-Type"] = "application/json"
+                    reqBody:str = json.dumps(msg.RequestJson, separators=(",", ":"), ensure_ascii=False).encode("utf-8")
+                    _logsi.LogBinary(SILevel.Debug, "SpotifyClient http request JSON body", reqBody)
+                    response = self._Manager.request(method, url, body=reqBody, headers=msg.RequestHeaders)
                 
-            else:
+                else:
+
+                    _logsi.LogDictionary(SILevel.Verbose, "SpotifyClient http request: '%s' (no body)" % (url), msg.RequestData, prettyPrint=True)
+                    response = self._Manager.request(method, url, headers=msg.RequestHeaders)
+
+                # TEST TODO - for testing retry logic.
+                # if (response.status_code == 200) and (loopTotalDelay <= 0.200):
+                #     _logsi.LogWarning("TEST TODO - Testing Spotify Web API 504 status (Gateway timeout) condition ...", colorValue=SIColors.Red)
+                #     response.status_code = 404
+                #     response.reason = "URL Not Found"
+                # if (response.status_code == 200) and (loopTotalDelay <= 0.200):
+                #     _logsi.LogWarning("TEST TODO - Testing Spotify Web API 504 status (Gateway timeout) condition ...", colorValue=SIColors.Red)
+                #     response.status_code = 504
+                #     response.reason = "Gateway Timeout"
+
+                # check for errors that are temporary in nature; for these errors, we will retry the 
+                # request for a specified number of tries with a small wait period in between.
+                if (response.status == 504):
+
+                    # only retry so many times before we give up;
+                    if (loopTotalDelay >= LOOP_TIMEOUT):
+                        raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_WEB_API_RETRY_TIMEOUT % (loopTotalDelay), None, logsi=_logsi)
+
+                    # trace.
+                    _logsi.LogVerbose(SAAppMessages.MSG_SPOTIFY_WEB_API_RETRY_RESPONSE_STATUS % (response.status, response.reason), colorValue=SIColors.Red)
+
+                    # wait just a bit between requests.
+                    _logsi.LogVerbose(SAAppMessages.MSG_SPOTIFY_WEB_API_RETRY_REQUEST_DELAY % (LOOP_DELAY))
+                    time.sleep(LOOP_DELAY)
+                    loopTotalDelay = loopTotalDelay + LOOP_DELAY
+
+                else:
+
+                    # otherwise, break out of retry loop and process response.
+                    break
 
-                _logsi.LogDictionary(SILevel.Verbose, "SpotifyClient http request: '%s' (no body)" % (url), msg.RequestData, prettyPrint=True)
-                response = self._Manager.request(method, url, headers=msg.RequestHeaders)
-                
             # process based upon response status code; some requests will not return response data.
             # I know this could have been simplified, but I broke it down into possible return code ranges.
             if response.status >= 200 and response.status <= 299:
@@ -6320,9 +6358,9 @@ class SpotifyClient:
         deviceId:str|SpotifyConnectDevice|None=None,
         ) -> PlayerPlayState:
         """
-        Get information about the current playback state of the device, including track or episode, 
-        and progress. For Sonos devices, this will return the playstate of the device instead of the
-        active Spotify Web API player playstate.
+        Get information about the current playback state, including track or episode, and progress. 
+        If the Spotify Web API reports nothing as playing, then the device-specific playback state
+        is returned (if one exists).  
 
         This method requires the `user-read-playback-state` scope.
         
@@ -6365,7 +6403,7 @@ class SpotifyClient:
             # trace.
             apiMethodParms = _logsi.EnterMethodParmList(SILevel.Debug, apiMethodName)
             apiMethodParms.AppendKeyValue("deviceId", deviceId)
-            _logsi.LogMethodParmList(SILevel.Verbose, "Get the current playback state of the device", apiMethodParms)
+            _logsi.LogMethodParmList(SILevel.Verbose, "Get the current Spotify playback state, with device fallback", apiMethodParms)
 
             # resolve the device object; no need to activate it for what we want here.
             # this will also set the currently active device in the devices cache, as well as
@@ -6375,15 +6413,20 @@ class SpotifyClient:
             # get cached Spotify Web API playerstate (_ResolveDeviceObject method just refreshed it).
             result = self.GetPlayerPlaybackState(refresh=False)
 
-            # is this a Sonos device?
-            if (scDevice is not None) and (scDevice.IsSonos):
+            # did Spotify return a playstate?
+            if (result.IsEmpty):
+
+                # no; we will now check for a device-specific playstate.
+
+                # is this a Sonos device?
+                if (scDevice is not None) and (scDevice.IsSonos):
 
-                # get Sonos playback state via Sonos Controller instance.
-                playerStateSonos:PlayerPlayState = self.GetPlayerPlaybackStateSonos(scDevice)
+                    # get Sonos playback state via Sonos Controller instance.
+                    playerStateSonos:PlayerPlayState = self.GetPlayerPlaybackStateSonos(scDevice)
 
-                # return the device playstate.
-                _logsi.LogVerbose("Sonos device %s playstate will be returned" % (scDevice.Title))
-                result = playerStateSonos
+                    # return the device playstate.
+                    _logsi.LogVerbose("Sonos device %s playstate will be returned" % (scDevice.Title))
+                    result = playerStateSonos
 
             # trace.
             _logsi.LogObject(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
@@ -13467,7 +13510,13 @@ class SpotifyClient:
                 # note that for other brands, the Spotify Web API transfer playback takes care of
                 # pausing the player since everything is under the Spotify players control.
                 if (scDeviceFrom is not None) and (scDeviceFrom.IsSonos):
-                    self.PlayerMediaPause(scDeviceFrom)
+                    #self.PlayerMediaPause(scDeviceFrom)
+                    try:
+                        self.PlayerMediaPause(scDeviceFrom)
+                    except:
+                        # ignore exceptions, since this is a convenience call to pause the from player.
+                        _logsi.LogVerbose("Ignoring previous exception, since this is a convenience call to pause the from player")
+                        pass
 
             # resolve the device object from the device id; activate if it's dormant.
             # for transfer playback, we will always activate the device.

spotifywebapipython/spotifywebplayertoken.py

@@ -7,6 +7,7 @@ import requests
 import time
 
 # our package imports.
+from .saappmessages import SAAppMessages
 from .spotifyapierror import SpotifyApiError
 from .const import (
     SPOTIFY_WEBUI_URL_BASE,
@@ -14,7 +15,7 @@ from .const import (
 )
 
 # get smartinspect logger reference; create a new session for this module name.
-from smartinspectpython.siauto import SIAuto, SILevel, SISession, SIMethodParmListContext
+from smartinspectpython.siauto import SIAuto, SILevel, SISession, SIMethodParmListContext, SIColors
 import logging
 _logsi:SISession = SIAuto.Si.GetSession(__name__)
 if (_logsi == None):
@@ -276,17 +277,17 @@ class SpotifyWebPlayerToken:
                 "productType": "web_player",
             }
 
-            # retry if gateway timeout error is returned.
+            # trace.
+            _logsi.LogVerbose("Exchanging Spotify Web Player cookie credentials for OAuth2 authorization access token")
+            _logsi.LogDictionary(SILevel.Verbose, "%s http request: \"%s\" (cookies)" % (tracePrefix, SPOTIFY_WEBUI_URL_GET_ACCESS_TOKEN), reqCookies)
+            _logsi.LogDictionary(SILevel.Debug, "%s http request: \"%s\" (headers)" % (tracePrefix, SPOTIFY_WEBUI_URL_GET_ACCESS_TOKEN), reqHeaders)
+            _logsi.LogDictionary(SILevel.Verbose, "%s http request: \"%s\" (parms)" % (tracePrefix, SPOTIFY_WEBUI_URL_GET_ACCESS_TOKEN), reqParms)
+
+            # request retry loop for failed requests that are temporary in nature (504 Gateway Timeout, etc).
             loopTotalDelay:float = 0
-            LOOP_DELAY:float = 0.100
-            LOOP_TIMEOUT:float = 0.500
+            LOOP_DELAY:float = 0.200
+            LOOP_TIMEOUT:float = 1.000
             while True:
-                        
-                # trace.
-                _logsi.LogVerbose("Exchanging Spotify Web Player cookie credentials for OAuth2 authorization access token")
-                _logsi.LogDictionary(SILevel.Verbose, "%s http request: \"%s\" (cookies)" % (tracePrefix, SPOTIFY_WEBUI_URL_GET_ACCESS_TOKEN), reqCookies)
-                _logsi.LogDictionary(SILevel.Debug, "%s http request: \"%s\" (headers)" % (tracePrefix, SPOTIFY_WEBUI_URL_GET_ACCESS_TOKEN), reqHeaders)
-                _logsi.LogDictionary(SILevel.Verbose, "%s http request: \"%s\" (parms)" % (tracePrefix, SPOTIFY_WEBUI_URL_GET_ACCESS_TOKEN), reqParms)
             
                 # convert the spotify web player cookie credentials to an access token.
                 response = session.get(
@@ -297,42 +298,58 @@ class SpotifyWebPlayerToken:
                     allow_redirects=False,
                     )
 
-                # trace.
-                if _logsi.IsOn(SILevel.Debug):
-                    _logsi.LogObject(SILevel.Debug, "%s http response object - type=\"%s\", module=\"%s\"" % (tracePrefix, type(response).__name__, type(response).__module__), response)
-
-                # trace.
-                if _logsi.IsOn(SILevel.Debug):
-                    _logsi.LogObject(SILevel.Debug, "%s http response [%s-%s] (response)" % (tracePrefix, response.status_code, response.reason), response)
-                    if (response.headers):
-                        _logsi.LogCollection(SILevel.Debug, "%s http response [%s-%s] (headers)" % (tracePrefix, response.status_code, response.reason), response.headers.items())
-
-                # raise exception if we could not get the access token, or if a redirect occured.
-                # the redirect usually indicates the sp_dc and sp_key are expired, and it's redirecting to a login page.
-                respHdrLocation:str = response.headers.get("Location", None)
-                if (response.status_code == 302 and respHdrLocation == "/get_access_token?reason=transport&productType=web_player&_authfailed=1"):
-                    raise SpotifyApiError("Unsuccessful token request, received status 302 and Location header \"%s\". sp_dc and sp_key could be expired. Please update values in token storage file." % (respHdrLocation), None, logsi=_logsi)
-
-                # if successful request, then break out of the retry loop.
-                if response.status_code == 200:
-                    _logsi.LogVerbose("Token exchange request was successful within %f seconds from initial request; processing results" % (loopTotalDelay))
-                    break
+                # TEST TODO - for testing retry logic.
+                # if (response.status_code == 200) and (loopTotalDelay <= 0.200):
+                #     _logsi.LogWarning("TEST TODO - Testing Spotify Web API 504 status (Gateway timeout) condition ...", colorValue=SIColors.Red)
+                #     response.status_code = 404
+                #     response.reason = "URL Not Found"
+                # if (response.status_code == 200) and (loopTotalDelay <= 0.200):
+                #     _logsi.LogWarning("TEST TODO - Testing Spotify Web API 504 status (Gateway timeout) condition ...", colorValue=SIColors.Red)
+                #     response.status_code = 504
+                #     response.reason = "Gateway Timeout"
+
+                # check for errors that are temporary in nature; for these errors, we will retry the 
+                # request for a specified number of tries with a small wait period in between.
+                if (response.status_code == 504):
+
+                    # only retry so many times before we give up.
+                    if (loopTotalDelay >= LOOP_TIMEOUT):
+                        raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_WEB_API_RETRY_TIMEOUT % (loopTotalDelay), None, logsi=_logsi)
 
-                # any other status code besides 504 (gateway timeout) is an exception event!
-                if response.status_code != 504:
-                    raise SpotifyApiError("Token exchange request failed: %s - %s" % (response.status_code, response.reason), None, logsi=_logsi)
+                    # trace.
+                    _logsi.LogVerbose(SAAppMessages.MSG_SPOTIFY_WEB_API_RETRY_RESPONSE_STATUS % (response.status_code, response.reason), colorValue=SIColors.Red)
 
-                # only retry so many times before we give up;
-                if (loopTotalDelay > LOOP_TIMEOUT):
-                    raise SpotifyApiError("Timed out waiting for Spotify Gateway to become available; gave up after %f seconds from initial request" % (loopTotalDelay), None, logsi=_logsi)
+                    # wait just a bit between requests.
+                    _logsi.LogVerbose(SAAppMessages.MSG_SPOTIFY_WEB_API_RETRY_REQUEST_DELAY % (LOOP_DELAY))
+                    time.sleep(LOOP_DELAY)
+                    loopTotalDelay = loopTotalDelay + LOOP_DELAY
 
-                # trace.
-                _logsi.LogVerbose("Spotify Web Player cookie credentials token exchange request returned with a 504 status (Gateway timeout); request will be retried")
+                else:
+
+                    # otherwise, break out of retry loop and process response.
+                    break
 
-                # wait just a bit between requests.
-                _logsi.LogVerbose("Delaying for %s seconds to allow Spotify Gateway to become available" % (LOOP_DELAY))
-                time.sleep(LOOP_DELAY)
-                loopTotalDelay = loopTotalDelay + LOOP_DELAY
+            # trace.
+            if _logsi.IsOn(SILevel.Debug):
+                _logsi.LogObject(SILevel.Debug, "%s http response object - type=\"%s\", module=\"%s\"" % (tracePrefix, type(response).__name__, type(response).__module__), response)
+
+            # trace.
+            if _logsi.IsOn(SILevel.Debug):
+                _logsi.LogObject(SILevel.Debug, "%s http response [%s-%s] (response)" % (tracePrefix, response.status_code, response.reason), response)
+                if (response.headers):
+                    _logsi.LogCollection(SILevel.Debug, "%s http response [%s-%s] (headers)" % (tracePrefix, response.status_code, response.reason), response.headers.items())
+
+            # raise exception if we could not get the access token, or if a redirect occured.
+            # the redirect usually indicates the sp_dc and sp_key are expired, and it's redirecting to a login page.
+            respHdrLocation:str = response.headers.get("Location", None)
+            if (response.status_code == 302 and respHdrLocation == "/get_access_token?reason=transport&productType=web_player&_authfailed=1"):
+                raise SpotifyApiError("Unsuccessful token request, received status 302 and Location header \"%s\". sp_dc and sp_key could be expired. Please update values in token storage file." % (respHdrLocation), None, logsi=_logsi)
+
+            # if successful request, then break out of the retry loop.
+            if (response.status_code == 200):
+                _logsi.LogVerbose("Token exchange request was successful within %f seconds from initial request; processing results" % (loopTotalDelay))
+            else:
+                raise SpotifyApiError("Token exchange request failed: %s - %s" % (response.status_code, response.reason), None, logsi=_logsi)
 
             # load request response.
             data = response.content.decode('utf-8')