spotifywebapiPython 1.0.280__py3-none-any.whl → 1.0.282__py3-none-any.whl

spotifywebapipython/zeroconfapi/zeroconfconnect.py

@@ -426,6 +426,9 @@ class ZeroconfConnect:
             # we will process the results with a `ZeroconfGetInfo` object, in case a publicKey was returned.
             result = ZeroconfGetInfo(root=responseData)
 
+            # trace.
+            _logsi.LogObject(SILevel.Verbose, '%s result (addUser %s)' % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
+
             # is the device fully available?  The info.Availability property can be used to determine this.
             # if the device is fully available (Availability=""), then the addUser request should return
             # immediately - hopefully with a 0 status (OK) to denote the request was successul.
@@ -438,7 +441,6 @@ class ZeroconfConnect:
             if (result.Status == 203) and (result.StatusString == "ERROR-INVALID-PUBLICKEY"):
 
                 # trace.
-                _logsi.LogObject(SILevel.Verbose, '%s result (%s)' % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
                 _logsi.LogVerbose("Spotify Connect addUser request returned an ERROR-INVALID-PUBLICKEY response for Device id '%s'; addUser will be retried with the returned publicKey" % (info.DeviceId))
 
                 # wait for the device to be fully loaded.
@@ -476,48 +478,29 @@ class ZeroconfConnect:
                 # process results.
                 result = ZeroconfResponse(root=responseData)
 
-            # TEST TODO REMOVEME
-            # the following code was added while trying to determine errors received for a Sonos Move device.
-
-            # did we get a 202 (ERROR-LOGIN-FAILED) status?  if so, then we will wait a little bit and
-            # poll the device again for it's status as it may need more time for Spotify Connect to startup
-            # or switch the user context.  this is especially true for Sonos devices, as they can be a little 
-            # slow since they are considered restricted devices.
-            elif (result.Status == 202) and (result.StatusString == "ERROR-LOGIN-FAILED"):
-
-                _logsi.LogObject(SILevel.Verbose, '%s result (addUser %s object)' % (apiMethodName, type(result).__name__), result, excludeNonPublic=True, colorValue=SIColors.Red)
-                _logsi.LogVerbose("Spotify Connect addUser request returned an ERROR-LOGIN-FAILED response for Device id '%s'; addUser will be retried again after repeated getInfo polling" % (info.DeviceId), colorValue=SIColors.Red)
-
-                # wait 10 seconds, calling "getInfo" 2x every second to see what it displays.
-                # after this loop, we will call addUser one more time.
-
-                # wait for the device to be fully loaded.
-                # once this happens, the device Status code should be 101 (OK).
-                loopTotalDelay:float = 0
-                LOOP_DELAY:float = 0.50
-                LOOP_TIMEOUT:float = 15.0
-                while True:
-                        
-                    # wait just a bit between device info queries.
-                    _logsi.LogVerbose("Delaying for %s seconds before callling getInfo for Spotify Connect device id '%s'" % (LOOP_DELAY, info.DeviceId), colorValue=SIColors.Red)
-                    time.sleep(LOOP_DELAY)
-                    loopTotalDelay = loopTotalDelay + LOOP_DELAY
-
-                    # get device information;
-                    info = self.GetInformation()
-                    # if info.Status == 101:
-                    #     _logsi.LogVerbose("Spotify Connect Device id '%s' status changed to '%s'(%s) within %f seconds of initial addUser request" % (info.DeviceId, info.Status, info.StatusString, loopTotalDelay))
-                    #     break
+                # trace.
+                _logsi.LogObject(SILevel.Verbose, '%s result (addUser %s)' % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
+
+            # did we get a 202 (ERROR-LOGIN-FAILED) status?  if so, we will retry the addUser call
+            # a few times.  this is required for devices that may be having issues contacting the 
+            # Spotify backend from the Spotify Connect zeroconf service running on the device.
+            # Sonos devices seem to be the major offender for this scenario.
+            LOOP_ATTEMPTS:int = 0
+            LOOP_ATTEMPTS_MAX:int = 5
+            LOOP_DELAY:float = 0.25
+            while (result.Status == 202) and (result.StatusString == "ERROR-LOGIN-FAILED"):
                         
-                    # only check so many times before we give up;
-                    if (loopTotalDelay > LOOP_TIMEOUT):
-                        _logsi.LogVerbose("Done polling Spotify Connect device id '%s' via getInfo" % (info.DeviceId), colorValue=SIColors.Red)
-                        break
+                # only check so many times before we give up;
+                LOOP_ATTEMPTS += 1
+                if (LOOP_ATTEMPTS > LOOP_ATTEMPTS_MAX):
+                    _logsi.LogVerbose("Max attempts (%s) reached while retrying addUser request due to ERROR-LOGIN-FAILED for device id '%s'" % (LOOP_ATTEMPTS_MAX, info.DeviceId), colorValue=SIColors.Red)
+                    break
 
-                # trace.
-                _logsi.LogVerbose("Calling Spotify Connect addUser 1 last time for device id '%s' ..." % (info.DeviceId), colorValue=SIColors.Red)
+                # wait just a bit between attempts.
+                _logsi.LogVerbose("Delaying for %s seconds before retrying addUser request due to ERROR-LOGIN-FAILED (attempt # %s)" % (LOOP_DELAY, LOOP_ATTEMPTS), colorValue=SIColors.Red)
+                time.sleep(LOOP_DELAY)
 
-                # now that the device is (hopefully) fully available, try the addUser request again.
+                # try the addUser request again.
                 responseData = self._ConnectAddUser(
                     info,
                     username,
@@ -528,14 +511,25 @@ class ZeroconfConnect:
 
                 # process results.
                 result = ZeroconfResponse(root=responseData)
-            
-            # trace.
-            _logsi.LogObject(SILevel.Verbose, '%s result (addUser %s)' % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
 
+                # trace.
+                _logsi.LogObject(SILevel.Verbose, '%s result (addUser %s - retry attempt #%s)' % (apiMethodName, type(result).__name__, LOOP_ATTEMPTS), result, excludeNonPublic=True, colorValue=SIColors.Red)
+
+                # get device information; we do this just to log trace data for
+                # debugging purposes; some Sonos devices will change the ActiveUser
+                # property when the user context changes (e.g. Sonos Move), while
+                # others will not change the ActiveUser property (e.g. Sonos Ikea Symfonisk).
+                info = self.GetInformation()
+                
             # if result status is not ok, then raise an exception.
             if (result.Status != 101):
                 raise SpotifyZeroconfApiError(result.Status, result.ToString(), apiMethodName, result.StatusString, _logsi)
 
+            # get device information; we do this just to log trace data for debugging purposes.
+            # some Sonos devices will change the ActiveUser property when the user context 
+            # changes (e.g. Sonos Move), while others will not (e.g. Sonos Ikea Symfonisk).
+            info = self.GetInformation()
+
             # give spotify zeroconf api time to process the change.
             if delay > 0:
                 _logsi.LogVerbose(TRACE_MSG_DELAY_DEVICE % delay)

{spotifywebapipython-1.0.280.dist-info → spotifywebapipython-1.0.282.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spotifywebapipython
-Version: 1.0.280
+Version: 1.0.282
 Summary: Spotify Web API Python3 Library
 Author: Todd Lucas
 Author-email: <thlucas@yahoo.com>

{spotifywebapipython-1.0.280.dist-info → spotifywebapipython-1.0.282.dist-info}/RECORD

@@ -1,36 +1,36 @@
 spotifywebapipython/__init__.py,sha256=ka7F2AsT-UU7KSYKBnfgl5Trojcep5aQspLutg8D-2k,1306
-spotifywebapipython/const.py,sha256=SZBMXp9kF-FUhrsohCLuTiNfpLpTqyie7rlUZHszYbU,4100
+spotifywebapipython/const.py,sha256=Ojdhql071-swTk703H9mLcEyWGZT-K9SiIhyJrShvGQ,4100
 spotifywebapipython/saappmessages.py,sha256=mVprjpd5CdD8kYeAkLzRvMvIQPmaYtH4UCP5my3QhSk,5065
 spotifywebapipython/sautils.py,sha256=LZF3UvxaBK35WIg1hO37nbW8j1y-M-oOxRbi1dPR39w,8746
 spotifywebapipython/spotifyapierror.py,sha256=23_CYlxWN0BceYYCLpBpunl55vEwPr_wFf34l74xzeA,1855
 spotifywebapipython/spotifyapimessage.py,sha256=wCnW8jYMLS3x9kjyXPgXXZqaf1HeMTTXzU8u_Dm5pfA,8447
 spotifywebapipython/spotifyauthtoken.py,sha256=iVg2Pa5mfMqYe4qgc5H8td6JzJlaDqk4vMEhH5LmtfI,9289
-spotifywebapipython/spotifyclient.py,sha256=GHD8AoEE1CHyaDZKqOnK9GEgINZAXCNKgrsEZfYFO50,904168
+spotifywebapipython/spotifyclient.py,sha256=Hnun--Wl9wcj2WRvTiOwh-XQN2MA1WhvAr3OaGg9cgk,904318
 spotifywebapipython/spotifydiscovery.py,sha256=cyysxl8PQj9yGHVbaqhSF3SStlrp-NvfGAudM-dDmg0,20290
 spotifywebapipython/spotifymediatypes.py,sha256=hMjkxhbfTtks0_P8BKmY7qg3EmB2zhH3RT0DbEpb_2s,1628
 spotifywebapipython/spotifytypeprefixes.py,sha256=3yfpxKF7jF694qBuo-PbKYvm70YwwdBoGj9enOpWsAg,1375
 spotifywebapipython/spotifywebapiauthenticationerror.py,sha256=5A0MKvYo3Ypv0ZeSSfLHuFLwzoUUu044bBoUgMfNXNw,3940
 spotifywebapipython/spotifywebapierror.py,sha256=5cga9213J_nFQ0UX4vSn3dpyinASKTRiH0wAR4nLjvs,3147
 spotifywebapipython/spotifywebplayertoken.py,sha256=axj1j1lM7COiiZfpElkJRdnk4AmE6bAQcjKshUIz1Nk,35813
-spotifywebapipython/docs/__init__.html,sha256=jL3qTbd7WnNzuO-OCpgmAz5JtTeHscmJ9Bd3hHVA6pE,193313
+spotifywebapipython/docs/__init__.html,sha256=uzEAfwl3pPKJsGfFhSMeOjk6w8y8DS14dEGXlISfe7M,194122
 spotifywebapipython/docs/codecopy.js,sha256=ryuoZwLIL03YitjjFzn49UO5ta7-OBos6LNA3qHhFzs,3120
-spotifywebapipython/docs/index.html,sha256=-l7azsQMiuBzDyYZ8fRUMvDiSkE8mob6SwoVsWCKODw,48779
-spotifywebapipython/docs/search.js,sha256=F-rDoNSAoZVpVpsFT_GPBJ6Yc9C4gPzMhwcvCNku77s,9164676
+spotifywebapipython/docs/index.html,sha256=hvHAnCH5BcywSYk4isssS-EuVRJSqwHWcW2jAcQvQ0I,48779
+spotifywebapipython/docs/search.js,sha256=84YxUEgDnZnl4loJ9G53PP3zgzHs7E-UBaCFZT8_p6g,9167238
 spotifywebapipython/docs/spotifywebapipython.ico,sha256=YImj39fqqSPSuB2-sMDlUYDd6YwRfQeJRtq4FjwWglg,16410
 spotifywebapipython/docs/spotifywebapipython_OLD.ico,sha256=YIv5LjcD4bTIJQSOr8jjwbWaeB3QkElRwkTOePiGbZo,14904
-spotifywebapipython/docs/spotifywebapipython/const.html,sha256=q7y_S2zsv77gJ5QxNsPrnRz6KxOfqqaRZQf9oMQUi_Q,60537
-spotifywebapipython/docs/spotifywebapipython/saappmessages.html,sha256=Ab0eWBsfoDc71Ohpslz-7E-X8fL7McpmGokQ9mo_Zj0,62358
-spotifywebapipython/docs/spotifywebapipython/sautils.html,sha256=V3s3GNZw3yFkhczr-Q3ZxJqzYP1gna1ZYhpvD6C6hnY,62031
-spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html,sha256=uqAiL-s1YQpURvuF6S4W8eIrRYtdPewswuLcJIu8x6g,48054
-spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html,sha256=2DzJxOSuRodjRCDqdPl5BfJWF8V2pr1oPFOvltK_NZ0,59210
-spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html,sha256=ohvBJLfHPrq2xw1teufVTtl-JLqISqg-C_0Kn31HEmI,59256
-spotifywebapipython/docs/spotifywebapipython/spotifyclient.html,sha256=Oma4SxWDIJwMCpjwIotEv-NVG1ue9L0kpOb6eqs4SZk,1667821
-spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html,sha256=udsWRmvgRxJeAlE6RU6_7mOawmskuUYg31_i3i46qO0,57662
-spotifywebapipython/docs/spotifywebapipython/spotifymediatypes.html,sha256=jyAeNEXADGyL-K8D2rE453z9-rG6cAoUl_1HCYHtImE,51532
-spotifywebapipython/docs/spotifywebapipython/spotifytypeprefixes.html,sha256=GeNKmfa8epEoY9nXNV684U0HAz1lABUutoQhiKKamnw,52401
-spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html,sha256=pYa6uPSZOx0EDhiIDuw-6w-QmPRi3t80QETugt3PrPM,52174
-spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html,sha256=Md5tOYxon3dSdOvpXxSl5dZ8Y06VgTuYkJ-tkjXSCzw,50592
-spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html,sha256=siH8wo1ymkocoszFdDhPhqSwtwA2NiP4ExYdH-wGh7Q,62204
+spotifywebapipython/docs/spotifywebapipython/const.html,sha256=PfPWcfOwrjH17zFv2X3w4dcpv1bT0vi8FdsGcYjAUdE,60537
+spotifywebapipython/docs/spotifywebapipython/saappmessages.html,sha256=NVjzW0YtXFFyUsTsxi1F7peLQLFVt2v65W9t7oHQpg8,62358
+spotifywebapipython/docs/spotifywebapipython/sautils.html,sha256=-D9gnDAzLwX0szdc3778Mzgdkh0boS-FBela1OIiZSI,62031
+spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html,sha256=KwxdaqaLqY1iNtSWXiCgS5su9-TpDTuLhmYhrh85FOs,48054
+spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html,sha256=uqgTHvBb_DPjzP5Gfu3mwMcVSRK3E9ibbuVd0w3YUeA,59210
+spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html,sha256=hBYI7v6HcnWTTWdEoaTAkfudj_3zt3-JXUqyjk-TbbY,59256
+spotifywebapipython/docs/spotifywebapipython/spotifyclient.html,sha256=qmRfRqyPzab9cqQUEtZnPVklJqcWan0rxu2TT2llyFE,1667821
+spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html,sha256=00zOIv7Z1EC6TmFdD4gjc9yrbreXm4j_d2tLHHHAbVw,57662
+spotifywebapipython/docs/spotifywebapipython/spotifymediatypes.html,sha256=wSylTgIpoQnwm7mvAFJk36DCOhYALRY5-oNPeINur9M,51532
+spotifywebapipython/docs/spotifywebapipython/spotifytypeprefixes.html,sha256=8u41ykptgHdSRQZUqt1yE8O55N1_1YkrOtt0hQJQokk,52401
+spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html,sha256=n-5940XCCnMr-1U_vhux3NbQnElDVMBY1fcU9h61CHw,52174
+spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html,sha256=1w52609Ve2T_Q_zDQJxJXsd_UFUO57wunV5kWnmR7-o,50592
+spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html,sha256=1x4Tk_IrcfODApu-FzCU5Ydtg-GyGA9TG0vYhdi_L1c,62204
 spotifywebapipython/models/__init__.py,sha256=RwRQhUX-6EUs8XvStVFpR8EPwoqIAz9K6ref-28qHKI,4423
 spotifywebapipython/models/album.py,sha256=U3Pdw0-EL33LdkeiN31fjZ23rlLk6DNGV8jRmZU7EyQ,5170
 spotifywebapipython/models/albumpagesaved.py,sha256=SBYMhkh5ZsMrRAXl-cm9zsxMDh8gO190ENq6Py2TyGY,2417
@@ -107,7 +107,7 @@ spotifywebapipython/models/userprofilesimplified.py,sha256=qd1CVNwlt7J-M4tmUVaCQ
 spotifywebapipython/models/zeroconfdiscoveryresult.py,sha256=XID2qmaK2WTGJoLTQ54aQjfutLJMLgJ7A1ATwAp06kY,20250
 spotifywebapipython/models/zeroconfproperty.py,sha256=sXGUqbHhFMutCNKFJwJKbNbbQAnBnR7Ob5wNDSePxZk,2141
 spotifywebapipython/oauthcli/__init__.py,sha256=K37XTxYAKT0n8otCNzWbjgJ10fAPN4WL6seEpwvWyo4,168
-spotifywebapipython/oauthcli/authclient.py,sha256=rpOgX8T-co8JByHlmB6JJqvXUaphP7jDhJ4qjhf0XA8,56065
+spotifywebapipython/oauthcli/authclient.py,sha256=qGKa4FLBHHZQyP5ho1sIM_mNmyshQd720YwKcUFQJAw,56207
 spotifywebapipython/spotifyconnect/__init__.py,sha256=9Xl5KiJFvWLbsdb4YQ0xmF67i36ybpXCCXrWeNsKEvc,1108
 spotifywebapipython/spotifyconnect/spotifyconnectdeviceeventargs.py,sha256=35hKa0FAaPgy7W8D6MFXmga667pjwXITo8jSj1TDfE8,1988
 spotifywebapipython/spotifyconnect/spotifyconnectdirectorytask.py,sha256=QXNpJSqUGuOYxCzvDH63Ka9L9Yo7Bb5iVBRtDhc4ILE,153923
@@ -132,13 +132,13 @@ spotifywebapipython/zeroconfapi/credentials.py,sha256=MIXqZvFNDjoICpZGNXPveHNl9G
 spotifywebapipython/zeroconfapi/cryptodiffiehellman.py,sha256=k-nMR68GtzODYsQrwCpvFE2XNxv-XUFbMemplldtwp4,3340
 spotifywebapipython/zeroconfapi/helpers.py,sha256=9lJFOuKYrk-e7SbU94WmFv5oiBq4k5gMS8wE1it4Wbc,1429
 spotifywebapipython/zeroconfapi/spotifyzeroconfapierror.py,sha256=rTwIrr1qV0UiQS_zBufboyZ3A3yGrdCsTAOiVA5dvzY,3031
-spotifywebapipython/zeroconfapi/zeroconfconnect.py,sha256=XMMlIdoi-E7YJ1d0nEquX1dZiMYpwKX0urTbfhS8yxs,70838
+spotifywebapipython/zeroconfapi/zeroconfconnect.py,sha256=DDuVljjg_SF_YJWWQjmCSG-6-93YBSTCLhjr77DI5xI,70266
 spotifywebapipython/zeroconfapi/zeroconfgetinfo.py,sha256=APayso_F7lCsdzzrkescgd-nKukUah3Kjfs-5F2tnvU,21415
 spotifywebapipython/zeroconfapi/zeroconfgetinfoalias.py,sha256=FZJM23HIPJSfhXIC3-EuS1XhawheoG5maSp7__k4yBo,2932
 spotifywebapipython/zeroconfapi/zeroconfgetinfodrmmediaformat.py,sha256=c5uk8ljsIuBK3w2jahHKQuoWvm245LOjUBitetXx5Mo,2347
 spotifywebapipython/zeroconfapi/zeroconfresponse.py,sha256=mAPIDj5MG53x8peiScrp7OJblwy_o_Sto4wqE0rGujU,6445
-spotifywebapipython-1.0.280.dist-info/LICENSE,sha256=KGcc9g0zwqNLcWnSn_ezv1UtKyhMENFhvtixpxUPNsE,1177
-spotifywebapipython-1.0.280.dist-info/METADATA,sha256=qCcmvbPyJ1Ry9YAwl2kV0kviflZzOANu3ykYw_PXsxU,11644
-spotifywebapipython-1.0.280.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-spotifywebapipython-1.0.280.dist-info/top_level.txt,sha256=jTBLFlijKTesYh2dteAz4vb17qjaqWKeDjpnnwTcrjs,20
-spotifywebapipython-1.0.280.dist-info/RECORD,,
+spotifywebapipython-1.0.282.dist-info/LICENSE,sha256=KGcc9g0zwqNLcWnSn_ezv1UtKyhMENFhvtixpxUPNsE,1177
+spotifywebapipython-1.0.282.dist-info/METADATA,sha256=xsOeXo3mR4BQITUaJnpy2XugbwOS_QTa0O-mhSBcshY,11644
+spotifywebapipython-1.0.282.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+spotifywebapipython-1.0.282.dist-info/top_level.txt,sha256=jTBLFlijKTesYh2dteAz4vb17qjaqWKeDjpnnwTcrjs,20
+spotifywebapipython-1.0.282.dist-info/RECORD,,