Skip to content

Make Photo objects Playable #592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jjlawren merged 2 commits into from
Nov 1, 2020
Merged

Make Photo objects Playable #592

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cc6e64
Make Photo objects Playable
jjlawren Oct 25, 2020
75b9b53
Add more attributes
jjlawren Oct 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions plexapi/photo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from urllib.parse import quote_plus

from plexapi import media, utils
from plexapi.base import PlexPartialObject
from plexapi.base import Playable, PlexPartialObject
from plexapi.exceptions import BadRequest, NotFound


Expand Down Expand Up @@ -76,7 +76,7 @@ def photo(self, title):


@utils.registerPlexObject
class Photo(PlexPartialObject):
class Photo(PlexPartialObject, Playable):
""" Represents a single photo.

Attributes:
Expand All @@ -86,6 +86,7 @@ class Photo(PlexPartialObject):
fields (list): List of :class:`~plexapi.media.Field`.
index (sting): Index number of this photo.
key (str): API URL (/library/metadata/<ratingkey>).
librarySectionID (int): :class:`~plexapi.library.LibrarySection` ID.
listType (str): Hardcoded as 'photo' (useful for search filters).
media (TYPE): Unknown
originallyAvailableAt (datetime): Datetime this photo was added to Plex.
Expand All @@ -105,11 +106,13 @@ class Photo(PlexPartialObject):

def _loadData(self, data):
""" Load attribute values from Plex XML response. """
Playable._loadData(self, data)
self.listType = 'photo'
self.addedAt = utils.toDatetime(data.attrib.get('addedAt'))
self.fields = self.findItems(data, etag='Field')
self.index = utils.cast(int, data.attrib.get('index'))
self.key = data.attrib.get('key')
self.librarySectionID = data.attrib.get('librarySectionID')
self.originallyAvailableAt = utils.toDatetime(
data.attrib.get('originallyAvailableAt'), '%Y-%m-%d')
self.parentKey = data.attrib.get('parentKey')
Expand All @@ -124,6 +127,12 @@ def _loadData(self, data):
self.media = self.findItems(data, media.Media)
self.tag = self.findItems(data, media.Tag)

@property
def thumbUrl(self):
"""Return URL for the thumbnail image."""
key = self.firstAttr('thumb', 'parentThumb', 'granparentThumb')
return self._server.url(key, includeToken=True) if key else None

def photoalbum(self):
""" Return this photo's :class:`~plexapi.photo.Photoalbum`. """
return self.fetchItem(self.parentKey)
Expand Down