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

Add indexes. Closes https://github.com/pkkid/python-plexapi/issues/121

Browse source
This commit is contained in:
Hellowlol 2017-02-18 01:51:06 +01:00
parent 881089468e
commit c7c04d2a42
4 changed files with 84 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
plexapi/media.py
View file

@ -56,7 +56,7 @@ class Media(PlexObject):
@utils.registerPlexObject
class MediaPart(PlexObject):
""" Represents a single media part (often a single file) for the media this belongs to.
Attributes:
TAG (str): 'Part'
server (:class:`~plexapi.server.PlexServer`): PlexServer object this is from.
@ -66,6 +66,7 @@ class MediaPart(PlexObject):
duration (int): Length of this media part in milliseconds.
file (str): Path to this file on disk (ex: /media/Movies/Cars.(2006)/Cars.cd2.avi)
id (int): Unique ID of this media part.
indexes (str, None): None or SD.
key (str): Key used to access this media part (ex: /library/parts/46618/1389985872/file.avi).
size (int): Size of this file in bytes (ex: 733884416).
streams (list<:class:`~plexapi.media.MediaPartStream`>): List of streams in this media part.
@ -79,6 +80,7 @@ class MediaPart(PlexObject):
self.duration = cast(int, data.attrib.get('duration'))
self.file = data.attrib.get('file')
self.id = cast(int, data.attrib.get('id'))
self.indexes = data.attrib.get('indexes')
self.key = data.attrib.get('key')
self.size = cast(int, data.attrib.get('size'))
self.streams = self._buildStreams(data)
@ -109,7 +111,7 @@ class MediaPart(PlexObject):
class MediaPartStream(PlexObject):
""" Base class for media streams. These consist of video, audio and subtitles.
Attributes:
server (:class:`~plexapi.server.PlexServer`): PlexServer object this is from.
initpath (str): Relative path requested when retrieving specified data.
@ -232,7 +234,7 @@ class AudioStream(MediaPartStream):
@utils.registerPlexObject
class SubtitleStream(MediaPartStream):
""" Respresents a audio stream within a :class:`~plexapi.media.MediaPart`.
Attributes:
TAG (str): 'Stream'
STREAMTYPE (int): 3
@ -253,7 +255,7 @@ class SubtitleStream(MediaPartStream):
@utils.registerPlexObject
class TranscodeSession(PlexObject):
""" Represents a current transcode session.
""" Represents a current transcode session.
Attributes:
TAG (str): 'TranscodeSession'
@ -294,9 +296,9 @@ class MediaTag(PlexObject):
tag (str): Name of the tag. This will be Animation, SciFi etc for Genres. The name of
person for Directors and Roles (ex: Animation, Stephen Graham, etc).
<Hub_Search_Attributes>: Attributes only applicable in search results from
PlexServer :func:`~plexapi.server.PlexServer.search()`. They provide details of which
PlexServer :func:`~plexapi.server.PlexServer.search()`. They provide details of which
library section the tag was found as well as the url to dig deeper into the results.
* key (str): API URL to dig deeper into this tag (ex: /library/sections/1/all?actor=9081).
* librarySectionID (int): Section ID this tag was generated from.
* librarySectionTitle (str): Library section title this tag was found.
@ -330,7 +332,7 @@ class MediaTag(PlexObject):
@utils.registerPlexObject
class Collection(MediaTag):
""" Represents a single Collection media tag.
Attributes:
TAG (str): 'Collection'
FILTER (str): 'collection'
@ -341,7 +343,7 @@ class Collection(MediaTag):
@utils.registerPlexObject
class Country(MediaTag):
""" Represents a single Country media tag.
Attributes:
TAG (str): 'Country'
FILTER (str): 'country'
@ -352,7 +354,7 @@ class Country(MediaTag):
@utils.registerPlexObject
class Director(MediaTag):
""" Represents a single Director media tag.
Attributes:
TAG (str): 'Director'
FILTER (str): 'director'
@ -363,7 +365,7 @@ class Director(MediaTag):
@utils.registerPlexObject
class Genre(MediaTag):
""" Represents a single Genre media tag.
Attributes:
TAG (str): 'Genre'
FILTER (str): 'genre'
@ -374,7 +376,7 @@ class Genre(MediaTag):
@utils.registerPlexObject
class Mood(MediaTag):
""" Represents a single Mood media tag.
Attributes:
TAG (str): 'Mood'
FILTER (str): 'mood'
@ -385,7 +387,7 @@ class Mood(MediaTag):
@utils.registerPlexObject
class Producer(MediaTag):
""" Represents a single Producer media tag.
Attributes:
TAG (str): 'Producer'
FILTER (str): 'producer'
@ -396,7 +398,7 @@ class Producer(MediaTag):
@utils.registerPlexObject
class Role(MediaTag):
""" Represents a single Role (actor/actress) media tag.
Attributes:
TAG (str): 'Role'
FILTER (str): 'role'
@ -407,7 +409,7 @@ class Role(MediaTag):
@utils.registerPlexObject
class Similar(MediaTag):
""" Represents a single Similar media tag.
Attributes:
TAG (str): 'Similar'
FILTER (str): 'similar'
@ -418,7 +420,7 @@ class Similar(MediaTag):
@utils.registerPlexObject
class Writer(MediaTag):
""" Represents a single Writer media tag.
Attributes:
TAG (str): 'Writer'
FILTER (str): 'writer'
@ -429,7 +431,7 @@ class Writer(MediaTag):
@utils.registerPlexObject
class Field(PlexObject):
""" Represents a single Field.
Attributes:
TAG (str): 'Field'
"""

55
plexapi/utils.py
View file

@ -1,14 +1,20 @@
# -*- coding: utf-8 -*-
import logging, os, requests
import logging
import os
from datetime import datetime
import time
from threading import Thread
import requests
from plexapi.compat import quote, string_type
from plexapi.exceptions import NotFound
# Search Types - Plex uses these to filter specific media types when searching.
# Library Types - Populated at runtime
SEARCHTYPES = {'movie': 1, 'show': 2, 'season': 3, 'episode': 4,
'artist': 8, 'album': 9, 'track': 10, 'photo': 14}
'artist': 8, 'album': 9, 'track': 10, 'photo': 14}
PLEXOBJECTS = {}
@ -174,7 +180,7 @@ def toDatetime(value, format=None):
def toList(value, itemcast=None, delim=','):
""" Returns a list of strings from the specified value.
Parameters:
value (str): comma delimited string to convert to list.
itemcast (func): Function to cast each list item to (default str).
@ -185,6 +191,49 @@ def toList(value, itemcast=None, delim=','):
return [itemcast(item) for item in value.split(delim) if item != '']
def get_session_images(server, filename=None, height=150, width=150, opacity=100, saturation=100):
"""Simple helper to download a bif image or thumb.url from plex.server.sessions. Returns a dict.
Parameters:
filename (str): default to None,
height (int): Height of the image.
width (int): width of the image.
opacity (int): Opacity of the resulting image (possibly deprecated).
saturation (int): Saturating of the resulting image.
Returns:
{'hellowlol': {'fp': 'path_to_file'
'url', 'http://....'}
}
"""
info = {}
for media in server.sessions():
url = None
for part in media.iterParts():
if media.thumb:
url = media.thumb
# Always use bif images if available.
if part.indexes:
url = '/library/parts/%s/indexes/sd/%s' % (part.id, media.viewOffset)
if url:
if filename is None:
filename = 'session_transcode_%s_%s_%s' % (media.usernames[0], media._prettyfilename(),
int(time.time()))
url = server.transcodeImage(url, height=height, width=width,
opacity=opacity, saturation=saturation)
dfp = download(url, filename=filename)
info['username'] = {'fp': dfp,
'url': url}
return info
def download(url, filename=None, savepath=None, session=None, chunksize=4024, mocked=False):
""" Helper to download a thumb, videofile or other media item. Returns the local
path to the downloaded file.

16
plexapi/video.py
View file

@ -5,7 +5,7 @@ from plexapi.base import Playable, PlexPartialObject
class Video(PlexPartialObject):
""" Base class for all video objects including :class:`~plexapi.video.Movie`,
""" Base class for all video objects including :class:`~plexapi.video.Movie`,
:class:`~plexapi.video.Show`, :class:`~plexapi.video.Season`,
:class:`~plexapi.video.Episode`.
@ -68,7 +68,7 @@ class Video(PlexPartialObject):
@utils.registerPlexObject
class Movie(Video, Playable):
""" Represents a single Movie.
Attributes:
TAG (str): 'Diectory'
TYPE (str): 'movie'
@ -146,9 +146,13 @@ class Movie(Video, Playable):
"""
return [p.file for p in self.iterParts() if p]
def _prettyfilename(self):
# This is just for compat.
return self.title
def download(self, savepath=None, keep_orginal_name=False, **kwargs):
""" Download video files to specified directory.
Parameters:
savepath (str): Defaults to current working dir.
keep_orginal_name (bool): True to keep the original file name otherwise
@ -292,7 +296,7 @@ class Show(Video):
def download(self, savepath=None, keep_orginal_name=False, **kwargs):
""" Download video files to specified directory.
Parameters:
savepath (str): Defaults to current working dir.
keep_orginal_name (bool): True to keep the original file name otherwise
@ -390,7 +394,7 @@ class Season(Video):
def download(self, savepath=None, keep_orginal_name=False, **kwargs):
""" Download video files to specified directory.
Parameters:
savepath (str): Defaults to current working dir.
keep_orginal_name (bool): True to keep the original file name otherwise
@ -408,7 +412,7 @@ class Season(Video):
@utils.registerPlexObject
class Episode(Video, Playable):
""" Represents a single Shows Episode.
Attributes:
TAG (str): 'Diectory'
TYPE (str): 'episode'

4
tests/test_utils.py
View file

@ -15,6 +15,10 @@ def _test_utils_threaded():
pass
def _download_session_images():
pass # TODO Add this when we got clients fixed.
def test_utils_searchType():
st = utils.searchType('movie')
assert st == 1