spotifywebapiPython 1.0.286__py3-none-any.whl → 1.0.287__py3-none-any.whl

spotifywebapipython/spotifyclient.py

@@ -5352,6 +5352,7 @@ class SpotifyClient:
         artistId:str=None, 
         market:str=None, 
         sortResult:bool=True,
+        filterCriteria:str|None=None,
         ) -> list[Track]:
         """
         <span class="deprecated">
@@ -12762,6 +12763,7 @@ class SpotifyClient:
         offset:int=0,
         limitTotal:int=None,
         sortResult:bool=True,
+        filterCriteria:str|None=None,
         ) -> ArtistPage:
         """
         Get the current user's top artists based on calculated affinity.
@@ -12793,6 +12795,9 @@ class SpotifyClient:
                 True to sort the items by name; otherwise, False to leave the items in the same order they 
                 were returned in by the Spotify Web API.  
                 Default: True
+            filterCriteria (str):
+                Filter returned entries by a artist name or uri value.  
+                Value can be a full name (e.g. "My Artist Name"), or a partial name (e.g. "My").
                 
         Returns:
             An `ArtistPage` object of matching results.
@@ -12830,6 +12835,7 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("offset", offset)
             apiMethodParms.AppendKeyValue("limitTotal", limitTotal)
             apiMethodParms.AppendKeyValue("sortResult", sortResult)
+            apiMethodParms.AppendKeyValue("filterCriteria", filterCriteria)
             _logsi.LogMethodParmList(SILevel.Verbose, "Get the current user's top artists", apiMethodParms)
                 
             # validations.
@@ -12906,6 +12912,23 @@ class SpotifyClient:
                 if (sortResult is True):
                     result.Items.sort(key=lambda x: (x.Name or "").lower(), reverse=False)
         
+                # apply filter criteria (if specified).
+                if (filterCriteria is not None):
+                    _logsi.LogVerbose("Applying filter criteria to results list: \"%s\"" % (filterCriteria))
+                    filterCriteriaCompare:str = (filterCriteria or "").lower()
+                    isFilterUri:bool = SpotifyClient.IsSpotifyUri(filterCriteriaCompare)
+                    # process list in reverse order since we are removing items.
+                    for idx in reversed(range(len(result.Items))):
+                        item:Artist = result.Items[idx]
+                        itemFound:bool = False
+                        if (isFilterUri):
+                            if ((item.Uri or "").lower() == filterCriteriaCompare):
+                                itemFound = True
+                        elif ((item.Name or "").lower().find(filterCriteriaCompare) > -1):
+                            itemFound = True
+                        if (not itemFound):
+                            result.Items.pop(idx)
+            
             # trace.
             _logsi.LogObject(SILevel.Verbose, (TRACE_METHOD_RESULT_TYPE + result.PagingInfo) % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
             return result
@@ -12931,6 +12954,9 @@ class SpotifyClient:
         offset:int=0,
         limitTotal:int=None,
         sortResult:bool=True,
+        filterArtist:str|None=None,
+        filterAlbum:str|None=None,
+        filterCriteria:str|None=None,
         ) -> TrackPage:
         """
         Get the current user's top tracks based on calculated affinity.
@@ -12962,6 +12988,15 @@ class SpotifyClient:
                 True to sort the items by name; otherwise, False to leave the items in the same order they 
                 were returned in by the Spotify Web API.  
                 Default: True
+            filterArtist (str):
+                Filter returned entries by an artist name or uri value.  
+                Value can be the full name of the artist (e.g. "Jeremy Camp"), or a partial name (e.g. "Camp").
+            filterAlbum (str):
+                Filter returned entries by an album name or uri value.
+                Value can be the full name of the album (e.g. "Carried Me"), or a partial name (e.g. "Carried").
+            filterCriteria (str):
+                Filter returned entries by a track name or uri value.  
+                Value can be a full name (e.g. "My Track Name"), or a partial name (e.g. "My").
                 
         Returns:
             An `TrackPage` object of matching results.
@@ -12999,6 +13034,9 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("offset", offset)
             apiMethodParms.AppendKeyValue("limitTotal", limitTotal)
             apiMethodParms.AppendKeyValue("sortResult", sortResult)
+            apiMethodParms.AppendKeyValue("filterArtist", filterArtist)
+            apiMethodParms.AppendKeyValue("filterAlbum", filterAlbum)
+            apiMethodParms.AppendKeyValue("filterCriteria", filterCriteria)
             _logsi.LogMethodParmList(SILevel.Verbose, "Get the current user's top tracks", apiMethodParms)
                 
             # validations.
@@ -13075,6 +13113,63 @@ class SpotifyClient:
                 if (sortResult is True):
                     result.Items.sort(key=lambda x: (x.Name or "").lower(), reverse=False)
         
+                # apply artist filter criteria.
+                if (filterArtist is not None):
+                    _logsi.LogVerbose("Applying filter criteria to results list: %s=\"%s\"" % ("artist", filterArtist))
+                    filterArtistCompare:str = (filterArtist or "").lower()
+                    isFilterUri:bool = SpotifyClient.IsSpotifyUri(filterArtistCompare)
+                    # process list in reverse order since we are removing items.
+                    for idx in reversed(range(len(result.Items))):
+                        track:Track = result.Items[idx]
+                        artistFound:bool = False
+                        artist:ArtistSimplified = None
+                        for artist in track.Artists:
+                            if (isFilterUri):
+                                if ((artist.Uri or "").lower() == filterArtistCompare):
+                                    artistFound = True
+                                    break
+                            elif ((artist.Name or "").lower().find(filterArtistCompare) > -1):
+                                artistFound = True
+                                break
+                        if (not artistFound):
+                            result.Items.pop(idx)
+
+                # apply album filter criteria.
+                if (filterAlbum is not None):
+                    _logsi.LogVerbose("Applying filter criteria to results list: %s=\"%s\"" % ("album", filterAlbum))
+                    filterAlbumCompare:str = (filterAlbum or "").lower()
+                    isFilterUri:bool = SpotifyClient.IsSpotifyUri(filterAlbumCompare)
+                    # process list in reverse order since we are removing items.
+                    for idx in reversed(range(len(result.Items))):
+                        track:Track = result.Items[idx]
+                        albumFound:bool = False
+                        album:Album = track.Album
+                        if (album is not None):
+                            if (isFilterUri):
+                                if ((album.Uri or "").lower() == filterAlbumCompare):
+                                    albumFound = True
+                            elif ((album.Name or "").lower().find(filterAlbumCompare) > -1):
+                                albumFound = True
+                        if (not albumFound):
+                            result.Items.pop(idx)
+
+                # apply filter criteria (if specified).
+                if (filterCriteria is not None):
+                    _logsi.LogVerbose("Applying filter criteria to results list: \"%s\"" % (filterCriteria))
+                    filterCriteriaCompare:str = (filterCriteria or "").lower()
+                    isFilterUri:bool = SpotifyClient.IsSpotifyUri(filterCriteriaCompare)
+                    # process list in reverse order since we are removing items.
+                    for idx in reversed(range(len(result.Items))):
+                        item:Track = result.Items[idx]
+                        itemFound:bool = False
+                        if (isFilterUri):
+                            if ((item.Uri or "").lower() == filterCriteriaCompare):
+                                itemFound = True
+                        elif ((item.Name or "").lower().find(filterCriteriaCompare) > -1):
+                            itemFound = True
+                        if (not itemFound):
+                            result.Items.pop(idx)
+            
             # trace.
             _logsi.LogObject(SILevel.Verbose, (TRACE_METHOD_RESULT_TYPE + result.PagingInfo) % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
             return result

{spotifywebapipython-1.0.286.dist-info → spotifywebapipython-1.0.287.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spotifywebapipython
-Version: 1.0.286
+Version: 1.0.287
 Summary: Spotify Web API Python3 Library
 Author: Todd Lucas
 Author-email: <thlucas@yahoo.com>

{spotifywebapipython-1.0.286.dist-info → spotifywebapipython-1.0.287.dist-info}/RECORD

@@ -1,36 +1,36 @@
 spotifywebapipython/__init__.py,sha256=ka7F2AsT-UU7KSYKBnfgl5Trojcep5aQspLutg8D-2k,1306
-spotifywebapipython/const.py,sha256=_0xgoiXleuGlt4VBrjCybEnX6RiQLiUdgRlt7key8Yc,4100
+spotifywebapipython/const.py,sha256=CdZ1K_vhJQO7hcHbV3qD65_B1rHl2u0e4LexmRTqS8g,4100
 spotifywebapipython/saappmessages.py,sha256=mVprjpd5CdD8kYeAkLzRvMvIQPmaYtH4UCP5my3QhSk,5065
 spotifywebapipython/sautils.py,sha256=LZF3UvxaBK35WIg1hO37nbW8j1y-M-oOxRbi1dPR39w,8746
 spotifywebapipython/spotifyapierror.py,sha256=23_CYlxWN0BceYYCLpBpunl55vEwPr_wFf34l74xzeA,1855
 spotifywebapipython/spotifyapimessage.py,sha256=wCnW8jYMLS3x9kjyXPgXXZqaf1HeMTTXzU8u_Dm5pfA,8447
 spotifywebapipython/spotifyauthtoken.py,sha256=iVg2Pa5mfMqYe4qgc5H8td6JzJlaDqk4vMEhH5LmtfI,9289
-spotifywebapipython/spotifyclient.py,sha256=5VbuI5ADUBlCV4m6uO5VGcLgY6FRB4daQkJwWGJ5KJg,915988
+spotifywebapipython/spotifyclient.py,sha256=PN115xXN6Vrhhp0z6Js9XaSR77GhF1rYFFc_6OqSpfc,921897
 spotifywebapipython/spotifydiscovery.py,sha256=cyysxl8PQj9yGHVbaqhSF3SStlrp-NvfGAudM-dDmg0,20290
 spotifywebapipython/spotifymediatypes.py,sha256=hMjkxhbfTtks0_P8BKmY7qg3EmB2zhH3RT0DbEpb_2s,1628
 spotifywebapipython/spotifytypeprefixes.py,sha256=3yfpxKF7jF694qBuo-PbKYvm70YwwdBoGj9enOpWsAg,1375
 spotifywebapipython/spotifywebapiauthenticationerror.py,sha256=5A0MKvYo3Ypv0ZeSSfLHuFLwzoUUu044bBoUgMfNXNw,3940
 spotifywebapipython/spotifywebapierror.py,sha256=5cga9213J_nFQ0UX4vSn3dpyinASKTRiH0wAR4nLjvs,3147
 spotifywebapipython/spotifywebplayertoken.py,sha256=axj1j1lM7COiiZfpElkJRdnk4AmE6bAQcjKshUIz1Nk,35813
-spotifywebapipython/docs/__init__.html,sha256=05xQ4dY9jR9Hd3ffGnfUtDa8J4SlqH5jHHQ6XVnVbXQ,196385
+spotifywebapipython/docs/__init__.html,sha256=hygCBJ02lgn1fZup0_0Fppz0oyThPj5ekEFxPzA8oCw,196692
 spotifywebapipython/docs/codecopy.js,sha256=ryuoZwLIL03YitjjFzn49UO5ta7-OBos6LNA3qHhFzs,3120
-spotifywebapipython/docs/index.html,sha256=LB0Z1wlnoi5kACHNMl2zsZnn5nM9FuxtH7k2csTrx30,48779
-spotifywebapipython/docs/search.js,sha256=wPB2r1T1zbLkTQReh2QjjlqN_CWajgwMqq_HNwoKhj0,9232395
+spotifywebapipython/docs/index.html,sha256=IczeGP9BMSpR7toRwEqPcHrfFEFhAcKidEgOs-21KS0,48779
+spotifywebapipython/docs/search.js,sha256=Ia1weVz8Ea-4hGloxovMuoaY5cHQaWMciP0Z5KwSnLI,9238084
 spotifywebapipython/docs/spotifywebapipython.ico,sha256=YImj39fqqSPSuB2-sMDlUYDd6YwRfQeJRtq4FjwWglg,16410
 spotifywebapipython/docs/spotifywebapipython_OLD.ico,sha256=YIv5LjcD4bTIJQSOr8jjwbWaeB3QkElRwkTOePiGbZo,14904
-spotifywebapipython/docs/spotifywebapipython/const.html,sha256=19wPmdPgNZ_9UFd7cPmy0A7PiJ8qPc7BDbgXyFqI0Do,60537
-spotifywebapipython/docs/spotifywebapipython/saappmessages.html,sha256=gRSdL-TvfU0FY-pLXm2YLhVf4XMqUufYfECpnCyaGKw,62358
-spotifywebapipython/docs/spotifywebapipython/sautils.html,sha256=F3KoUVeyU24ywTOvgz5IIUyRYL9X46UyPLDAH1IQh-E,62031
-spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html,sha256=HOled1eapOTPE9pSHa9NC-ygiKUicAxpd2yYwf9C4vQ,48054
-spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html,sha256=K0oxXrcoEUnDQzVipamnTzoOTWy3tqdA5wJ4igh5Ibo,59210
-spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html,sha256=95vFun1G3Rp5BX4W9fT5zyCPkLywGv9n3I8Co2jPfeg,59256
-spotifywebapipython/docs/spotifywebapipython/spotifyclient.html,sha256=BH1RhPQuWh6HmffyXa_Mvf5LTDTLqUzamtV18yz2Xic,1672082
-spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html,sha256=P8ZckakEwCSdUt-WMhdqG4MFLzGrqsBGmixDkOqerIs,57662
-spotifywebapipython/docs/spotifywebapipython/spotifymediatypes.html,sha256=0vM7c8s9PfTpf3YbalHLgW_Zx1yHlHIgRwwImXjrPpU,51532
-spotifywebapipython/docs/spotifywebapipython/spotifytypeprefixes.html,sha256=OPF2tP14JABVoNsd5D9jQscXaBbYlsxsNvwg27FeVe4,52401
-spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html,sha256=Y7PozL92r76oSk8z9a9LTH3ysoBJkYdQAt2yru2skdI,52174
-spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html,sha256=2ujyN56DGOz_NUH-Ne-yNLaNQrSA60vipo0CKLeKr5g,50592
-spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html,sha256=tR9167PzMyagthjiFu42PGYluTyD85gT1wUuou0Xx84,62204
+spotifywebapipython/docs/spotifywebapipython/const.html,sha256=AuvnxmWC9FxZcLwcC61Xcl8U0asOoynsLJFkBzBF0wM,60537
+spotifywebapipython/docs/spotifywebapipython/saappmessages.html,sha256=197Q-wMaWx4BNabmQmEn6XFvTKVKRU_FEtb5nO60oqw,62358
+spotifywebapipython/docs/spotifywebapipython/sautils.html,sha256=opJnQ9DDuDTUv5FRitsSbIs8Egnm3u_j7lm13sVOoWI,62031
+spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html,sha256=bIK6re_mHtJRPWBqvhL0pSpDwFMqejlGVDk0gF5M4B0,48054
+spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html,sha256=CniLDlRMCXbC6jgynuT2crWNIWEwjoe5_onQlq7LB2c,59210
+spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html,sha256=uOhaWwxFuCQbUDKd1LdD3197uL9dHy-ZgHi0gLmMCE4,59256
+spotifywebapipython/docs/spotifywebapipython/spotifyclient.html,sha256=gWzOoHXXkhr6a_ig_qoyyKHjS_ZBC5KPqk7nKHLIJUM,1673993
+spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html,sha256=sBx3BHDhD18Gsn7bVRR5GMmK2SncD-LFSKJItmv6DTI,57662
+spotifywebapipython/docs/spotifywebapipython/spotifymediatypes.html,sha256=YJXH-gMS2wUxP6w7lmUObRESA4LKBz0vBiVdZ8J6BCQ,51532
+spotifywebapipython/docs/spotifywebapipython/spotifytypeprefixes.html,sha256=ugqRX9bS-6l45t_SJOgK-E4U3Er_deaeSbfzKgcyiPo,52401
+spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html,sha256=RQm3-Jzh2L1EnFHt64w0-ksDJDksWanRV044ZZoOdwY,52174
+spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html,sha256=B2b2Wxrmip9GBdMm9rXjgCq0ECtikZOcJzL_0G0_n6g,50592
+spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html,sha256=R97l8hgCvOGHoZT8hpu3Ug8bdM_ZfM0QCd4pgrGGzxI,62204
 spotifywebapipython/models/__init__.py,sha256=RwRQhUX-6EUs8XvStVFpR8EPwoqIAz9K6ref-28qHKI,4423
 spotifywebapipython/models/album.py,sha256=U3Pdw0-EL33LdkeiN31fjZ23rlLk6DNGV8jRmZU7EyQ,5170
 spotifywebapipython/models/albumpagesaved.py,sha256=SBYMhkh5ZsMrRAXl-cm9zsxMDh8gO190ENq6Py2TyGY,2417
@@ -137,8 +137,8 @@ spotifywebapipython/zeroconfapi/zeroconfgetinfo.py,sha256=APayso_F7lCsdzzrkescgd
 spotifywebapipython/zeroconfapi/zeroconfgetinfoalias.py,sha256=FZJM23HIPJSfhXIC3-EuS1XhawheoG5maSp7__k4yBo,2932
 spotifywebapipython/zeroconfapi/zeroconfgetinfodrmmediaformat.py,sha256=c5uk8ljsIuBK3w2jahHKQuoWvm245LOjUBitetXx5Mo,2347
 spotifywebapipython/zeroconfapi/zeroconfresponse.py,sha256=mAPIDj5MG53x8peiScrp7OJblwy_o_Sto4wqE0rGujU,6445
-spotifywebapipython-1.0.286.dist-info/LICENSE,sha256=KGcc9g0zwqNLcWnSn_ezv1UtKyhMENFhvtixpxUPNsE,1177
-spotifywebapipython-1.0.286.dist-info/METADATA,sha256=K9CTanPOwnt4MG0EPwXe1eY2kbyIXPl45BlH2y1kTSo,11644
-spotifywebapipython-1.0.286.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-spotifywebapipython-1.0.286.dist-info/top_level.txt,sha256=jTBLFlijKTesYh2dteAz4vb17qjaqWKeDjpnnwTcrjs,20
-spotifywebapipython-1.0.286.dist-info/RECORD,,
+spotifywebapipython-1.0.287.dist-info/LICENSE,sha256=KGcc9g0zwqNLcWnSn_ezv1UtKyhMENFhvtixpxUPNsE,1177
+spotifywebapipython-1.0.287.dist-info/METADATA,sha256=REYw9OelXmSwcVqOURpfVis8DtFmuIWh2ubVM5YhGx8,11644
+spotifywebapipython-1.0.287.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+spotifywebapipython-1.0.287.dist-info/top_level.txt,sha256=jTBLFlijKTesYh2dteAz4vb17qjaqWKeDjpnnwTcrjs,20
+spotifywebapipython-1.0.287.dist-info/RECORD,,