spotifywebapiPython 1.0.50__py3-none-any.whl → 1.0.52__py3-none-any.whl

spotifywebapipython/models/device.py

@@ -64,6 +64,24 @@ class Device:
         return self.ToString()
 
 
+    # implement sorting support.
+    def __eq__(self, other):
+        try:
+            return self.Name == other.Name
+        except Exception as ex:
+            if (isinstance(self, Device )) and (isinstance(other, Device )):
+                return self.Name == other.Name
+            return False
+
+    def __lt__(self, other):
+        try:
+            return self.Name < other.Name
+        except Exception as ex:
+            if (isinstance(self, Device )) and (isinstance(other, Device )):
+                return self.Name < other.Name
+            return False
+
+
     @property
     def Id(self) -> str:
         """ 
@@ -74,6 +92,14 @@ class Device:
         """
         return self._Id
 
+    @Id.setter
+    def Id(self, value:str):
+        """ 
+        Sets the Id property value.
+        """
+        if isinstance(value, str):
+            self._Id = value
+
 
     @property
     def IsActive(self) -> bool:
@@ -82,6 +108,14 @@ class Device:
         """
         return self._IsActive
 
+    @IsActive.setter
+    def IsActive(self, value:bool):
+        """ 
+        Sets the IsActive property value.
+        """
+        if isinstance(value, bool):
+            self._IsActive = value
+
 
     @property
     def IsMuted(self) -> bool:
@@ -122,6 +156,14 @@ class Device:
         """
         return self._Name
 
+    @Name.setter
+    def Name(self, value:str):
+        """ 
+        Sets the Name property value.
+        """
+        if isinstance(value, str):
+            self._Name = value
+
 
     @property
     def SelectItemNameAndId(self) -> str:
@@ -151,6 +193,14 @@ class Device:
         """
         return self._Type
 
+    @Type.setter
+    def Type(self, value:str):
+        """ 
+        Sets the Type property value.
+        """
+        if isinstance(value, str):
+            self._Type = value
+
 
     @property
     def VolumePercent(self) -> int:

spotifywebapipython/models/spotifyconnectdevice.py

@@ -0,0 +1,93 @@
+# external package imports.
+from zeroconf import ServiceInfo
+
+# our package imports.
+from ..sautils import export
+from .zeroconfdiscoveryresult import ZeroconfDiscoveryResult
+from spotifywebapipython.zeroconfapi.zeroconfgetinfo import ZeroconfGetInfo
+
+@export
+class SpotifyConnectDevice():
+    """
+    Spotify Connect Device object.
+    
+    Information about the Spotify Connect device, which is a combination of the 
+    `ZeroconfDiscoveryResult` and `ZeroconfGetInfo` classes.
+    """
+
+    def __init__(self) -> None:
+        """
+        Initializes a new instance of the class.
+        """
+        self._DiscoveryResult:ZeroconfDiscoveryResult = None
+        self._DeviceInfo:ZeroconfGetInfo = None
+
+
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    @property
+    def DiscoveryResult(self) -> ZeroconfDiscoveryResult:
+        """ 
+        Information about the Zeroconf entry for a SpotifyConnect device as found by Zeroconf (mDNS).
+        """
+        return self._DiscoveryResult
+    
+    @DiscoveryResult.setter
+    def DiscoveryResult(self, value:ZeroconfDiscoveryResult):
+        """ 
+        Sets the DiscoveryResult property value.
+        """
+        if isinstance(value, ZeroconfDiscoveryResult):
+            self._DiscoveryResult = value
+
+
+    @property
+    def DeviceInfo(self) -> ZeroconfGetInfo:
+        """ 
+        Spotify Zeroconf API GetInfo response object.
+        """
+        return self._DeviceInfo
+    
+    @DeviceInfo.setter
+    def DeviceInfo(self, value:ZeroconfGetInfo):
+        """ 
+        Sets the DeviceInfo property value.
+        """
+        if isinstance(value, ZeroconfGetInfo):
+            self._DeviceInfo = value
+
+
+    def ToDictionary(self) -> dict:
+        """
+        Returns a dictionary representation of the class.
+        """
+        result:dict = \
+        {
+            'DeviceInfo': self._DeviceInfo.ToDictionary(),
+            'DiscoveryResult': self._DiscoveryResult.ToDictionary(),
+        }
+        return result
+        
+
+    def ToString(self, includeTitle:bool=True) -> str:
+        """
+        Returns a displayable string representation of the class.
+        
+        Args:
+            includeTitle (str):
+                True to include the class name title prefix.
+        """
+        msg:str = ''
+        if includeTitle: 
+            msg = 'Device: "%s" (%s)' % (self._DiscoveryResult.DeviceName, self._DeviceInfo.DeviceId)
+           
+        # build result.
+        msg = '%s\n %s\n' % (msg, str(self._DeviceInfo.ToString(True)))
+        msg = '%s\n %s\n' % (msg, str(self._DiscoveryResult.ToString(True)))
+        return msg 

spotifywebapipython/models/spotifyconnectdevices.py

@@ -0,0 +1,240 @@
+# external package imports.
+from typing import Iterator
+
+# our package imports.
+from ..sautils import export
+from .device import Device
+from .spotifyconnectdevice import SpotifyConnectDevice
+from .zeroconfdiscoveryresult import ZeroconfDiscoveryResult
+from spotifywebapipython.zeroconfapi import ZeroconfGetInfo, ZeroconfGetInfoAlias
+
+@export
+class SpotifyConnectDevices():
+    """
+    Spotify Connect Devices collection.
+    """
+
+    def __init__(self) -> None:
+        """
+        Initializes a new instance of the class.
+        """
+        self._Items:list[SpotifyConnectDevice] = []
+
+
+    def __getitem__(self, key) -> SpotifyConnectDevice:
+        return self._Presets[key]
+
+
+    def __iter__(self) -> Iterator:
+        return iter(self._Items)
+
+
+    def __len__(self) -> int:
+        return len(self._Items)
+
+
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    @property
+    def Items(self) -> list[SpotifyConnectDevice]:
+        """ 
+        Array of `SpotifyConnectDevice` objects.
+        """
+        return self._Items
+    
+
+    @property
+    def ItemsCount(self) -> int:
+        """ 
+        Number of objects in the `Items` property array.
+        """
+        if self._Items is not None:
+            return len(self._Items)
+        return 0
+    
+
+    def AddDynamicDevice(self, device:Device, activeUser:str) -> None:
+        """ 
+        Adds a new dynamic device entry to the `Items` collection.  
+        
+        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 devices in
+        a Spotify Connect web or mobile player.
+        """
+        # 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.HostIpv4Address = '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'
+        
+        # add the device.
+        scDevice:SpotifyConnectDevice = SpotifyConnectDevice()
+        scDevice.DeviceInfo = info
+        scDevice.DiscoveryResult = discoverResult
+        self._Items.append(scDevice)
+
+
+    def ContainsDeviceId(self, value:str) -> bool:
+        """ 
+        Returns True if the `Items` collection contains the specified device id value;
+        otherwise, False.
+        
+        Alias entries (if any) are also compared.
+        """
+        result:bool = False
+        if value is None:
+            return result
+        
+        # convert case for comparison.
+        value = value.lower()
+        
+        # process all discovered devices.
+        scDevice:SpotifyConnectDevice
+        for scDevice in self._Items:
+            if (scDevice.DeviceInfo.HasAliases):
+                scAlias:ZeroconfGetInfoAlias
+                for scAlias in scDevice.DeviceInfo.Aliases:
+                    if (scAlias.Id.lower() == value):
+                        result = True
+                        break
+                if result:
+                    break
+            else:
+                if (scDevice.DeviceInfo.DeviceId.lower() == value):
+                    result = True
+                    break
+        return result
+    
+
+    def ContainsDeviceName(self, value:str) -> bool:
+        """ 
+        Returns True if the `Items` collection contains the specified device name value;
+        otherwise, False.
+        
+        Alias entries (if any) are also compared.
+        """
+        result:bool = False
+        if value is None:
+            return result
+        
+        # convert case for comparison.
+        value = value.lower()
+        
+        # process all discovered devices.
+        scDevice:SpotifyConnectDevice
+        for scDevice in self._Items:
+            if (scDevice.DeviceInfo.HasAliases):
+                scAlias:ZeroconfGetInfoAlias
+                for scAlias in scDevice.DeviceInfo.Aliases:
+                    if (scAlias.Name.lower() == value):
+                        result = True
+                        break
+                if result:
+                    break
+            else:
+                if (scDevice.DeviceInfo.RemoteName.lower() == value):
+                    result = True
+                    break
+        return result
+    
+
+    def GetDeviceList(self) -> list[Device]:
+        """
+        Returns a list of `Device` objects that can be used to build a selection list
+        of available devices.  
+        
+        Note that the `Device` object has the following properties populated:
+        Id, Name, IsActive, Type.
+        """
+        result:list[Device] = []
+        
+        # process all discovered devices.
+        scDevice:SpotifyConnectDevice
+        for scDevice in self._Items:
+
+            # map device information details.
+            info:ZeroconfGetInfo = scDevice.DeviceInfo
+
+            # create new mock device.
+            device = Device()
+            device.IsActive = info.HasActiveUser
+            device.Type = info.DeviceType
+                
+            # are aliases being used (RemoteName is null if so)?
+            if info.RemoteName is None:
+                    
+                # if aliases are defined, then use the alias details.
+                infoAlias:ZeroconfGetInfoAlias
+                for infoAlias in info.Aliases:
+                    device.Id = infoAlias.Id
+                    device.Name = infoAlias.Name
+
+            else:
+
+                # if no aliases then use the remote name and id.
+                device.Id = info.DeviceId
+                device.Name = info.RemoteName
+
+            # append device to results.
+            result.append(device)
+
+        # sort items on Name property, ascending order.
+        if len(result) > 0:
+            result.sort(key=lambda x: (x.Name or "").lower(), reverse=False)
+
+        return result
+    
+
+    def ToDictionary(self) -> dict:
+        """
+        Returns a dictionary representation of the class.
+        """
+        result:dict = \
+        {
+            'ItemsCount': self.ItemsCount,
+            'Items': [ item.ToDictionary() for item in self._Items ],
+        }
+
+        return result
+        
+           
+    def ToString(self, includeItems:bool=False) -> str:
+        """
+        Returns a displayable string representation of the class.
+        
+        Args:
+            includeItems (bool):
+                True to include the Items collection of objects; otherwise, False
+                to only return base properties.
+        """
+        msg:str = 'Items Count=%s' % (str(self.ItemsCount))
+        
+        if (includeItems):
+            item:SpotifyConnectDevice
+            for item in self._Items:
+                msg = "%s\n- %s" % (msg, item.ToString(True))
+            
+        return msg 

spotifywebapipython/models/zeroconfdiscoveryresult.py

@@ -16,11 +16,6 @@ class ZeroconfDiscoveryResult:
     def __init__(self) -> None:
         """
         Initializes a new instance of the class.
-        
-        Args:
-            root (dict):
-                Spotify Web API JSON response in dictionary format, used to load object
-                attributes; otherwise, None to not load attributes.
         """
         self._DeviceName:str = None
         self._Domain:str = '.'
@@ -132,6 +127,19 @@ class ZeroconfDiscoveryResult:
             self._HostTTL = value
 
 
+    @property
+    def IsDynamicDevice(self) -> bool:
+        """
+        Returns True if the device is a dynamic device;
+        otherwise, False.
+        
+        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.       
+        """
+        return (self._HostIpPort == 0)
+
+
     @property
     def Key(self) -> str:
         """