spotifywebapiPython 1.0.148__py3-none-any.whl → 1.0.150__py3-none-any.whl

spotifywebapipython/models/spotifyconnectdevice.py

@@ -3,7 +3,7 @@
 # our package imports.
 from ..sautils import export
 from .zeroconfdiscoveryresult import ZeroconfDiscoveryResult
-from spotifywebapipython.zeroconfapi.zeroconfgetinfo import ZeroconfGetInfo
+from spotifywebapipython.zeroconfapi import ZeroconfGetInfo, ZeroconfResponse
 
 @export
 class SpotifyConnectDevice():
@@ -21,7 +21,11 @@ class SpotifyConnectDevice():
         self._DiscoveryResult:ZeroconfDiscoveryResult = None
         self._DeviceInfo:ZeroconfGetInfo = None
         self._Id:str = None
+        self._IsActiveDevice:bool = False
+        self._IsInDeviceList:bool = False
+        self._IsRestricted:bool = False
         self._Name:str = None
+        self._ZeroconfResponseInfo:ZeroconfResponse = ZeroconfResponse()
         self._WasReConnected:bool = False
 
 
@@ -80,6 +84,23 @@ class SpotifyConnectDevice():
         self._Id = value
     
 
+    @property
+    def IsActiveDevice(self) -> bool:
+        """ 
+        Returns True if this device is the currently active Spotify Web API player device;
+        otherwise, False.
+        """
+        return self._IsActiveDevice
+    
+    @IsActiveDevice.setter
+    def IsActiveDevice(self, value:bool):
+        """ 
+        Sets the IsActiveDevice property value.
+        """
+        if isinstance(value, bool):
+            self._IsActiveDevice = value
+
+
     @property
     def IsChromeCast(self) -> bool:
         """ 
@@ -90,6 +111,40 @@ class SpotifyConnectDevice():
         return False
     
 
+    @property
+    def IsInDeviceList(self) -> bool:
+        """ 
+        Returns True if this device is a member of the Spotify Web API player device list;
+        otherwise, False.
+        """
+        return self._IsInDeviceList
+    
+    @IsInDeviceList.setter
+    def IsInDeviceList(self, value:bool):
+        """ 
+        Sets the IsInDeviceList property value.
+        """
+        if isinstance(value, bool):
+            self._IsInDeviceList = value
+
+
+    @property
+    def IsRestricted(self) -> bool:
+        """ 
+        Returns True if this device is a member of the Spotify Web API player device list;
+        otherwise, False.
+        """
+        return self._IsRestricted
+    
+    @IsRestricted.setter
+    def IsRestricted(self, value:bool):
+        """ 
+        Sets the IsRestricted property value.
+        """
+        if isinstance(value, bool):
+            self._IsRestricted = value
+
+
     @property
     def Name(self) -> str:
         """ 
@@ -108,9 +163,9 @@ class SpotifyConnectDevice():
     @property
     def Title(self) -> str:
         """ 
-        Spotify Connect device name and id value (e.g. '"Bose-ST10-1" (30fbc80e35598f3c242f2120413c943dfd9715fe)').
+        Spotify Connect device name and id value (e.g. "Bose-ST10-1" (30fbc80e35598f3c242f2120413c943dfd9715fe)).
         """
-        return '%s (%s)' % (self._Name, self._Id)
+        return "\"%s\" (%s)" % (self._Name, self._Id)
     
 
     @property
@@ -128,6 +183,22 @@ class SpotifyConnectDevice():
         self._WasReConnected = value
     
 
+    @property
+    def ZeroconfResponseInfo(self) -> ZeroconfResponse:
+        """ 
+        Spotify Zeroconf API Zeroconf response object.
+        """
+        return self._ZeroconfResponseInfo
+    
+    @ZeroconfResponseInfo.setter
+    def ZeroconfResponseInfo(self, value:ZeroconfResponse):
+        """ 
+        Sets the ZeroconfResponseInfo property value.
+        """
+        if isinstance(value, ZeroconfResponse):
+            self._ZeroconfResponseInfo = value
+
+
     def Equals(self, obj) -> bool:
         """
         Returns true if the specified object instance contains the same argument
@@ -160,10 +231,14 @@ class SpotifyConnectDevice():
             'Id': self._Id,
             'Name': self._Name,
             'Title': self.Title,
-            'WasReConnected': self._WasReConnected,
+            'IsActiveDevice': self._IsActiveDevice,
             'IsChromeCast': self.IsChromeCast,
+            'IsInDeviceList': self._IsInDeviceList,
+            'IsRestricted': self._IsRestricted,
+            'WasReConnected': self._WasReConnected,
             'DeviceInfo': self._DeviceInfo.ToDictionary(),
             'DiscoveryResult': self._DiscoveryResult.ToDictionary(),
+            'ZeroconfResponseInfo': self._ZeroconfResponseInfo.ToDictionary(),
         }
         return result
         
@@ -179,10 +254,15 @@ class SpotifyConnectDevice():
         msg:str = ''
         if includeTitle: 
             msg = 'Device: "%s" (%s)' % (self._Name, self._Id)
+            msg = '%s\n IsActiveDevice="%s"' % (msg, str(self._IsActiveDevice))
+            msg = '%s\n IsChromecast="%s"' % (msg, str(self.IsChromeCast))
+            msg = '%s\n IsInDeviceList="%s"' % (msg, str(self._IsInDeviceList))
+            msg = '%s\n IsRestricted="%s"' % (msg, str(self._IsRestricted))
             msg = '%s\n WasReConnected="%s"' % (msg, str(self._WasReConnected))
             msg = '%s\n' % (msg)
            
         # build result.
         msg = '%s\n %s\n' % (msg, str(self._DeviceInfo.ToString(True)))
         msg = '%s\n %s\n' % (msg, str(self._DiscoveryResult.ToString(True)))
+        msg = '%s\n %s\n' % (msg, str(self._ZeroconfResponseInfo.ToString(True)))
         return msg 

spotifywebapipython/models/spotifyconnectdevices.py

@@ -96,278 +96,6 @@ class SpotifyConnectDevices():
         return 0
     
 
-    def AddDynamicDevice(
-        self, 
-        device:Device, 
-        activeUser:str
-        ) -> None:
-        """ 
-        Adds a new dynamic device entry to the `Items` collection.  
-        
-        Args:
-            device (Device):
-                Device information to add.
-            activeUser (str):
-                Currently active user id.
-
-        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 Player
-        client devices (e.g. mobile / web / desktop players) that utilize temporary device id's.
-        """
-        # validations.
-        if (device is None) or (not isinstance(device, Device)):
-            return
-        
-        # build zeroconf discovery result with what we can.
-        discoverResult:ZeroconfDiscoveryResult = ZeroconfDiscoveryResult()
-        discoverResult.DeviceName = device.Name
-        discoverResult.HostIpAddresses.append('127.0.0.1')
-        discoverResult.Server = '127.0.0.1'
-        discoverResult.HostIpPort = 0
-        discoverResult.Name = device.Name
-        discoverResult.SpotifyConnectCPath = '/zc'
-        discoverResult.SpotifyConnectVersion = '1.0'
-
-        # build zeroconf getinfo result with what we can.
-        info:ZeroconfGetInfo = ZeroconfGetInfo()
-        info.ActiveUser = activeUser
-        info.DeviceId = device.Id
-        info.DeviceType = device.Type
-        info.RemoteName = device.Name
-        info.SpotifyError = 0
-        info.Status = 101
-        info.StatusString = 'OK'
-        
-        # populate brand info for popular devices.
-        if (device.Name == "Web Player (Chrome)"):
-            info.BrandDisplayName = 'Google'
-            info.ModelDisplayName = 'Chrome'
-            info.ProductId = 'Web Player'
-        elif (device.Name == "Web Player (Microsoft Edge)"):
-            info.BrandDisplayName = 'Microsoft'
-            info.ModelDisplayName = 'Edge'
-            info.ProductId = 'Web Player'
-        else:
-            info.BrandDisplayName = 'unknown'
-            info.ModelDisplayName = 'unknown'
-            info.ProductId = 'unknown'
-        
-        # add the device.
-        scDevice:SpotifyConnectDevice = SpotifyConnectDevice()
-        scDevice.Id = info.DeviceId
-        scDevice.Name = info.RemoteName
-        scDevice.DeviceInfo = info
-        scDevice.DiscoveryResult = discoverResult
-        self._Items.append(scDevice)
-
-        # trace.
-        _logsi.LogVerbose("Added SpotifyConnectDevices collection entry: \"%s\" - %s" % (scDevice.Title, scDevice.DiscoveryResult.Description), colorValue=SIColors.ForestGreen)
-
-
-    def GetActiveDevice(
-        self, 
-        ) -> SpotifyConnectDevice:
-        """ 
-        Returns a Spotify Connect device if one is currently marked as the active device;
-        otherwise, null if there is no active device.
-
-        Note that this does not perform a real-time Spotify Web API query for the active device.
-        It simply checks the devices collection for an entry that was marked as the active device
-        by the `UpdatePlayerDevices` method.
-        """
-        # find and return the active device if one exists; otherwise, null.
-        result:SpotifyConnectDevice = None
-        scDevice:SpotifyConnectDevice
-        for scDevice in self._Items:
-            if (scDevice.DeviceInfo is not None):
-                if (scDevice.DeviceInfo.IsActiveDevice):
-                    result = scDevice
-                    break
-        return result
-
-
-    def RemoveDevice(
-        self,
-        deviceId:str,
-        dynamicDeviceOnly:bool=False
-        ) -> None:
-        """
-        Removes existing device entry(s) from the `Items` collection by device id value.
-        
-        Args:
-            deviceId (str):
-                Device id to remove.
-            dynamicDeviceOnly (str):
-                True to only remove the device if it's a dynamic device entry;
-                otherwise, False to remove the device id regardless.  
-                Default is False.
-
-        It's possible to have multiple devices with the same id (e.g. both a dynamic and a
-        zeroconf registered device).
-
-        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 Player
-        client devices (e.g. mobile / web / desktop players) that utilize temporary device id's.
-        """
-        # validations.
-        if (not isinstance(dynamicDeviceOnly,bool)):
-            dynamicDeviceOnly = False
-
-        # remove device from devices collection;
-        # the reversed() function creates an iterator that traverses the list in reverse order. 
-        # this ensures that removing an element doesn't affect the indices of the subsequent 
-        # elements we're going to iterate over.
-        deviceIdCompare:str = "" + deviceId.lower()
-        scDevice:SpotifyConnectDevice
-        for idx in reversed(range(len(self._Items))):
-
-            scDevice = self._Items[idx]
-
-            # did we find a match by device id?
-            if (deviceIdCompare == scDevice.Id.lower()):
-
-                isFound:bool = True
-
-                # get dynamic device status.
-                isDynamic:bool = False
-                if (scDevice.DiscoveryResult is not None):
-                   isDynamic = scDevice.DiscoveryResult.IsDynamicDevice
-
-                # are we checking for dynamic device? if so, and it's NOT dynamic, then don't delete it!
-                if (dynamicDeviceOnly) and (not isDynamic):
-                    isFound = False
-
-                # are we deleting this device?
-                if (isFound):
-                    _logsi.LogVerbose("Removing SpotifyConnectDevices collection entry: \"%s\" - %s" % (scDevice.Title, scDevice.DiscoveryResult.Description), colorValue=SIColors.Orange)
-                    self._Items.pop(idx)
-
-
-    def UpdatePlayerDevices(
-        self, 
-        playerDevices:list[Device],
-        activeUser:str,
-        playerState:PlayerPlayState=None
-        ) -> SpotifyConnectDevice:
-        """ 
-        Adds a list of dynamic player device entries to the `Items` collection, removes any
-        existing dynamic devices from the collection that are not in the `playerDevices` list,
-        and updates the currently active device based on playerState.
-        
-        Args:
-            playerDevices (list[Device]):
-                List of current player devices obtained via a call to `GetPlayerDevices` method.
-            activeUser (str):
-                Currently active user id.
-            playerState (PlayerPlayState):
-                Current player state obtained via a call to `GetPlayerPlaybackState` method
-                which will be used to set the active device in the `Items` collection;
-                otherwise, null to bypass active device set.
-
-        Returns:
-            null if the `playerState` argument was not specified; 
-            otherwise, the currently active Spotify Player device instance as determined by
-            the Spotify Player PlayState.
-
-        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 Player
-        client devices (e.g. mobile / web / desktop players) that utilize temporary device id's.
-        """
-        result:SpotifyConnectDevice = None
-
-        # validations
-        if (not isinstance(playerDevices, list)):
-            return result
-
-        # add dynamic devices.
-        scDevice:SpotifyConnectDevice
-        device:Device
-        for device in playerDevices:
-
-            # is the player device present in the collection? if not, then add it.
-            if (not self.ContainsDeviceId(device.Id)):
-                self.AddDynamicDevice(device, activeUser)
-                        
-            # is the device in the available device list for this user context?
-            # if not, then set an indicator so we can re-activate it later if need be.
-            for scDevice in self._Items:
-                if (scDevice.DeviceInfo.DeviceId == device.Id):
-                    scDevice.DeviceInfo.IsInDeviceList = True
-                    break
-
-        # remove stale dynamic devices from results collection;
-        # the reversed() function creates an iterator that traverses the list in reverse order. 
-        # this ensures that removing an element doesn't affect the indices of the subsequent 
-        # elements we're going to iterate over.
-        for idx in reversed(range(len(self._Items))):
-
-            # only process dynamic devices.
-            scDevice = self._Items[idx]
-            if (scDevice.DiscoveryResult.IsDynamicDevice):
-
-                # process all player devices.
-                wasFound:bool = False
-                playerDevice:Device
-                for playerDevice in playerDevices:
-                    if (scDevice.Id == playerDevice.Id):
-                        wasFound = True
-                        break
-
-                # if collection entry was not found in the player device list then remove it.
-                if (not wasFound):
-                    _logsi.LogVerbose("Removed dynamic device \"%s\" (%s) from Spotify Connect Devices collection" % (scDevice.Name, scDevice.Id))
-                    self._Items.pop(idx)
-
-        # update active device entry.
-        # returns null if the `playerState` argument was not specified; 
-        # otherwise, the currently active Spotify Player device instance as determined by
-        # the Spotify Player PlayState (could be null if no active device).
-        result = self.UpdateActiveDevice(playerState)
-        return result
-
-
-    def UpdateActiveDevice(
-        self, 
-        playerState:PlayerPlayState=None
-        ) -> SpotifyConnectDevice:
-        """ 
-        Updates the currently active device based on playerState.
-        
-        Args:
-            playerState (PlayerPlayState):
-                Current player state obtained via a call to `GetPlayerPlaybackState` method
-                which will be used to set the active device in the `Items` collection;
-                otherwise, null to bypass active device set.
-
-        Returns:
-            The currently active Spotify Player device instance as determined by
-            the Spotify Player PlayState; could be null if no active device was found.
-        """
-        result:SpotifyConnectDevice = None
-
-        if (isinstance(playerState, PlayerPlayState)):
-
-            # we do this in case the active device is a "restricted" device; if it is, then it may 
-            # not show up as the active device (common issue with Sonos devices).  
-            # in this case, it WILL show up in the player state device property as the active device.
-            # if it IS active, then we will set the active flag.        
-            # note that the PlayerPlayState device is a name and not a device id.
-            if playerState.Device is not None:
-
-                device = playerState.Device
-                for scDevice in self._Items:
-                    scDevice.DeviceInfo.IsActiveDevice = False
-                    if (device.Name == scDevice.Name):
-                        _logsi.LogVerbose("Spotify Connect active device detected: \"%s\" (%s)" % (device.Name, device.Id))
-                        scDevice.DeviceInfo.IsActiveDevice = True
-                        result = scDevice
-
-        # returns null if the `playerState` argument was not specified; 
-        # otherwise, the currently active Spotify Player device instance as determined by
-        # the Spotify Player PlayState (could be null if no active device).
-        return result
-
-
     def ContainsDeviceId(self, value:str) -> bool:
         """ 
         Returns True if the `Items` collection contains the specified device id value;
@@ -457,15 +185,17 @@ class SpotifyConnectDevices():
             if (scDevice.DeviceInfo.HasAliases):
                 scAlias:ZeroconfGetInfoAlias
                 for scAlias in scDevice.DeviceInfo.Aliases:
-                    if (scAlias.Id.lower() == value):
-                        result = scDevice
-                        break
+                    if (scAlias.Id is not None):
+                        if (scAlias.Id.lower() == value):
+                            result = scDevice
+                            break
                 if result:
                     break
             else:
-                if (scDevice.DeviceInfo.DeviceId.lower() == value):
-                    result = scDevice
-                    break
+                if (scDevice.DeviceInfo.DeviceId is not None):
+                    if (scDevice.DeviceInfo.DeviceId.lower() == value):
+                        result = scDevice
+                        break
         return result
     
 
@@ -489,15 +219,17 @@ class SpotifyConnectDevices():
             if (scDevice.DeviceInfo.HasAliases):
                 scAlias:ZeroconfGetInfoAlias
                 for scAlias in scDevice.DeviceInfo.Aliases:
-                    if (scAlias.Name.lower() == value):
-                        result = scDevice
-                        break
+                    if (scAlias.Name is not None):
+                        if (scAlias.Name.lower() == value):
+                            result = scDevice
+                            break
                 if result is not None:
                     break
             else:
-                if (scDevice.DeviceInfo.RemoteName.lower() == value):
-                    result = scDevice
-                    break
+                if (scDevice.DeviceInfo.RemoteName is not None):
+                    if (scDevice.DeviceInfo.RemoteName.lower() == value):
+                        result = scDevice
+                        break
         return result
     
 
@@ -547,29 +279,6 @@ class SpotifyConnectDevices():
         return result
     
 
-    def GetDeviceIndexByDiscoveryKey(self, value:str) -> int:
-        """ 
-        Returns the index of the `Items` collection entry that contains 
-        the specified device zeroconf discovery results key value if found; 
-        otherwise, -1.
-        """
-        result:int = -1
-        if value is None:
-            return result
-        
-        # convert case for comparison.
-        value = value.lower()
-
-        # process all devices, comparing discovery keys.
-        for i in range(len(self._Items)):
-            if (self._Items[i].DiscoveryResult is not None):
-                if (self._Items[i].DiscoveryResult.Key is not None):
-                    if (self._Items[i].DiscoveryResult.Key.lower() == value):
-                        result = i
-                        break       
-        return result
-
-
     def GetDeviceIndexByDiscoveryName(self, value:str) -> int:
         """ 
         Returns the index of the `Items` collection entry that contains 

spotifywebapipython/models/zeroconfdiscoveryresult.py

@@ -1,6 +1,3 @@
-# external package imports.
-from zeroconf import ServiceInfo
-
 # our package imports.
 from ..sautils import export
 from .zeroconfproperty import ZeroconfProperty
@@ -31,14 +28,12 @@ class ZeroconfDiscoveryResult:
         self._Properties:list = []
         self._Server:str = None
         self._ServerKey:str = None
-        self._ServiceInfo:ServiceInfo = None
         self._ServiceType:str = None
         self._Weight:int = None
 
         # Spotify Connect specific properties:
         self._SpotifyConnectCPath:str = None
         self._SpotifyConnectVersion:str = None
-        self._SpotifyConnectIsInDeviceList:bool = False
 
 
     def __repr__(self) -> str:
@@ -330,22 +325,6 @@ class ZeroconfDiscoveryResult:
             self._ServerKey = value
 
 
-    @property
-    def ServiceInfo(self) -> ServiceInfo:
-        """ 
-        Zeroconf Service info object.
-        """
-        return self._ServiceInfo
-    
-    @ServiceInfo.setter
-    def ServiceInfo(self, value:ServiceInfo):
-        """ 
-        Sets the ServiceInfo property value.
-        """
-        if isinstance(value, ServiceInfo):
-            self._ServiceInfo = value
-
-
     @property
     def ServiceType(self) -> str:
         """ 
@@ -397,22 +376,6 @@ class ZeroconfDiscoveryResult:
             self._SpotifyConnectCPath = value
 
 
-    @property
-    def SpotifyConnectIsInDeviceList(self) -> bool:
-        """ 
-        True if the device is in the Spotify Player active device list; otherwise, False.
-        """
-        return self._SpotifyConnectIsInDeviceList
-    
-    @SpotifyConnectIsInDeviceList.setter
-    def SpotifyConnectIsInDeviceList(self, value:bool):
-        """ 
-        Sets the SpotifyConnectIsInDeviceList property value.
-        """
-        if isinstance(value, bool):
-            self._SpotifyConnectIsInDeviceList = value
-
-
     @property
     def SpotifyConnectVersion(self) -> str:
         """ 
@@ -485,11 +448,9 @@ class ZeroconfDiscoveryResult:
         if (self._Weight != obj._Weight): return result
         if (self._SpotifyConnectCPath != obj._SpotifyConnectCPath): return result
         if (self._SpotifyConnectVersion != obj._SpotifyConnectVersion): return result
-        if (self._SpotifyConnectIsInDeviceList != obj._SpotifyConnectIsInDeviceList): return result
 
         # don't compare the following:
         # self._Properties:list = []
-        # self._ServiceInfo:ServiceInfo = None
 
         # objects attributes are equal.
         return True
@@ -528,8 +489,8 @@ class ZeroconfDiscoveryResult:
             'HostIpAddresses': [ str(item) for item in self._HostIpAddresses ],
             'HostIpPort': self._HostIpPort,
             'HostTTL': self._HostTTL,
-            'IsDynamicDevice': self.IsDynamicDevice,
             'IsChromeCast': self._IsChromeCast,
+            'IsDynamicDevice': self.IsDynamicDevice,
             'Key': self._Key,
             'Name': self._Name,
             'Priority': self._Priority,
@@ -541,7 +502,6 @@ class ZeroconfDiscoveryResult:
             'Description': self.Description,
             'Properties': [ item.ToDictionary() for item in self._Properties ],
             'SpotifyConnectCPath': self._SpotifyConnectCPath,
-            'SpotifyConnectIsInDeviceList': self._SpotifyConnectIsInDeviceList,
             'SpotifyConnectVersion': self._SpotifyConnectVersion,
             'ZeroconfApiEndpointAddUser': self.ZeroconfApiEndpointAddUser,
             'ZeroconfApiEndpointGetInformation': self.ZeroconfApiEndpointGetInformation,
@@ -591,7 +551,6 @@ class ZeroconfDiscoveryResult:
         if description is not None: msg = '%s\n Description="%s"' % (msg, str(description))
         if self._Properties is not None: msg = '%s\n Properties Count=%s' % (msg, str(len(self._Properties)))
         if self._SpotifyConnectCPath is not None: msg = '%s\n SpotifyConnectCPath="%s"' % (msg, str(self._SpotifyConnectCPath))
-        if self._SpotifyConnectIsInDeviceList is not None: msg = '%s\n SpotifyConnectIsInDeviceList="%s"' % (msg, str(self._SpotifyConnectIsInDeviceList))
         if self._SpotifyConnectVersion is not None: msg = '%s\n SpotifyConnectVersion="%s"' % (msg, str(self._SpotifyConnectVersion))
         if zeroconfApiEndpointAddUser is not None: msg = '%s\n ZeroconfApiEndpointAddUser="%s"' % (msg, zeroconfApiEndpointAddUser)
         if zeroconfApiEndpointGetInformation is not None: msg = '%s\n ZeroconfApiEndpointGetInformation="%s"' % (msg, zeroconfApiEndpointGetInformation)

spotifywebapipython/sautils.py

@@ -79,7 +79,6 @@ def export(fn):
     
 
 def validateDelay(
-        self, 
         delay:float, 
         default:float=0.5, 
         maxDelay:float=10