spotifywebapiPython 1.0.242__py3-none-any.whl

spotifywebapipython/models/showsimplified.py

@@ -0,0 +1,320 @@
+# external package imports.
+
+# our package imports.
+from ..sautils import export
+from .copyright import Copyright
+from .externalurls import ExternalUrls
+from .imageobject import ImageObject
+
+@export
+class ShowSimplified:
+    """
+    Spotify Web API SimplifiedShow object.
+    """
+
+    def __init__(self, root:dict=None) -> 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._AvailableMarkets:list[str] = []
+        self._Copyrights:list[Copyright] = []
+        self._Description:str = None
+        self._Explicit:bool = None
+        self._ExternalUrls:ExternalUrls = None
+        self._Href:str = None
+        self._HtmlDescription:str = None
+        self._Id:int = None
+        self._Images:list[ImageObject] = []
+        self._IsExternallyHosted:bool = None
+        self._Languages:list[str] = []
+        self._MediaType:str = None
+        self._Name:str = None
+        self._Publisher:str = None
+        self._TotalEpisodes:int = None
+        self._Type:str = None
+        self._Uri:str = None
+        
+        if (root is None):
+
+            pass
+        
+        else:
+
+            self._AvailableMarkets = root.get('available_markets', None) or []
+            self._Description = root.get('description', None)
+            self._Explicit = root.get('explicit', None)
+            self._Href = root.get('href', None)
+            self._HtmlDescription = root.get('html_description', None)
+            self._Id = root.get('id', None)
+            self._IsExternallyHosted = root.get('is_externally_hosted', None)
+            self._Languages = root.get('languages', None) or []
+            self._MediaType = root.get('media_type', None)
+            self._Name = root.get('name', None)
+            self._Publisher = root.get('publisher', None)
+            self._TotalEpisodes = root.get('total_episodes', None)
+            self._Type = root.get('type', None)
+            self._Uri = root.get('uri', None)
+
+            # process all collections and objects.
+            items:list = root.get('copyrights',None)
+            if items is not None:
+                for item in items:
+                    self._Copyrights.append(Copyright(root=item))
+
+            item:dict = root.get('external_urls',None)
+            if item is not None:
+                self._ExternalUrls = ExternalUrls(root=item)
+
+            items:list = root.get('images',None)
+            if items is not None:
+                for item in items:
+                    self._Images.append(ImageObject(root=item))
+
+        
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    # implement sorting support.
+    def __eq__(self, other):
+        try:
+            return self.Name == other.Name
+        except Exception:
+            if (isinstance(self, ShowSimplified )) and (isinstance(other, ShowSimplified )):
+                return self.Name == other.Name
+            return False
+
+    def __lt__(self, other):
+        try:
+            return self.Name < other.Name
+        except Exception:
+            if (isinstance(self, ShowSimplified )) and (isinstance(other, ShowSimplified )):
+                return self.Name < other.Name
+            return False
+
+
+    @property
+    def AvailableMarkets(self) -> list[str]:
+        """ 
+        A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
+        """
+        return self._AvailableMarkets
+
+
+    @property
+    def Copyrights(self) -> list[Copyright]:
+        """ 
+        The copyright statements of the show.
+        """
+        return self._Copyrights
+    
+
+    @property
+    def Description(self) -> str:
+        """ 
+        A description of the show.  
+        HTML tags are stripped away from this field, use `HtmlDescription` property in case HTML tags are needed.
+        """
+        return self._Description
+
+
+    @property
+    def Explicit(self) -> bool:
+        """ 
+        Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
+        """
+        return self._Explicit
+
+
+    @property
+    def ExternalUrls(self) -> ExternalUrls:
+        """ 
+        Known external URLs for the show.
+        """
+        return self._ExternalUrls
+    
+
+    @property
+    def Href(self) -> str:
+        """ 
+        A link to the Web API endpoint providing full details of the show.
+        Example: `https://api.spotify.com/v1/shows/3IM0lmZxpFAY7CwMuv9H4g?locale=en-US%2Cen%3Bq%3D0.9`
+        """
+        return self._Href
+
+
+    @property
+    def HtmlDescription(self) -> str:
+        """ 
+        A description of the show.  
+        This field may contain HTML tags.
+        """
+        return self._HtmlDescription
+
+
+    @property
+    def Id(self) -> str:
+        """ 
+        The Spotify ID for the show.
+        Example: `3IM0lmZxpFAY7CwMuv9H4g`
+        """
+        return self._Id
+
+
+    @property
+    def Images(self) -> list[ImageObject]:
+        """ 
+        The cover art for the show in various sizes, widest first.
+        """
+        return self._Images
+
+
+    @property
+    def ImageUrl(self) -> str:
+        """
+        Gets the first image url in the `Images` list, if images are defined;
+        otherwise, null.
+        """
+        return ImageObject.GetImageHighestResolution(self._Images)
+    
+        
+    @property
+    def IsExternallyHosted(self) -> bool:
+        """ 
+        True if all of the shows episodes are hosted outside of Spotify's CDN.  
+        This field might be null in some cases.
+        """
+        return self._IsExternallyHosted
+
+
+    @property
+    def Languages(self) -> list[str]:
+        """ 
+        A list of the languages used in the show, identified by their ISO 639-1 code.
+        
+        Example: `[fr,en]`
+        """
+        return self._Languages
+
+
+    @property
+    def MediaType(self) -> str:
+        """ 
+        The media type of the show.
+        
+        Example: `audio`
+        """
+        return self._MediaType
+
+
+    @property
+    def Name(self) -> str:
+        """ 
+        The name of the show.
+        """
+        return self._Name
+
+
+    @property
+    def Publisher(self) -> str:
+        """ 
+        The publisher of the show.
+        """
+        return self._Publisher
+
+
+    @property
+    def TotalEpisodes(self) -> int:
+        """ 
+        The total number of episodes in the show.
+        """
+        return self._TotalEpisodes
+
+
+    @property
+    def Type(self) -> str:
+        """ 
+        The object type: `show`.
+        """
+        return self._Type
+
+
+    @property
+    def Uri(self) -> str:
+        """ 
+        The Spotify URI for the show.
+        """
+        return self._Uri
+
+
+    def ToDictionary(self) -> dict:
+        """
+        Returns a dictionary representation of the class.
+        """
+        externalUrls:dict = {}
+        if self._ExternalUrls is not None:
+            externalUrls = self._ExternalUrls.ToDictionary()
+
+        result:dict = \
+        {
+            'available_markets': [ item for item in self._AvailableMarkets ],
+            'copyrights': [ item.ToDictionary() for item in self._Copyrights ],
+            'description': self._Description,
+            'explicit': self._Explicit,
+            'external_urls': externalUrls,
+            'href': self._Href,
+            'html_description': self._HtmlDescription,
+            'id': self._Id,
+            'image_url': self.ImageUrl,
+            'images': [ item.ToDictionary() for item in self._Images ],
+            'is_externally_hosted': self._IsExternallyHosted,
+            'languages': [ item for item in self._Languages ],
+            'media_type': self._MediaType,
+            'name': self._Name,
+            'publisher': self._Publisher,
+            'total_episodes': self._TotalEpisodes,
+            'type': self._Type,
+            'uri': self._Uri,           
+        }
+        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 = 'ShowSimplified:'
+        
+        if self._Name is not None: msg = '%s\n Name="%s"' % (msg, str(self._Name))
+        if self._Uri is not None: msg = '%s\n Uri="%s"' % (msg, str(self._Uri))
+        if self._AvailableMarkets is not None: msg = '%s\n AvailableMarkets Count=%s' % (msg, str(len(self._AvailableMarkets)))
+        #if self._Copyrights is not None: msg = '%s\n %s' % (msg, str(self._Copyrights))
+        if self._Description is not None: msg = '%s\n Description="%s"' % (msg, str(self._Description))
+        if self._Explicit is not None: msg = '%s\n Explicit="%s"' % (msg, str(self._Explicit))
+        #if self._ExternalUrls is not None: msg = '%s\n %s' % (msg, str(self._ExternalUrls))
+        if self._Href is not None: msg = '%s\n Href="%s"' % (msg, str(self._Href))
+        if self._HtmlDescription is not None: msg = '%s\n HtmlDescription="%s"' % (msg, str(self._HtmlDescription))
+        if self._Id is not None: msg = '%s\n Id="%s"' % (msg, str(self._Id))
+        if self._Images is not None: msg = '%s\n Images Count=%s' % (msg, str(len(self._Images)))
+        if self._IsExternallyHosted is not None: msg = '%s\n IsExternallyHosted="%s"' % (msg, str(self._IsExternallyHosted))
+        if self._Languages is not None: msg = '%s\n Languages="%s"' % (msg, str(self._Languages))
+        if self._MediaType is not None: msg = '%s\n MediaType="%s"' % (msg, str(self._MediaType))
+        if self._Publisher is not None: msg = '%s\n Publisher="%s"' % (msg, str(self._Publisher))
+        if self._TotalEpisodes is not None: msg = '%s\n TotalEpisodes="%s"' % (msg, str(self._TotalEpisodes))
+        if self._Type is not None: msg = '%s\n Type="%s"' % (msg, str(self._Type))
+        return msg 

spotifywebapipython/models/spotifyconnectdevice.py

@@ -0,0 +1,321 @@
+# external package imports.
+
+# our package imports.
+from ..sautils import export
+from .zeroconfdiscoveryresult import ZeroconfDiscoveryResult
+from spotifywebapipython.zeroconfapi import ZeroconfGetInfo, ZeroconfResponse
+
+@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._DeviceIdActivated:str = None
+        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
+
+
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    @property
+    def DeviceIdActivated(self) -> str:
+        """ 
+        Google Cast device id value (e.g. "30fbc80e35598f3c242f2120413c943dfd9715fe")
+        that was activated by the Spotify Cast App;   
+        Otherwise, None if the device has not been activated yet.
+        
+        This value can be different from the `Id` value for cast groups that send connect
+        commands to the group coordinator instead of the group itself.
+
+        It is only populated by Google Cast processing; Spotify Connect Zeroconf does not
+        populate this property.
+        """
+        return self._DeviceIdActivated
+    
+    @DeviceIdActivated.setter
+    def DeviceIdActivated(self, value:str):
+        """ 
+        Sets the DeviceIdActivated property value.
+        """
+        self._DeviceIdActivated = value
+    
+
+    @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
+
+
+    @property
+    def Id(self) -> str:
+        """ 
+        Spotify Connect device id value (e.g. "30fbc80e35598f3c242f2120413c943dfd9715fe").
+        """
+        return self._Id
+    
+    @Id.setter
+    def Id(self, value:str):
+        """ 
+        Sets the Id property value.
+        """
+        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 IsAmazonDevice(self) -> bool:
+        """ 
+        True if the device is an Amazon device; otherwise, False.
+        """
+        if (isinstance(self._Id, str)):
+
+            # simple check for an Amazon-like device id (e.g. "04a02956-eb74-4a98-8bce-e37b21a8aee5_amzn_1").
+            value:str = self._Id.lower()
+            if (value.find("_amzn_") > -1) and (value.count("-") > 2):
+                return True
+
+        return False
+    
+
+    @property
+    def IsChromeCast(self) -> bool:
+        """ 
+        True if the device is a Google ChromeCast device; otherwise, False.
+        """
+        if (self._DiscoveryResult is not None):
+            return self._DiscoveryResult.IsChromeCast
+        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 IsSonos(self) -> bool:
+        """ 
+        True if the device is a Sonos device; otherwise, False.
+        """
+        if (self._DeviceInfo is not None):
+            return self._DeviceInfo.IsBrandSonos
+        return False
+    
+
+    @property
+    def Name(self) -> str:
+        """ 
+        Spotify Connect device name value (e.g. "Bose-ST10-1").
+        """
+        return self._Name
+    
+    @Name.setter
+    def Name(self, value:str):
+        """ 
+        Sets the Name property value.
+        """
+        self._Name = value
+    
+
+    @property
+    def Title(self) -> str:
+        """ 
+        Spotify Connect device name and id value (e.g. "Bose-ST10-1" (30fbc80e35598f3c242f2120413c943dfd9715fe)).
+        """
+        return "\"%s\" (%s)" % (self._Name, self._Id)
+    
+
+    @property
+    def WasReConnected(self) -> bool:
+        """ 
+        True if the device was re-connected, after being inactive or disconnected.
+        """
+        return self._WasReConnected
+    
+    @WasReConnected.setter
+    def WasReConnected(self, value:bool):
+        """ 
+        Sets the WasReConnected property value.
+        """
+        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
+        values as our object instance values; otherwise, False.
+
+        Args:
+            obj (SpotifyConnectDevice):
+                Object instance to compare.
+        """
+        result:bool = False
+        if (not isinstance(obj, type(self))):
+            return result
+
+        # compare attributes for equality.
+        if (self._Id != obj._Id): return result
+        if (self._Name != obj._Name): return result
+        if (not self._DeviceInfo.Equals(obj._DeviceInfo)): return result
+        if (not self._DiscoveryResult.Equals(obj._DiscoveryResult)): return result
+
+        # objects attributes are equal.
+        return True
+
+
+    def ToDictionary(self) -> dict:
+        """
+        Returns a dictionary representation of the class.
+        """
+        result:dict = \
+        {
+            'Id': self._Id,
+            'Name': self._Name,
+            'Title': self.Title,
+            'IsActiveDevice': self._IsActiveDevice,
+            'IsChromeCast': self.IsChromeCast,
+            'IsInDeviceList': self._IsInDeviceList,
+            'IsRestricted': self._IsRestricted,
+            'IsSonos': self.IsSonos,
+            'WasReConnected': self._WasReConnected,
+            'DeviceIdActivated': self._DeviceIdActivated,
+            'DeviceInfo': self._DeviceInfo.ToDictionary(),
+            'DiscoveryResult': self._DiscoveryResult.ToDictionary(),
+            'ZeroconfResponseInfo': self._ZeroconfResponseInfo.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._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 IsSonos="%s"' % (msg, str(self.IsSonos))
+            msg = '%s\n WasReConnected="%s"' % (msg, str(self._WasReConnected))
+            msg = '%s\n DeviceIdActivated="%s"' % (msg, str(self._DeviceIdActivated))
+            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