spotifywebapiPython 1.0.53__py3-none-any.whl → 1.0.55__py3-none-any.whl

spotifywebapipython/spotifyclient.py

@@ -6027,7 +6027,7 @@ class SpotifyClient:
                     
                     # does our Spotify Connect user account need to take control of the device?
                     # if not, then we are done.
-                    elif (deviceActiveUser == self._SpotifyConnectUsername.lower()):  # or (deviceActiveUser == self.UserProfile.Id.lower()):
+                    elif (deviceActiveUser == self._SpotifyConnectUsername.lower()) or (deviceActiveUser == self.UserProfile.Id.lower()):
                         _logsi.LogVerbose("Spotify Connect user context '%s' was verified for Device id '%s'; switch not necessary" % (deviceActiveUser, deviceIdResult))
                         status = status + "user context switch not needed"
                     
@@ -7877,10 +7877,18 @@ class SpotifyClient:
 
     def GetSpotifyConnectDevices(
             self, 
+            refresh:bool=True
             ) -> SpotifyConnectDevices:
         """
         Get information about all available Spotify Connect player devices.
         
+        This method requires the `user-read-playback-state` scope.
+        
+        Args:
+            refresh (bool):
+                True (default) to return real-time information from the spotify zeroconf api and
+                update the cache; otherwise, False to just return the cached value.
+        
         Returns:
             A `SpotifyConnectDevices` object that contain the discovery results
             as well as the `getInfo` result for each found device.
@@ -7903,6 +7911,10 @@ class SpotifyClient:
         process, but still exist in the player device list.  These are usually Spotify Connect
         web or mobile players with temporary device id's.
                         
+        The `ConfigurationCache` is updated with the results of this method.  Use the
+        `refresh` argument (with False value) to retrieve the cached value and avoid
+        the spotify web api request.  This results in better performance.
+                        
         <details>
           <summary>Sample Code</summary>
         ```python
@@ -7912,50 +7924,65 @@ class SpotifyClient:
         """
         apiMethodName:str = 'GetSpotifyConnectDevices'
         result:SpotifyConnectDevices = SpotifyConnectDevices()
+        cacheDesc:str = CACHE_SOURCE_CURRENT
         
         try:
             
             # trace.
             _logsi.EnterMethod(SILevel.Debug, apiMethodName)
                 
-            # discover Spotify Connect devices on the network, waiting up to the specified timeout 
-            # for all devices to be discovered.  this will return all Spotify Connect devices that
-            # are currently powered on, and are registered to Zeroconf / mDNS.
-            _logsi.LogVerbose("Discovering Spotify Connect devices on the local network")
-            discovery:SpotifyDiscovery = SpotifyDiscovery(self._ZeroconfClient, printToConsole=False)
-            discovery.DiscoverDevices(timeout=self._SpotifyConnectDiscoveryTimeout)
+            # can we use the cached value?
+            if (not refresh) and (apiMethodName in self._ConfigurationCache):
+                
+                result = self._ConfigurationCache[apiMethodName]
+                cacheDesc = CACHE_SOURCE_CACHED
+                
+            else:
+                
+                # discover Spotify Connect devices on the network, waiting up to the specified timeout 
+                # for all devices to be discovered.  this will return all Spotify Connect devices that
+                # are currently powered on, and are registered to Zeroconf / mDNS.
+                _logsi.LogVerbose("Discovering Spotify Connect devices on the local network")
+                discovery:SpotifyDiscovery = SpotifyDiscovery(self._ZeroconfClient, printToConsole=False)
+                discovery.DiscoverDevices(timeout=self._SpotifyConnectDiscoveryTimeout)
 
-            # process all discovered devices.
-            discoverResult:ZeroconfDiscoveryResult
-            for discoverResult in discovery.DiscoveryResults:
-
-                # get the id from the device via the zeroconf API getInfo endpoint, as the id is not 
-                # returned in the zeroconf discovery result.
-                zconn:ZeroconfConnect = ZeroconfConnect(discoverResult.HostIpv4Address, 
-                                                        discoverResult.HostIpPort, 
-                                                        discoverResult.SpotifyConnectCPath,
-                                                        useSSL=False)
-                info:ZeroconfGetInfo = zconn.GetInformation()
-
-                # create new spotify connect device object.
-                scDevice:SpotifyConnectDevice = SpotifyConnectDevice()
-                scDevice.DiscoveryResult = discoverResult
-                scDevice.DeviceInfo = info
-                result.Items.append(scDevice)
-                
-            # we will also call the GetPlayerDevices method, in case we have any dynamic devices.
-            # dynamic devices are Spotify Connect devices that are not found in Zeroconf discovery
-            # process, but still exist in the player device list.  these are usually Spotify Connect
-            # web or mobile players with temporary device id's.
-            devices:list[Device] = self.GetPlayerDevices(True)
+                # process all discovered devices.
+                discoverResult:ZeroconfDiscoveryResult
+                for discoverResult in discovery.DiscoveryResults:
+
+                    # get the id from the device via the zeroconf API getInfo endpoint, as the id is not 
+                    # returned in the zeroconf discovery result.
+                    zconn:ZeroconfConnect = ZeroconfConnect(discoverResult.HostIpv4Address, 
+                                                            discoverResult.HostIpPort, 
+                                                            discoverResult.SpotifyConnectCPath,
+                                                            useSSL=False)
+                    info:ZeroconfGetInfo = zconn.GetInformation()
+
+                    # create new spotify connect device object.
+                    scDevice:SpotifyConnectDevice = SpotifyConnectDevice()
+                    scDevice.DiscoveryResult = discoverResult
+                    scDevice.DeviceInfo = info
+                    result.Items.append(scDevice)
+                
+                # we will also call the GetPlayerDevices method, in case we have any dynamic devices.
+                # dynamic devices are Spotify Connect devices that are not found in Zeroconf discovery
+                # process, but still exist in the player device list.  these are usually Spotify Connect
+                # web or mobile players with temporary device id's.
+                devices:list[Device] = self.GetPlayerDevices(True)
           
-            device:Device
-            for device in devices:
-                if not result.ContainsDeviceId(device.Id):
-                    result.AddDynamicDevice(device, self.UserProfile.Id)
+                device:Device
+                for device in devices:
+                    if not result.ContainsDeviceId(device.Id):
+                        result.AddDynamicDevice(device, self.UserProfile.Id)
 
+                # update cache.
+                self._ConfigurationCache[apiMethodName] = result
+
+            # update last refresh date.
+            result.DateLastRefreshed = datetime.utcnow().timestamp()
+            
             # trace.
-            _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, type(result).__name__), result)
+            _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE_CACHED % (apiMethodName, type(result).__name__, cacheDesc), result)
             return result
 
         except SpotifyZeroconfApiError: raise  # pass handled exceptions on thru

spotifywebapipython/zeroconfapi/zeroconfconnect.py

@@ -354,7 +354,8 @@ class ZeroconfConnect:
                 self._Uri,
                 timeout=10,
                 headers={
-                    'Content-Type': 'application/x-www-form-urlencoded'
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                    'Connection': 'close'
                 },
                 data={
                     'action': 'addUser',
@@ -455,7 +456,8 @@ class ZeroconfConnect:
                 self._Uri,
                 timeout=10,
                 headers={
-                    'Content-Type': 'application/x-www-form-urlencoded'
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                    'Connection': 'close'
                 },
                 data={
                     'action': 'resetUsers',
@@ -556,7 +558,8 @@ class ZeroconfConnect:
                 self._Uri, 
                 timeout=10,
                 headers={
-                    'Content-Type': 'application/x-www-form-urlencoded'
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                    'Connection': 'close'
                 },
                 params={
                     'action': 'getInfo',