spotifywebapiPython 1.0.242__py3-none-any.whl

spotifywebapipython/models/audiobook.py

@@ -0,0 +1,87 @@
+# external package imports.
+
+# our package imports.
+from ..sautils import export
+from .audiobooksimplified import AudiobookSimplified
+from .chapterpagesimplified import ChapterPageSimplified
+
+@export
+class Audiobook(AudiobookSimplified):
+    """
+    Spotify Web API Audiobook 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.
+        """
+        # initialize base class.
+        super().__init__(root=root)
+        
+        self._Chapters:ChapterPageSimplified = None
+        
+        if (root is None):
+
+            pass
+        
+        else:
+
+            # process all collections and objects.
+            item:dict = root.get('chapters',None)
+            if item is not None:
+                self._Chapters = ChapterPageSimplified(root=item)
+
+        
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    @property
+    def Chapters(self) -> ChapterPageSimplified:
+        """ 
+        The chapters of the audiobook.
+        
+        This is a `ChapterPageSimplified` object.
+        """
+        return self._Chapters
+
+
+    def ToDictionary(self) -> dict:
+        """
+        Returns a dictionary representation of the class.
+        """
+        # get base class result.
+        resultBase:dict = super().ToDictionary()
+
+        chapters:dict = {}
+        if self._Chapters is not None:
+            chapters = self._Chapters.ToDictionary()
+
+        result:dict = \
+        {
+            'chapters': chapters
+        }
+        
+        # combine base class results with these results.
+        resultBase.update(result)
+        
+        # return a sorted dictionary.
+        return resultBase
+        
+
+    def ToString(self) -> str:
+        """
+        Returns a displayable string representation of the class.
+        """
+        msg:str = 'Audiobook: %s' % super().ToString(False)
+        if self._Chapters is not None: msg = '%s\n Chapter Count=%s' % (msg, str(self._Chapters.Total))
+        return msg 

spotifywebapipython/models/audiobookpagesimplified.py

@@ -0,0 +1,88 @@
+# external package imports.
+
+# our package imports.
+from ..sautils import export
+from .audiobooksimplified import AudiobookSimplified
+from .pageobject import PageObject
+
+@export
+class AudiobookPageSimplified(PageObject):
+    """
+    Spotify Web API SimplifiedAudiobookPage object.
+    
+    This allows for multiple pages of `AudiobookSimplified` objects to be navigated.
+    """
+
+    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.
+        """
+        # initialize base class.
+        super().__init__(root=root)
+        
+        # initialize storage.
+        self._Items:list[AudiobookSimplified] = []
+        
+        if (root is None):
+
+            self._Total = 0
+        
+        else:
+
+            # process all collections and objects.
+            items:list = root.get('items',None)
+            if items is not None:
+                for item in items:
+                    if item is not None:
+                        self._Items.append(AudiobookSimplified(root=item))
+
+        
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    @property
+    def Items(self) -> list[AudiobookSimplified]:
+        """ 
+        Array of `AudiobookSimplified` objects.
+        """
+        return self._Items
+    
+
+    def ContainsId(self, itemId:str=False) -> bool:
+        """
+        Checks the `Items` collection to see if an item already exists with the
+        specified Id value.
+        
+        Returns True if the itemId exists in the collection; otherwise, False.
+        """
+        result:bool = False
+        
+        item:AudiobookSimplified
+        for item in self._Items:
+            if item.Id == itemId:
+                result = True
+                break
+            
+        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.
+        """
+        return 'AudiobookPageSimplified: %s' % super().ToString(includeItems)

spotifywebapipython/models/audiobooksimplified.py

@@ -0,0 +1,362 @@
+# external package imports.
+
+# our package imports.
+from ..sautils import export
+from .author import Author
+from .copyright import Copyright
+from .externalurls import ExternalUrls
+from .imageobject import ImageObject
+from .narrator import Narrator
+
+@export
+class AudiobookSimplified:
+    """
+    Spotify Web API Simplified Audiobook 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._Authors:list[Author] = []
+        self._AvailableMarkets:list[str] = []
+        self._Copyrights:list[Copyright] = []
+        self._Description:str = None
+        self._Edition:str = None
+        self._Explicit:bool = None
+        self._ExternalUrls:ExternalUrls = None
+        self._Href:str = None
+        self._HtmlDescription:str = None
+        self._Id:str = None
+        self._Images:list[ImageObject] = []
+        self._Languages:list[str] = []
+        self._MediaType:str = None
+        self._Name:str = None
+        self._Narrators:list[Narrator] = []
+        self._Publisher:str = None
+        self._TotalChapters: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._Edition = root.get('edition', 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._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._TotalChapters = root.get('total_chapters', None)
+            self._Type = root.get('type', None)
+            self._Uri = root.get('uri', None)
+
+            # process all collections and objects.
+            items:list = root.get('authors',None)
+            if items is not None:
+                for item in items:
+                    self._Authors.append(Author(root=item))
+
+            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))
+
+            items:list = root.get('narrators',None)
+            if items is not None:
+                for item in items:
+                    self._Narrators.append(Narrator(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, AudiobookSimplified )) and (isinstance(other, AudiobookSimplified )):
+                return self.Name == other.Name
+            return False
+
+    def __lt__(self, other):
+        try:
+            return self.Name < other.Name
+        except Exception:
+            if (isinstance(self, AudiobookSimplified )) and (isinstance(other, AudiobookSimplified )):
+                return self.Name < other.Name
+            return False
+
+
+    @property
+    def Authors(self) -> list[Author]:
+        """ 
+        The author(s) for the audiobook.
+        """
+        return self._Authors
+    
+
+    @property
+    def AvailableMarkets(self) -> list[str]:
+        """ 
+        A list of the countries in which the audiobook can be played, identified by 
+        their ISO 3166-1 alpha-2 code.
+        
+        Example: `["CA","BR","IT"]`
+        """
+        return self._AvailableMarkets
+
+
+    @property
+    def Copyrights(self) -> list[Copyright]:
+        """ 
+        The copyright statements of the audiobook.
+        """
+        return self._Copyrights
+    
+
+    @property
+    def Description(self) -> str:
+        """ 
+        A description of the audiobook.  
+        
+        HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
+        """
+        return self._Description
+
+
+    @property
+    def Edition(self) -> str:
+        """ 
+        The edition of the audiobook.  
+
+        Example: `Unabridged`
+        """
+        return self._Edition
+
+
+    @property
+    def Explicit(self) -> bool:
+        """ 
+        Whether or not the audiobook 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 audiobook.
+        """
+        return self._ExternalUrls
+    
+
+    @property
+    def Href(self) -> str:
+        """ 
+        A link to the Web API endpoint providing full details of the audiobook.
+        
+        Example: `https://api.spotify.com/v1/audiobooks/7iHfbu1YPACw6oZPAFJtqe`
+        """
+        return self._Href
+
+
+    @property
+    def HtmlDescription(self) -> str:
+        """ 
+        A description of the audiobook. This field may contain HTML tags.
+        """
+        return self._HtmlDescription
+
+
+    @property
+    def Id(self) -> str:
+        """ 
+        The Spotify ID for the audiobook.
+        
+        Example: `7iHfbu1YPACw6oZPAFJtqe`
+        """
+        return self._Id
+
+
+    @property
+    def Images(self) -> list[ImageObject]:
+        """ 
+        The cover art for the audiobook in various sizes, widest first.
+        """
+        return self._Images
+
+
+    @property
+    def ImageUrl(self) -> str:
+        """
+        Returns the highest resolution order image from the `Images` list, if images 
+        are defined; otherwise, null.
+        """
+        return ImageObject.GetImageHighestResolution(self._Images)
+            
+        
+    @property
+    def Languages(self) -> list[str]:
+        """ 
+        A list of the languages used in the audiobook, identified by their ISO 639-1 code.
+        
+        Example: `[fr,en]`
+        """
+        return self._Languages
+
+
+    @property
+    def MediaType(self) -> str:
+        """ 
+        The media type of the audiobook.
+        
+        Example: `audio`
+        """
+        return self._MediaType
+
+
+    @property
+    def Name(self) -> str:
+        """ 
+        The name of the audiobook.  
+        """
+        return self._Name
+
+
+    @property
+    def Narrators(self) -> list[Narrator]:
+        """ 
+        The narrator(s) for the audiobook.
+        """
+        return self._Narrators
+
+
+    @property
+    def Publisher(self) -> str:
+        """ 
+        The publisher of the audiobook.
+        """
+        return self._Publisher
+
+
+    @property
+    def TotalChapters(self) -> int:
+        """ 
+        The number of chapters in the audiobook.
+        """
+        return self._TotalChapters
+
+
+    @property
+    def Type(self) -> str:
+        """ 
+        The object type: `audiobook`.
+        """
+        return self._Type
+
+
+    @property
+    def Uri(self) -> str:
+        """ 
+        The Spotify URI for the audiobook.
+        
+        Example: `spotify:audiobook:7iHfbu1YPACw6oZPAFJtqe`
+        """
+        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 = \
+        {
+            'authors': [ item.ToDictionary() for item in self._Authors ],
+            'available_markets': [ item for item in self._AvailableMarkets ],
+            'copyrights': [ item.ToDictionary() for item in self._Copyrights ],
+            'description': self._Description,
+            'edition': self._Edition,
+            '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 ],
+            'languages': [ item for item in self._Languages ],
+            'media_type': self._MediaType,
+            'name': self._Name,
+            'narrators': [ item.ToDictionary() for item in self._Narrators ],
+            'publisher': self._Publisher,
+            'total_chapters': self._TotalChapters,
+            '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 = 'AudiobookSimplified:'
+            
+        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._Authors is not None: msg = '%s\n Authors Count=%s' % (msg, str(len(self._Authors)))
+        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._Edition is not None: msg = '%s\n Edition="%s"' % (msg, str(self._Edition))
+        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._Languages is not None: msg = '%s\n Languages Count=%s' % (msg, str(len(self._Languages)))
+        if self._MediaType is not None: msg = '%s\n MediaType="%s"' % (msg, str(self._MediaType))
+        if self._Narrators is not None: msg = '%s\n Narrators Count=%s' % (msg, str(len(self._Narrators)))
+        if self._Publisher is not None: msg = '%s\n Publisher="%s"' % (msg, str(self._Publisher))
+        if self._TotalChapters is not None: msg = '%s\n TotalChapters="%s"' % (msg, str(self._TotalChapters))
+        if self._Type is not None: msg = '%s\n Type="%s"' % (msg, str(self._Type))
+        return msg