spotifywebapiPython 1.0.30__py3-none-any.whl → 1.0.32__py3-none-any.whl

spotifywebapipython/spotifyclient.py

@@ -2349,7 +2349,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = AlbumPageSaved()
@@ -2504,7 +2503,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = AlbumPageSimplified()
@@ -2648,9 +2646,10 @@ class SpotifyClient:
             self.MakeRequest('GET', msg)
 
             # process results.
-            items = msg.ResponseData.get('albums',[])
-            for item in items:
-                result.append(Album(root=item))
+            items = msg.ResponseData.get('albums',None)
+            if items is not None:
+                for item in items:
+                    result.append(Album(root=item))
         
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, 'list[Album]'), result)
@@ -2755,7 +2754,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = TrackPageSimplified()
@@ -2985,7 +2983,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 5  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = AlbumPageSimplified()
@@ -3109,9 +3106,10 @@ class SpotifyClient:
             self.MakeRequest('GET', msg)
 
             # process results.
-            items = msg.ResponseData.get('artists',[])
-            for item in items:
-                result.append(Artist(root=item))
+            items = msg.ResponseData.get('artists',None)
+            if items is not None:
+                for item in items:
+                    result.append(Artist(root=item))
         
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, 'list[Artist]'), result)
@@ -3183,9 +3181,10 @@ class SpotifyClient:
             self.MakeRequest('GET', msg)
 
             # process results.
-            items = msg.ResponseData.get('artists',[])
-            for item in items:
-                result.append(Artist(root=item))
+            items = msg.ResponseData.get('artists',None)
+            if items is not None:
+                for item in items:
+                    result.append(Artist(root=item))
         
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, 'list[Artist]'), result)
@@ -3272,7 +3271,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 1  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = ArtistPage()
@@ -3419,9 +3417,10 @@ class SpotifyClient:
             self.MakeRequest('GET', msg)
 
             # process results.
-            items = msg.ResponseData.get('tracks',[])
-            for item in items:
-                result.append(Track(root=item))
+            items = msg.ResponseData.get('tracks',None)
+            if items is not None:
+                for item in items:
+                    result.append(Track(root=item))
         
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, 'list[Track]'), result)
@@ -3616,7 +3615,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = ChapterPageSimplified()
@@ -3763,7 +3761,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = AudiobookPageSimplified()
@@ -3908,9 +3905,10 @@ class SpotifyClient:
             self.MakeRequest('GET', msg)
 
             # process results.
-            items = msg.ResponseData.get('audiobooks',[])
-            for item in items:
-                result.append(AudiobookSimplified(root=item))
+            items = msg.ResponseData.get('audiobooks',None)
+            if items is not None:
+                for item in items:
+                    result.append(AudiobookSimplified(root=item))
         
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, 'list[AudiobookSimplified]'), result)
@@ -4136,7 +4134,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = CategoryPage()
@@ -4357,6 +4354,9 @@ class SpotifyClient:
                 and the response contains error information.
             SpotifApiError: 
                 If the method fails for any other reason.
+                
+        The following are special undocumented category ID's that I have found:  
+        - 0JQ5DAt0tbjZptfcdMSKl3: Made For You  
 
         <details>
           <summary>Sample Code - Manual Paging</summary>
@@ -4370,6 +4370,12 @@ class SpotifyClient:
         .. include:: ../docs/include/samplecode/SpotifyClient/GetCategoryPlaylists_AutoPaging.py
         ```
         </details>
+        <details>
+          <summary>Sample Code - Made For You Playlists</summary>
+        ```python
+        .. include:: ../docs/include/samplecode/SpotifyClient/GetCategoryPlaylists_MadeForYou.py
+        ```
+        </details>
         """
         apiMethodName:str = 'GetCategoryPlaylists'
         apiMethodParms:SIMethodParmListContext = None
@@ -4398,7 +4404,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = PlaylistPageSimplified()
@@ -4641,9 +4646,10 @@ class SpotifyClient:
             self.MakeRequest('GET', msg)
 
             # process results.
-            items = msg.ResponseData.get('chapters',[])
-            for item in items:
-                result.append(Chapter(root=item))
+            items = msg.ResponseData.get('chapters',None)
+            if items is not None:
+                for item in items:
+                    result.append(Chapter(root=item))
         
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, 'list[Chapter]'), result)
@@ -4824,7 +4830,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 1  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = EpisodePageSaved()
@@ -4969,9 +4974,10 @@ class SpotifyClient:
             self.MakeRequest('GET', msg)
 
             # process results.
-            items = msg.ResponseData.get('episodes',[])
-            for item in items:
-                result.append(Episode(root=item))
+            items = msg.ResponseData.get('episodes',None)
+            if items is not None:
+                for item in items:
+                    result.append(Episode(root=item))
         
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, 'list[Episode]'), result)
@@ -5092,7 +5098,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = PlaylistPageSimplified()
@@ -5520,9 +5525,10 @@ class SpotifyClient:
                 self.MakeRequest('GET', msg)
 
                 # process results.
-                items = msg.ResponseData.get('devices',[])
-                for item in items:
-                    result.append(Device(root=item))
+                items = msg.ResponseData.get('devices',None)
+                if items is not None:
+                    for item in items:
+                        result.append(Device(root=item))
 
                 # sort items on Name property, ascending order.
                 if len(result) > 0:
@@ -5892,7 +5898,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 40  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = PlayHistoryPage()
@@ -6260,7 +6265,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = PlaylistPage()
@@ -6411,7 +6415,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = PlaylistPageSimplified()
@@ -6560,7 +6563,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = PlaylistPageSimplified()
@@ -6736,7 +6738,7 @@ class SpotifyClient:
         Args:
             showId (str):  
                 The Spotify ID for the show.
-                Example: `38bS44xjbVVZ3No3ByF1dJ`
+                Example: `6kAsbP8pxwaU2kPibKTuHE`
             limit (int):  
                 The maximum number of items to return in a page of items.  
                 Default: 20, Range: 1 to 50.  
@@ -6807,7 +6809,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = EpisodePageSimplified()
@@ -6954,7 +6955,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = ShowPageSaved()
@@ -7099,9 +7099,10 @@ class SpotifyClient:
             self.MakeRequest('GET', msg)
 
             # process results.
-            items = msg.ResponseData.get('shows',[])
-            for item in items:
-                result.append(ShowSimplified(root=item))
+            items = msg.ResponseData.get('shows',None)
+            if items is not None:
+                for item in items:
+                    result.append(ShowSimplified(root=item))
         
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, 'list[ShowSimplified]'), result)
@@ -7330,7 +7331,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 2  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = TrackPageSaved()
@@ -7475,9 +7475,10 @@ class SpotifyClient:
             self.MakeRequest('GET', msg)
 
             # process results.
-            items = msg.ResponseData.get('tracks',[])
-            for item in items:
-                result.append(Track(root=item))
+            items = msg.ResponseData.get('tracks',None)
+            if items is not None:
+                for item in items:
+                    result.append(Track(root=item))
         
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, 'list[Track]'), result)
@@ -7549,9 +7550,10 @@ class SpotifyClient:
             self.MakeRequest('GET', msg)
 
             # process results.
-            items = msg.ResponseData.get('audio_features',[])
-            for item in items:
-                result.append(AudioFeatures(root=item))
+            items = msg.ResponseData.get('audio_features',None)
+            if items is not None:
+                for item in items:
+                    result.append(AudioFeatures(root=item))
         
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, 'list[AudioFeatures]'), result)
@@ -8242,7 +8244,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 20  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = ArtistPage()
@@ -8397,7 +8398,6 @@ class SpotifyClient:
             # are we auto-paging?  if so, then use max limit.
             if limitTotal > 0: 
                 limit = 50
-                #limit = 10  # TEST TODO
                 if limit > limitTotal:
                     limit = limitTotal
                 result = TrackPage()
@@ -11499,7 +11499,6 @@ class SpotifyClient:
                         market:str=None,
                         includeExternal:str=None,
                         limitTotal:int=None,
-                        spotifyOwnedOnly:bool=False
                         ) -> SearchResponse:
         """
         Get Spotify catalog information about Playlists that match a keyword string. 
@@ -11544,10 +11543,6 @@ class SpotifyClient:
                 and paging is automatically used to retrieve all available items up to the
                 maximum number specified.  
                 Default: None (disabled)
-            spotifyOwnedOnly (bool):
-                True to return only found items that are owned by spotify (e.g. content generated for you by the spotify AI engine); 
-                otherwise, False to return all found items.   
-                Default is False.
                 
         Returns:
             A `SearchResponse` object that contains the search results.
@@ -11574,12 +11569,6 @@ class SpotifyClient:
         .. include:: ../docs/include/samplecode/SpotifyClient/SearchPlaylists_AutoPaging.py
         ```
         </details>
-        <details>
-          <summary>Sample Code - Spotify Generated, Daily Mix</summary>
-        ```python
-        .. include:: ../docs/include/samplecode/SpotifyClient/SearchPlaylists_Spotify_DailyMix.py
-        ```
-        </details>
         """
         apiMethodName:str = 'SearchPlaylists'
         apiMethodParms:SIMethodParmListContext = None
@@ -11597,7 +11586,6 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("market", market)
             apiMethodParms.AppendKeyValue("includeExternal", includeExternal)
             apiMethodParms.AppendKeyValue("limitTotal", limitTotal)
-            apiMethodParms.AppendKeyValue("spotifyOwnedOnly", spotifyOwnedOnly)
             _logsi.LogMethodParmList(SILevel.Verbose, "Searching Spotify catalog for %s information" % criteriaType, apiMethodParms)
                 
             # validations.
@@ -11671,12 +11659,6 @@ class SpotifyClient:
             # update result object with final paging details.
             result.Total = pageObj.Total
 
-            # was request for spotify owned items only?
-            if spotifyOwnedOnly:
-                _logsi.LogObject(SILevel.Verbose, (TRACE_METHOD_RESULT_TYPE + result.PagingInfo) % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
-                _logsi.LogVerbose("Filtering results for Spotify owned content")
-                result._Items = result.GetSpotifyOwnedItems()
-
             # do not sort, as spotify uses intelligent AI to return results in its order.
 
             # trace.