Mirrors/python-plexapi
2
0
Fork 0
mirror of https://github.com/pkkid/python-plexapi synced 2024-11-28 22:50:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add method to update smart playlist filters

Browse source
This commit is contained in:
JonnyWong16 2021-05-27 00:05:17 -07:00
parent 4c9964db1b
commit 2af15e2d73
No known key found for this signature in database
GPG key ID: B1F1F9807184697A
1 changed files with 33 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
plexapi/playlist.py
View file

@ -151,7 +151,7 @@ class Playlist(PlexPartialObject, Playable, ArtMixin, PosterMixin):
def items(self): def items(self):
""" Returns a list of all items in the playlist. """ """ Returns a list of all items in the playlist. """
if self._items is None: if self._items is None:
key = '/playlists/%s/items' % self.ratingKey key = '%s/items' % self.key
items = self.fetchItems(key) items = self.fetchItems(key)
self._items = items self._items = items
return self._items return self._items
@ -242,7 +242,37 @@ class Playlist(PlexPartialObject, Playable, ArtMixin, PosterMixin):
key += '?after=%s' % after.playlistItemID key += '?after=%s' % after.playlistItemID
self._server.query(key, method=self._server._session.put) self._server.query(key, method=self._server._session.put)
def updateFilters(self, limit=None, sort=None, filters=None, **kwargs):
""" Update the filters for a smart playlist.
Parameters:
limit (int): Limit the number of items in the playlist.
sort (str or list, optional): A string of comma separated sort fields
or a list of sort fields in the format ``column:dir``.
See :func:`plexapi.library.LibrarySection.search` for more info.
filters (dict): A dictionary of advanced filters.
See :func:`plexapi.library.LibrarySection.search` for more info.
**kwargs (dict): Additional custom filters to apply to the search results.
See :func:`plexapi.library.LibrarySection.search` for more info.
Raises:
:class:`plexapi.exceptions.BadRequest`: When trying update filters for a regular playlist.
"""
if not self.smart:
raise BadRequest('Cannot update filters for a regular playlist.')
section = self.section()
searchKey = section._buildSearchKey(
sort=sort, libtype=section.METADATA_TYPE, filters=filters, **kwargs)
uri = '%s%s' % (self._uriRoot(), searchKey)
if limit:
uri = uri + '&limit=%s' % str(limit)
key = '%s/items%s' % (self.key, utils.joinArgs({
'uri': uri
}))
self._server.query(key, method=self._server._session.put)
def edit(self, title=None, summary=None): def edit(self, title=None, summary=None):
""" Edit the playlist. """ Edit the playlist.
@ -331,7 +361,7 @@ class Playlist(PlexPartialObject, Playable, ArtMixin, PosterMixin):
video, or photo objects to be added to the playlist. video, or photo objects to be added to the playlist.
smart (bool): True to create a smart playlist. Default False. smart (bool): True to create a smart playlist. Default False.
section (:class:`~plexapi.library.LibrarySection`, str): Smart playlists only, section (:class:`~plexapi.library.LibrarySection`, str): Smart playlists only,
library section to create the playlist in. the library section to create the playlist in.
limit (int): Smart playlists only, limit the number of items in the playlist. limit (int): Smart playlists only, limit the number of items in the playlist.
sort (str or list, optional): Smart playlists only, a string of comma separated sort fields sort (str or list, optional): Smart playlists only, a string of comma separated sort fields
or a list of sort fields in the format ``column:dir``. or a list of sort fields in the format ``column:dir``.
@ -340,7 +370,7 @@ class Playlist(PlexPartialObject, Playable, ArtMixin, PosterMixin):
See :func:`plexapi.library.LibrarySection.search` for more info. See :func:`plexapi.library.LibrarySection.search` for more info.
**kwargs (dict): Smart playlists only, additional custom filters to apply to the **kwargs (dict): Smart playlists only, additional custom filters to apply to the
search results. See :func:`plexapi.library.LibrarySection.search` for more info. search results. See :func:`plexapi.library.LibrarySection.search` for more info.
Raises: Raises:
:class:`plexapi.exceptions.BadRequest`: When no items are included to create the playlist. :class:`plexapi.exceptions.BadRequest`: When no items are included to create the playlist.
:class:`plexapi.exceptions.BadRequest`: When mixing media types in the playlist. :class:`plexapi.exceptions.BadRequest`: When mixing media types in the playlist.