spotifywebapiPython 1.0.254__py3-none-any.whl → 1.0.256__py3-none-any.whl

spotifywebapipython/spotifyclient.py

@@ -7252,12 +7252,13 @@ class SpotifyClient:
         uri:str, 
         ) -> str:
         """
-        Get the id portion from a Spotify uri value.
+        Get the id portion from a Spotify uri (or url) value.
         
         Args:
             uri (str):  
-                The Spotify URI value.
-                Example: `spotify:track:5v5ETK9WFXAnGQ3MRubKuE`
+                The Spotify URI (or url) value.  
+                Example: `spotify:track:5v5ETK9WFXAnGQ3MRubKuE`  
+                Example: `https://open.spotify.com/track/5v5ETK9WFXAnGQ3MRubKuE`  
                 
         Returns:
             A string containing the id value.
@@ -7272,13 +7273,19 @@ class SpotifyClient:
             if uri is None or len(uri.strip()) == 0:
                 return result
 
-            # get Id from uri value.
+            # is this a uri value (e.g. "spotify:track:5v5ETK9WFXAnGQ3MRubKuE")?
             colonCnt:int = uri.count(':')
             if colonCnt == 2:
                 idx:int = uri.rfind(':')
                 if idx > -1:
                     result = uri[idx+1:]
 
+            # is this a url value (e.g. "https://open.spotify.com/track/5v5ETK9WFXAnGQ3MRubKuE")?
+            elif (uri.startswith("http")):
+                idx = uri.rfind("/")
+                if (idx > 0):
+                    result = uri[idx + 1:len(uri)]
+
             return result
 
         except Exception:
@@ -11698,12 +11705,13 @@ class SpotifyClient:
         uri:str, 
         ) -> str:
         """
-        Get the type portion from a Spotify uri value.
+        Get the type portion from a Spotify uri (or url) value.
         
         Args:
             uri (str):  
-                The Spotify URI value.
-                Example: `spotify:track:5v5ETK9WFXAnGQ3MRubKuE`
+                The Spotify URI (or URL) value.  
+                Example: `spotify:track:5v5ETK9WFXAnGQ3MRubKuE`  
+                Example: `https://open.spotify.com/track/5v5ETK9WFXAnGQ3MRubKuE`  
                 
         Returns:
             A string containing the type value (e.g. `track`).
@@ -11718,7 +11726,7 @@ class SpotifyClient:
             if uri is None or len(uri.strip()) == 0:
                 return result
 
-            # get type from uri value.
+            # is this a uri value (e.g. "spotify:track:5v5ETK9WFXAnGQ3MRubKuE")?
             colonCnt:int = uri.count(':')
             if colonCnt == 2:
                 idxStart:int = uri.find(':')
@@ -11729,6 +11737,14 @@ class SpotifyClient:
                     if idxEnd > -1:
                         result = uri[idxStart+1:idxEnd]
 
+            # is this a url value (e.g. "https://open.spotify.com/track/5v5ETK9WFXAnGQ3MRubKuE")?
+            elif (uri.startswith("http")):
+                idxR = uri.rfind("/")
+                if (idxR > 0):
+                    idxL = uri.rfind("/", 0, idxR - 1)
+                    if (idxR > -1):
+                        result = uri[idxL + 1:idxR]
+
             return result
 
         except Exception as ex:
@@ -12514,6 +12530,7 @@ class SpotifyClient:
         delay:float=0.50,
         resolveDeviceId:bool=True,
         shuffle:bool=None,
+        playShowLatestEpisode:bool=None,
         ) -> None:
         """
         Start playing one or more tracks of the specified context on a Spotify Connect device.
@@ -12565,6 +12582,11 @@ class SpotifyClient:
                 True to enable player shuffle mode; False to disable player shuffle mode; 
                 None to use current player shuffle mode.  
                 Default is None.  
+            playShowLatestEpisode (bool):
+                True to play the most current episode of a podcast show, starting at the beginning; 
+                otherwise, False to resume playing of the podcast episode that was previously played.  
+                Default is False.  
+                This argument is only considered for `show` contexts.
                 
         Raises:
             SpotifyWebApiError: 
@@ -12628,6 +12650,7 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("delay", delay)
             apiMethodParms.AppendKeyValue("resolveDeviceId (DEPRECATED)", resolveDeviceId)
             apiMethodParms.AppendKeyValue("shuffle", shuffle)
+            apiMethodParms.AppendKeyValue("playShowLatestEpisode", playShowLatestEpisode)
             _logsi.LogMethodParmList(SILevel.Verbose, "Spotify Connect device play context", apiMethodParms)
                 
             # validations.
@@ -12636,6 +12659,8 @@ class SpotifyClient:
                 positionMS = 0
             if (offsetPosition is None) or (offsetPosition < 0):
                 offsetPosition = 0
+            if (playShowLatestEpisode is None):
+                playShowLatestEpisode = False
 
             # if shuffle specified, then we will reset the offset argument values
             # since we are playing things in random order anyway.
@@ -12650,6 +12675,41 @@ class SpotifyClient:
             # are spotify web player credentials configured? if so, then we will use them to create
             # an elevated authorization access token for the Spotify Web API endpoint call.
             accessTokenHeaderValue:str = self._GetSpotifyWebPlayerTokenHeaderValue(scDevice)
+
+            # did caller request to play the most current podcast show episode?
+            if (playShowLatestEpisode == True):
+
+                if (self.GetTypeFromUri(contextUri) == SpotifyMediaTypes.SHOW.value):
+
+                    try:
+
+                        # trace.
+                        _logsi.LogVerbose("playShowLatestEpisode=True was specified; retrieving latest show episode")
+
+                        # get episodes for the specified show.
+                        # at this point, it could be either an audiobook or podcast (both are shows).
+                        showId = self.GetIdFromUri(contextUri)
+                        showEpisodes:PageObject = self.GetShowEpisodes(showId, limitTotal=2)
+                        if (showEpisodes.ItemsCount > 0):
+
+                            # get the most current show episode details.
+                            episodeUri = showEpisodes.Items[0].Uri
+                            episodeId = showEpisodes.Items[0].Id
+
+                            # is this an audiobook episode? or a podcast episode?
+                            # if podcast episode, then play it.
+                            if (not self.IsChapterEpisode(episodeId)):
+                                self.PlayerMediaPlayTracks(episodeUri, deviceId=scDevice, delay=delay, shuffle=None)
+                                return
+
+                            # if audiobook episode, then just play the context which will automatically
+                            # pickup where it left off the last time.
+
+                    except Exception as ex:
+
+                        # trace.
+                        _logsi.LogVerbose("playShowLatestEpisode=True was specified; could not determine if show was an audiobook or podcast")
+                        # ignore exceptions, and just play the context.
             
             # is this an active Sonos device?
             # Sonos device can still be active, even if there is no active device in Spotify playstate.
@@ -12763,6 +12823,10 @@ class SpotifyClient:
                 # trace.
                 _logsi.LogVerbose("Context will be played on the Spotify Connect device via Spotify Web API")
 
+                # get uri parts.
+                uriType:str = self.GetTypeFromUri(contextUri)
+                uriId:str = self.GetIdFromUri(contextUri)
+
                 # get current player state.
                 playerState:PlayerPlayState = self.GetPlayerPlaybackState(additionalTypes=SpotifyMediaTypes.EPISODE.value)
 
@@ -12779,9 +12843,6 @@ class SpotifyClient:
                 # is shuffle enabled? and is this a Spotify URI value (e.g. `spotify:type:id`)?
                 if (shuffle or playerState.IsShuffleEnabled) and (self.IsSpotifyUri(contextUri)):
 
-                    # get uri parts.
-                    uriType:str = self.GetTypeFromUri(contextUri)
-                    uriId:str = self.GetIdFromUri(contextUri)
                     uriItems:PageObject = None
 
                     # wrap this in a try, as errors will be returned if context contains
@@ -12793,9 +12854,7 @@ class SpotifyClient:
 
                         # get number of items in the context, up to 50 max.
                         # we limit it to 50 to keep it fast, as some context lists are quite large!
-                        # note that playlist type is the only type we can limit the amount of data returned.
-                        # note that offset cannot be specified for artist context type; a `400 - Bad Request
-                        # Can't have offset for context type: ARTIST` error is returned if specified.
+                        # note that playlist type is the only type we can limit the fields to be returned.
                         if (uriType == SpotifyMediaTypes.PLAYLIST.value):
                             uriItems = self.GetPlaylistItems(uriId, limitTotal=50, fields="items(track(name))")
                         elif (uriType == SpotifyMediaTypes.ALBUM.value):
@@ -12813,6 +12872,14 @@ class SpotifyClient:
                         offsetPosition = random.randint(0, uriItems.ItemsCount - 1)
                         _logsi.LogVerbose("Shuffle is enabled; setting random offsetPosition to %s" % str(offsetPosition))
 
+                # offset cannot be specified for artist context type, otherwise the following error
+                # is returneed: `400 - Bad Request can't have offset for context type: ARTIST`.
+                if (uriType == SpotifyMediaTypes.ARTIST.value):
+                    if (offsetUri is not None) or (offsetPosition > 0):
+                        _logsi.LogVerbose("Context uri type is artist; ignoring offsetPosition and offsetUri values")
+                        offsetPosition = 0
+                        offsetUri = None
+
                 # build spotify web api request parameters.
                 reqData:dict = \
                 {

{spotifywebapipython-1.0.254.dist-info → spotifywebapipython-1.0.256.dist-info}/METADATA

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

{spotifywebapipython-1.0.254.dist-info → spotifywebapipython-1.0.256.dist-info}/RECORD

@@ -1,33 +1,33 @@
 spotifywebapipython/__init__.py,sha256=SnB5BsUGChYgcZHjhZenqYZkb_v3c8aiAUQLkp4lYSY,1205
-spotifywebapipython/const.py,sha256=5bQTKnJdcl1SwfWuTHJsb9g0oXT27W-lTMwWf_Vq9ME,3739
+spotifywebapipython/const.py,sha256=M9sIBcweqAbQT1Brp430jwTzfodj96MSa2xPtkO3oG8,3739
 spotifywebapipython/saappmessages.py,sha256=KWy4H0ePYARZgtGYc2CHXRY0JOQ0bqr0JuDKRBu-wjA,4645
 spotifywebapipython/sautils.py,sha256=j3f_Lu3Tb5D7-Gd2rJ2Ep901W-4XDp6Vq6XXVl8DX5I,8098
 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=Bubu3NpCv3rWnvhQSLpiClsaVodRYUC7UcWQCXR72RQ,849557
+spotifywebapipython/spotifyclient.py,sha256=a17f9cQBZrTafD4v0cBMgFT5hxQwGVbnIxSDlR2fc00,853246
 spotifywebapipython/spotifydiscovery.py,sha256=cyysxl8PQj9yGHVbaqhSF3SStlrp-NvfGAudM-dDmg0,20290
 spotifywebapipython/spotifymediatypes.py,sha256=MkHdPc1BF5hWo4WA-b4PtoihNKJMTXOe9JdnGpzp79c,1608
 spotifywebapipython/spotifywebapiauthenticationerror.py,sha256=5A0MKvYo3Ypv0ZeSSfLHuFLwzoUUu044bBoUgMfNXNw,3940
 spotifywebapipython/spotifywebapierror.py,sha256=5cga9213J_nFQ0UX4vSn3dpyinASKTRiH0wAR4nLjvs,3147
 spotifywebapipython/spotifywebplayertoken.py,sha256=axj1j1lM7COiiZfpElkJRdnk4AmE6bAQcjKshUIz1Nk,35813
-spotifywebapipython/docs/__init__.html,sha256=AXwB83jRylZrpeh2vFrY4lqACliQTLLjV8yjk23-cCA,180178
+spotifywebapipython/docs/__init__.html,sha256=tZP0DSBZSXYTqclFkHWVTwIUDXVc_j8of1fGDpDEQdI,181125
 spotifywebapipython/docs/codecopy.js,sha256=ryuoZwLIL03YitjjFzn49UO5ta7-OBos6LNA3qHhFzs,3120
-spotifywebapipython/docs/index.html,sha256=cCXWbp1vYiY1mJlEQciAdUylQIcBGXP4tZuovNoCDJU,48523
-spotifywebapipython/docs/search.js,sha256=VKniDdrPDGkeKhwm1Xziwd1cUsIQ5XTmmVp0933kmew,8945681
+spotifywebapipython/docs/index.html,sha256=4wVCoGmPz22QaxlrCOBBoGlycMJg7ugnrZszd_Mjg38,48523
+spotifywebapipython/docs/search.js,sha256=FZPlz9oM11zplFClPIv4YkacnGkZbPihs2NU8JVbbbI,8951356
 spotifywebapipython/docs/spotifywebapipython.ico,sha256=YImj39fqqSPSuB2-sMDlUYDd6YwRfQeJRtq4FjwWglg,16410
 spotifywebapipython/docs/spotifywebapipython_OLD.ico,sha256=YIv5LjcD4bTIJQSOr8jjwbWaeB3QkElRwkTOePiGbZo,14904
-spotifywebapipython/docs/spotifywebapipython/const.html,sha256=h4uWlqGx8XYOZ6sxPTc4pJTx18taakwSitrlxWRMUew,59034
-spotifywebapipython/docs/spotifywebapipython/saappmessages.html,sha256=0sLKzAGboOSF2zzZMjLXXfGTtnOqfvaY1cecKWz4Tm0,60895
-spotifywebapipython/docs/spotifywebapipython/sautils.html,sha256=MNJ4cfRyA4e4GR5DdincAvmuUlYYwjLEx3vVJIOxWdo,61063
-spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html,sha256=ztTM6MGQOt6rvEVP5WaV4L5FQR4bEjXvCcTCBtyzotc,48054
-spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html,sha256=k-9K8VJjEAgE5HbhcI7_8UqkMLZjPEdnT6QBGP3WigQ,59210
-spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html,sha256=YtHHkL_ml25HBsy75OUdleruB7qxii8_xS--lDgEuho,59256
-spotifywebapipython/docs/spotifywebapipython/spotifyclient.html,sha256=rkUQ1b-VN0UP11xP6GWWAjZWzPqQa-qmtOsMM_QjqZA,1634791
-spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html,sha256=GIAJfef0PpJh0jzbV3re8cgJsCL8CVpOiccDdMRXA4w,57662
-spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html,sha256=8Wrd7wRt2rX8lCYGQNl3n0L7eR3LHz1F26NQfbX69kg,52174
-spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html,sha256=aIXaY0JeM8FAz5Uu2Fu-zMGlARQ5H9PkwVO6YcWJIiw,50592
-spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html,sha256=9epSKwiWvQm7y1dkvHzUBTwlM1CLk5K4GfEnp7T6DYc,62204
+spotifywebapipython/docs/spotifywebapipython/const.html,sha256=6w21d7taCvDLE-cR0XM06T78DiCRj495asxGTv_JskE,59034
+spotifywebapipython/docs/spotifywebapipython/saappmessages.html,sha256=O7gWFOZsnbbVIz0yaGb4fiHqQdKKTG4saCXdiEjepgY,60895
+spotifywebapipython/docs/spotifywebapipython/sautils.html,sha256=qvxzg-O8ztRFmnoB0OpAuaLfM7OAUndDWn06jfRmI_s,61063
+spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html,sha256=HFPrZ4_ubjBLUw6lGqmutvgHXO7nfowqt6d6hIC1bSA,48054
+spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html,sha256=ve6hx4x7PbbmLy5-E-HyveFK1bqBJCjYuvQexcCwhi4,59210
+spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html,sha256=mfUrMqN4hDcsF7rWlPZlIj-l-pjTGxDMFAK1_PRaF-Q,59256
+spotifywebapipython/docs/spotifywebapipython/spotifyclient.html,sha256=k1MnXmkJT4RvTg0l1Udok1wWdPj5I_kOCSZZsvpnLY4,1635516
+spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html,sha256=D-0CJ-CV8ij-0ueCQhoE0u-E2ktVsJV1mwOkYyDo0W8,57662
+spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html,sha256=rOZLbn0Zpa-Nz78cW4GDWthkbviuNpPeI-muNRvVujg,52174
+spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html,sha256=yESEI3lACcURXQggf-l3FWd-fnATkRTLS5QiX7Q2NT8,50592
+spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html,sha256=AZ3PbcVZH-4kFm8aCC2_HwW_sol-O32EzJbzj2OZv-A,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
@@ -134,8 +134,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.254.dist-info/LICENSE,sha256=KGcc9g0zwqNLcWnSn_ezv1UtKyhMENFhvtixpxUPNsE,1177
-spotifywebapipython-1.0.254.dist-info/METADATA,sha256=1ogYGbnoQek0MHllJUaQHVP0aN6l_ZgPb5J4vVFHlMw,11644
-spotifywebapipython-1.0.254.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-spotifywebapipython-1.0.254.dist-info/top_level.txt,sha256=jTBLFlijKTesYh2dteAz4vb17qjaqWKeDjpnnwTcrjs,20
-spotifywebapipython-1.0.254.dist-info/RECORD,,
+spotifywebapipython-1.0.256.dist-info/LICENSE,sha256=KGcc9g0zwqNLcWnSn_ezv1UtKyhMENFhvtixpxUPNsE,1177
+spotifywebapipython-1.0.256.dist-info/METADATA,sha256=2R-1HIO57DbWdJ1vgpxurcV435FSrrw6W_Dp06DjhGA,11644
+spotifywebapipython-1.0.256.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+spotifywebapipython-1.0.256.dist-info/top_level.txt,sha256=jTBLFlijKTesYh2dteAz4vb17qjaqWKeDjpnnwTcrjs,20
+spotifywebapipython-1.0.256.dist-info/RECORD,,