python-plexapi/plexapi/playlist.py

103 lines
4.2 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
from plexapi import utils
from plexapi.base import PlexPartialObject, Playable
2016-04-11 03:49:23 +00:00
from plexapi.exceptions import BadRequest
2017-02-07 06:58:29 +00:00
from plexapi.playqueue import PlayQueue
2016-02-03 18:07:53 +00:00
from plexapi.utils import cast, toDatetime
@utils.registerPlexObject
class Playlist(PlexPartialObject, Playable):
2017-02-20 05:37:00 +00:00
""" Represents a single Playlist object.
# TODO: Document attributes
"""
TAG = 'Playlist'
2016-02-03 18:07:53 +00:00
TYPE = 'playlist'
def _loadData(self, data):
""" Load attribute values from Plex XML response. """
Playable._loadData(self, data)
2017-02-04 17:43:50 +00:00
self.addedAt = toDatetime(data.attrib.get('addedAt'))
self.composite = data.attrib.get('composite') # url to thumbnail
self.duration = cast(int, data.attrib.get('duration'))
self.durationInSeconds = cast(int, data.attrib.get('durationInSeconds'))
self.guid = data.attrib.get('guid')
self.key = data.attrib.get('key')
2016-04-11 03:49:23 +00:00
self.key = self.key.replace('/items', '') if self.key else self.key # FIX_BUG_50
2017-02-04 17:43:50 +00:00
self.leafCount = cast(int, data.attrib.get('leafCount'))
self.playlistType = data.attrib.get('playlistType')
self.ratingKey = cast(int, data.attrib.get('ratingKey'))
self.smart = cast(bool, data.attrib.get('smart'))
self.summary = data.attrib.get('summary')
self.title = data.attrib.get('title')
self.type = data.attrib.get('type')
self.updatedAt = toDatetime(data.attrib.get('updatedAt'))
2016-02-03 18:07:53 +00:00
def items(self):
""" Returns a list of all items in the playlist. """
key = '%s/items' % self.key
return self.fetchItems(key)
2016-12-21 13:17:28 +00:00
2016-04-11 03:49:23 +00:00
def addItems(self, items):
""" Add items to a playlist. """
2016-04-11 03:49:23 +00:00
if not isinstance(items, (list, tuple)):
items = [items]
ratingKeys = []
for item in items:
if item.listType != self.playlistType:
2017-02-20 05:37:00 +00:00
raise BadRequest('Can not mix media types when building a playlist: %s and %s' %
(self.playlistType, item.listType))
2017-01-09 14:21:54 +00:00
ratingKeys.append(str(item.ratingKey))
uuid = items[0].section().uuid
2017-02-02 14:09:34 +00:00
ratingKeys = ','.join(ratingKeys)
key = '%s/items%s' % (self.key, utils.joinArgs({
'uri': 'library://%s/directory//library/metadata/%s' % (uuid, ratingKeys)
2016-04-11 03:49:23 +00:00
}))
return self._server.query(key, method=self._server._session.put)
2016-04-11 03:49:23 +00:00
def removeItem(self, item):
""" Remove a file from a playlist. """
key = '%s/items/%s' % (self.key, item.playlistItemID)
return self._server.query(key, method=self._server._session.delete)
2016-04-11 03:49:23 +00:00
def moveItem(self, item, after=None):
""" Move a to a new position in playlist. """
key = '%s/items/%s/move' % (self.key, item.playlistItemID)
2017-01-02 21:06:40 +00:00
if after:
key += '?after=%s' % after.playlistItemID
return self._server.query(key, method=self._server._session.put)
2016-12-21 13:17:28 +00:00
2016-04-11 03:49:23 +00:00
def edit(self, title=None, summary=None):
""" Edit playlist. """
2017-02-20 05:37:00 +00:00
key = '/library/metadata/%s%s' % (self.ratingKey, utils.joinArgs({'title': title, 'summary': summary}))
return self._server.query(key, method=self._server._session.put)
2016-12-21 13:17:28 +00:00
2016-04-11 03:49:23 +00:00
def delete(self):
""" Delete playlist. """
return self._server.query(self.key, method=self._server._session.delete)
2016-12-21 13:17:28 +00:00
2017-02-07 06:58:29 +00:00
def playQueue(self, *args, **kwargs):
""" Create a playqueue from this playlist. """
return PlayQueue.create(self._server, self, *args, **kwargs)
2017-02-07 06:58:29 +00:00
2016-04-11 03:49:23 +00:00
@classmethod
def create(cls, server, title, items):
""" Create a playlist. """
2016-04-11 03:49:23 +00:00
if not isinstance(items, (list, tuple)):
items = [items]
ratingKeys = []
for item in items:
if item.listType != items[0].listType:
2016-04-11 03:49:23 +00:00
raise BadRequest('Can not mix media types when building a playlist')
2016-12-21 13:17:28 +00:00
ratingKeys.append(str(item.ratingKey))
ratingKeys = ','.join(ratingKeys)
2016-04-13 03:52:47 +00:00
uuid = items[0].section().uuid
key = '/playlists%s' % utils.joinArgs({
'uri': 'library://%s/directory//library/metadata/%s' % (uuid, ratingKeys),
'type': items[0].listType,
2016-04-11 03:49:23 +00:00
'title': title,
'smart': 0
})
data = server.query(key, method=server._session.post)[0]
return cls(server, data, initpath=key)