spotifywebapiPython 1.0.17__py3-none-any.whl → 1.0.19__py3-none-any.whl

spotifywebapipython/models/chaptersimplified.py

@@ -96,7 +96,7 @@ class ChapterSimplified:
     def __eq__(self, other):
         try:
             return self.Name == other.Name
-        except Exception as ex:
+        except Exception:
             if (isinstance(self, ChapterSimplified )) and (isinstance(other, ChapterSimplified )):
                 return self.Name == other.Name
             return False
@@ -104,7 +104,7 @@ class ChapterSimplified:
     def __lt__(self, other):
         try:
             return self.Name < other.Name
-        except Exception as ex:
+        except Exception:
             if (isinstance(self, ChapterSimplified )) and (isinstance(other, ChapterSimplified )):
                 return self.Name < other.Name
             return False
@@ -216,6 +216,17 @@ class ChapterSimplified:
         return self._Images
 
 
+    @property
+    def ImageUrl(self) -> str:
+        """
+        Gets the first image url in the `Images` list, if images are defined;
+        otherwise, null.
+        """
+        if len(self._Images) > 0:
+            return self._Images[0].Url
+        return None
+            
+        
     @property
     def IsPlayable(self) -> bool:
         """ 

spotifywebapipython/models/episodepagesaved.py

@@ -2,6 +2,7 @@
 
 # our package imports.
 from ..sautils import export
+from .episode import Episode
 from .episodesaved import EpisodeSaved
 from .pageobject import PageObject
 
@@ -56,6 +57,20 @@ class EpisodePageSaved(PageObject):
         return self._Items
     
 
+    def GetEpisodes(self) -> list[Episode]:
+        """ 
+        Gets a list of all episodes contained in the underlying `Items` list.
+        
+        This is a convenience method so one does not have to loop through the `Items`
+        array of EpisodeSaved objects to get the list of episodes.
+        """
+        result:list[Episode] = []
+        item:EpisodeSaved
+        for item in self._Items:
+            result.append(item.Episode)
+        return result
+    
+
     def ToString(self, includeItems:bool=False) -> str:
         """
         Returns a displayable string representation of the class.

spotifywebapipython/models/episodesimplified.py

@@ -94,7 +94,7 @@ class EpisodeSimplified:
     def __eq__(self, other):
         try:
             return self.Name == other.Name
-        except Exception as ex:
+        except Exception:
             if (isinstance(self, EpisodeSimplified )) and (isinstance(other, EpisodeSimplified )):
                 return self.Name == other.Name
             return False
@@ -102,7 +102,7 @@ class EpisodeSimplified:
     def __lt__(self, other):
         try:
             return self.Name < other.Name
-        except Exception as ex:
+        except Exception:
             if (isinstance(self, EpisodeSimplified )) and (isinstance(other, EpisodeSimplified )):
                 return self.Name < other.Name
             return False
@@ -193,6 +193,17 @@ class EpisodeSimplified:
         return self._Images
 
 
+    @property
+    def ImageUrl(self) -> str:
+        """
+        Gets the first image url in the `Images` list, if images are defined;
+        otherwise, null.
+        """
+        if len(self._Images) > 0:
+            return self._Images[0].Url
+        return None
+            
+        
     @property
     def IsExternallyHosted(self) -> bool:
         """ 

spotifywebapipython/models/playlist.py

@@ -5,6 +5,7 @@ from ..sautils import export
 from .followers import Followers
 from .playlistpage import PlaylistPage
 from .playlistsimplified import PlaylistSimplified
+from .track import Track
 
 @export
 class Playlist(PlaylistSimplified):
@@ -70,6 +71,19 @@ class Playlist(PlaylistSimplified):
         return self._Tracks
 
 
+    def GetTracks(self) -> list[Track]:
+        """ 
+        Gets a list of all tracks contained in the underlying `Items` list.
+        
+        This is a convenience method so one does not have to loop through the `Items`
+        array of TrackSaved objects to get the list of tracks.
+        """
+        result:list[Track] = []
+        if self._Tracks is not None:
+            result = self._Tracks.GetTracks()
+        return result
+    
+
     def ToDictionary(self) -> dict:
         """
         Returns a dictionary representation of the class.

spotifywebapipython/models/playlistpage.py

@@ -4,6 +4,7 @@
 from ..sautils import export
 from .pageobject import PageObject
 from .playlisttrack import PlaylistTrack
+from .track import Track
 
 @export
 class PlaylistPage(PageObject):
@@ -56,6 +57,20 @@ class PlaylistPage(PageObject):
         return self._Items
     
 
+    def GetTracks(self) -> list[Track]:
+        """ 
+        Gets a list of all tracks contained in the underlying `Items` list.
+        
+        This is a convenience method so one does not have to loop through the `Items`
+        array of PlaylistTrack objects to get the list of tracks.
+        """
+        result:list[Track] = []
+        item:PlaylistTrack
+        for item in self._Items:
+            result.append(item.Track)
+        return result
+    
+
     def ToString(self, includeItems:bool=False) -> str:
         """
         Returns a displayable string representation of the class.

spotifywebapipython/models/playlistsimplified.py

@@ -85,7 +85,7 @@ class PlaylistSimplified:
     def __eq__(self, other):
         try:
             return self.Name == other.Name
-        except Exception as ex:
+        except Exception:
             if (isinstance(self, PlaylistSimplified )) and (isinstance(other, PlaylistSimplified )):
                 return self.Name == other.Name
             return False
@@ -93,7 +93,7 @@ class PlaylistSimplified:
     def __lt__(self, other):
         try:
             return self.Name < other.Name
-        except Exception as ex:
+        except Exception:
             if (isinstance(self, PlaylistSimplified )) and (isinstance(other, PlaylistSimplified )):
                 return self.Name < other.Name
             return False
@@ -155,6 +155,17 @@ class PlaylistSimplified:
         return self._Images
 
 
+    @property
+    def ImageUrl(self) -> str:
+        """
+        Gets the first image url in the `Images` list, if images are defined;
+        otherwise, null.
+        """
+        if len(self._Images) > 0:
+            return self._Images[0].Url
+        return None
+            
+        
     @property
     def Name(self) -> str:
         """ 

spotifywebapipython/models/playlisttrack.py

@@ -72,6 +72,18 @@ class PlaylistTrack:
         return self._AddedBy
 
 
+    @property
+    def ImageUrl(self) -> str:
+        """
+        Gets the first image url in the underlying track album `Images` list, if images are defined;
+        otherwise, null.
+        """
+        if self._Track is not None:
+            if self._Track.Album is not None:
+                return self._Track.Album.ImageUrl
+        return None
+            
+        
     @property
     def IsLocal(self) -> bool:
         """ 

spotifywebapipython/models/showpagesaved.py

@@ -2,6 +2,7 @@
 
 # our package imports.
 from ..sautils import export
+from .show import Show
 from .showsaved import ShowSaved
 from .pageobject import PageObject
 
@@ -56,6 +57,20 @@ class ShowPageSaved(PageObject):
         return self._Items
     
 
+    def GetShows(self) -> list[Show]:
+        """ 
+        Gets a list of all shows contained in the underlying `Items` list.
+        
+        This is a convenience method so one does not have to loop through the `Items`
+        array of ShowSaved objects to get the list of shows.
+        """
+        result:list[Show] = []
+        item:ShowSaved
+        for item in self._Items:
+            result.append(item.Show)
+        return result
+    
+
     def ToString(self, includeItems:bool=False) -> str:
         """
         Returns a displayable string representation of the class.

spotifywebapipython/models/showsimplified.py

@@ -86,7 +86,7 @@ class ShowSimplified:
     def __eq__(self, other):
         try:
             return self.Name == other.Name
-        except Exception as ex:
+        except Exception:
             if (isinstance(self, ShowSimplified )) and (isinstance(other, ShowSimplified )):
                 return self.Name == other.Name
             return False
@@ -94,7 +94,7 @@ class ShowSimplified:
     def __lt__(self, other):
         try:
             return self.Name < other.Name
-        except Exception as ex:
+        except Exception:
             if (isinstance(self, ShowSimplified )) and (isinstance(other, ShowSimplified )):
                 return self.Name < other.Name
             return False
@@ -174,6 +174,17 @@ class ShowSimplified:
         return self._Images
 
 
+    @property
+    def ImageUrl(self) -> str:
+        """
+        Gets the first image url in the `Images` list, if images are defined;
+        otherwise, null.
+        """
+        if len(self._Images) > 0:
+            return self._Images[0].Url
+        return None
+            
+        
     @property
     def IsExternallyHosted(self) -> bool:
         """ 

spotifywebapipython/models/track.py

@@ -72,6 +72,17 @@ class Track(TrackSimplified):
         return self._ExternalIds
     
 
+    @property
+    def ImageUrl(self) -> str:
+        """
+        Gets the first image url in the album `Images` list, if images are defined;
+        otherwise, null.
+        """
+        if self._Album is not None:
+            return self._Album.ImageUrl
+        return None
+            
+        
     @property
     def Popularity(self) -> int:
         """ 

spotifywebapipython/models/trackpagesaved.py

@@ -2,6 +2,7 @@
 
 # our package imports.
 from ..sautils import export
+from .track import Track
 from .tracksaved import TrackSaved
 from .pageobject import PageObject
 
@@ -56,6 +57,20 @@ class TrackPageSaved(PageObject):
         return self._Items
     
 
+    def GetTracks(self) -> list[Track]:
+        """ 
+        Gets a list of all tracks contained in the underlying `Items` list.
+        
+        This is a convenience method so one does not have to loop through the `Items`
+        array of TrackSaved objects to get the list of tracks.
+        """
+        result:list[Track] = []
+        item:TrackSaved
+        for item in self._Items:
+            result.append(item.Track)
+        return result
+    
+
     def ToString(self, includeItems:bool=False) -> str:
         """
         Returns a displayable string representation of the class.

spotifywebapipython/models/trackrecommendations.py

@@ -3,7 +3,7 @@
 # our package imports.
 from ..sautils import export
 from .recommendationseed import RecommendationSeed
-from .tracksimplified import TrackSimplified
+from .track import Track
 
 @export
 class TrackRecommendations:
@@ -21,7 +21,7 @@ class TrackRecommendations:
                 attributes; otherwise, None to not load attributes.
         """
         self._Seeds:list[RecommendationSeed] = []
-        self._Tracks:list[TrackSimplified] = []
+        self._Tracks:list[Track] = []
         
         if (root is None):
 
@@ -36,7 +36,7 @@ class TrackRecommendations:
         
             items:list = root.get('tracks',[])
             for item in items:
-                self._Tracks.append(TrackSimplified(root=item))
+                self._Tracks.append(Track(root=item))
 
         
     def __repr__(self) -> str:
@@ -56,9 +56,9 @@ class TrackRecommendations:
 
 
     @property
-    def Tracks(self) -> list[TrackSimplified]:
+    def Tracks(self) -> list[Track]:
         """ 
-        A list of TrackSimplified objects, ordered according to the parameters supplied.
+        A list of Track objects, ordered according to the parameters supplied.
         on the `GetTrackRecommendations` method.
         """
         return self._Tracks

spotifywebapipython/models/tracksaved.py

@@ -2,7 +2,7 @@
 
 # our package imports.
 from ..sautils import export
-from .tracksimplified import TrackSimplified
+from .track import Track
 
 @export
 class TrackSaved:
@@ -19,8 +19,8 @@ class TrackSaved:
                 Spotify Web API JSON response in dictionary format, used to load object
                 attributes; otherwise, None to not load attributes.
         """
-        self._Track:TrackSimplified = None
         self._AddedAt:str = None
+        self._Track:Track = None
         
         if (root is None):
 
@@ -33,7 +33,7 @@ class TrackSaved:
             # process all collections and objects.
             item:dict = root.get('track',None)
             if item is not None:
-                self._Track = TrackSimplified(root=item)
+                self._Track = Track(root=item)
 
         
     def __repr__(self) -> str:
@@ -58,7 +58,7 @@ class TrackSaved:
 
 
     @property
-    def Track(self) -> TrackSimplified:
+    def Track(self) -> Track:
         """ 
         Information about the track.
         """

spotifywebapipython/models/tracksimplified.py

@@ -89,7 +89,7 @@ class TrackSimplified:
     def __eq__(self, other):
         try:
             return self.Name == other.Name
-        except Exception as ex:
+        except Exception:
             if (isinstance(self, TrackSimplified )) and (isinstance(other, TrackSimplified )):
                 return self.Name == other.Name
             return False
@@ -97,7 +97,7 @@ class TrackSimplified:
     def __lt__(self, other):
         try:
             return self.Name < other.Name
-        except Exception as ex:
+        except Exception:
             if (isinstance(self, TrackSimplified )) and (isinstance(other, TrackSimplified )):
                 return self.Name < other.Name
             return False
@@ -167,6 +167,16 @@ class TrackSimplified:
         return self._Id
 
 
+    @property
+    def ImageUrl(self) -> str:
+        """
+        Always returns null, as tracks currently do not support images.
+
+        Added for compatibility with other objects.
+        """
+        return None
+            
+        
     @property
     def IsLocal(self) -> bool:
         """ 

spotifywebapipython/models/userprofilesimplified.py

@@ -129,6 +129,17 @@ class UserProfileSimplified:
         return self._Images
 
 
+    @property
+    def ImageUrl(self) -> str:
+        """
+        Gets the first image url in the `Images` list, if images are defined;
+        otherwise, null.
+        """
+        if len(self._Images) > 0:
+            return self._Images[0].Url
+        return None
+            
+        
     @property
     def Type(self) -> str:
         """ 

spotifywebapipython/spotifyauthtoken.py

@@ -132,6 +132,25 @@ class SpotifyAuthToken:
         return self._ExpiresAt
     
 
+    @property
+    def HeaderKey(self) -> str:
+        """
+        Returns a string containing the header key to assign the authorization token value to.
+        This will always return 'Authorization'.
+        """
+        return 'Authorization'
+
+
+    @property
+    def HeaderValue(self) -> str:
+        """
+        Returns the value portion of the authorization header, in the form of '{tokentype} {token}'.
+
+        Example: `Bearer {token value ...}'
+        """
+        return '{tokentype} {token}'.format(tokentype=self.TokenType, token=self.AccessToken)
+
+
     @property
     def IsExpired(self) -> bool:
         """ 
@@ -202,17 +221,6 @@ class SpotifyAuthToken:
         return self._TokenType
     
 
-    def GetHeaders(self) -> dict:
-        """
-        Returns a dictionary containing an 'Authorization': 'Bearer {token}' value,
-        which can be used when makeing requests to the Spotify Web API.
-        """
-        headers:dict = {
-            'Authorization': '{tokentype} {token}'.format(tokentype=self.TokenType, token=self.AccessToken)
-        }
-        return headers
-
-
     def ToString(self) -> str:
         """
         Returns a displayable string representation of the class.