Merge branch 'master' into poster_change

Author: blacktwin

plexapi/base.py

@@ -471,6 +471,90 @@ def setArt(self, art):
         """ Set :class:`~plexapi.media.Poster` to :class:`~plexapi.video.Video` """
         art.select()
 
+    def unmatch(self):
+        """ Unmatches metadata match from object. """
+        key = '/library/metadata/%s/unmatch' % self.ratingKey
+        self._server.query(key, method=self._server._session.put)
+
+    def matches(self, auto=False, agent=None, title=None, year=None, language=None):
+        """ Return list of (:class:`~plexapi.media.SearchResult) metadata matches.
+
+             Parameters:
+                 auto (bool): True searches for matches automatically
+                    False allows for user to provide additional parameters to search
+                    *Auto searching
+                agent (str): Agent name to be used (imdb, thetvdb, themoviedb, etc.)
+                title (str): Title of item to search for
+                year (str): Year of item to search in
+                language (str) : Language of item to search in
+
+            Examples:
+                1. video.matches()
+                2. video.matches(title="something", year=2020)
+                3. video.matches(title="something")
+                4. video.matches(year=2020)
+                5. video.matches(title="something", year="")
+                6. video.matches(title="", year=2020)
+                7. video.matches(title="", year="")
+
+                1. The default behaviour in Plex Web = no params in plexapi
+                2. Both title and year specified by user
+                3. Year automatically filled in
+                4. Title automatically filled in
+                5. Explicitly searches for title with blank year
+                6. Explicitly searches for blank title with year
+                7. I don't know what the user is thinking... return the same result as 1
+
+                For 2 to 7, the agent and language is automatically filled in
+        """
+        key = '/library/metadata/%s/matches' % self.ratingKey
+        params = {'manual': 1}
+
+        if any([agent, title, year, language]):
+            if title is None:
+                params['title'] = self.title
+            else:
+                params['title'] = title
+
+            if year is None:
+                params['year'] = self.year
+            else:
+                params['year'] = year
+
+            params['language'] = language or self.section().language
+
+            if agent is None:
+                params['agent'] = self.section().agent
+            else:
+                params['agent'] = utils.getAgentIdentifier(self.section(), agent)
+
+            key = key + '?' + urlencode(params)
+        data = self._server.query(key, method=self._server._session.get)
+        return self.findItems(data)
+
+    def fixMatch(self, searchResult=None, auto=False):
+        """ Use match result to update show metadata.
+
+            Parameters:
+                auto (bool): True uses first match from matches
+                    False allows user to provide the match
+                    *Auto matching
+                searchResult (:class:`~plexapi.media.SearchResult): Search result from
+                    ~plexapi.base.matches()
+        """
+        key = '/library/metadata/%s/match' % self.ratingKey
+        if auto:
+            searchResult = self.matches()[0]
+        elif not searchResult:
+            raise NotFound('fixMatch() requires either auto=True or '
+                           'searchResult=:class:`~plexapi.media.SearchResult`.')
+
+        params = {'guid': searchResult.guid,
+                  'name': searchResult.name}
+
+        data = key + '?' + urlencode(params)
+        self._server.query(data, method=self._server._session.put)
+
     # The photo tag cant be built atm. TODO
     # def arts(self):
     #     part = '%s/arts' % self.key

plexapi/library.py

@@ -4,6 +4,7 @@
 from plexapi.compat import unquote, urlencode, quote_plus
 from plexapi.media import MediaTag
 from plexapi.exceptions import BadRequest, NotFound
+from plexapi.settings import Setting
 
 
 class Library(PlexObject):
@@ -365,13 +366,15 @@ def delete(self):
             log.error(msg)
             raise
 
-    def edit(self, **kwargs):
+    def edit(self, agent=None, **kwargs):
         """ Edit a library (Note: agent is required). See :class:`~plexapi.library.Library` for example usage.
 
             Parameters:
                 kwargs (dict): Dict of settings to edit.
         """
-        part = '/library/sections/%s?%s' % (self.key, urlencode(kwargs))
+        if not agent:
+            agent = self.agent
+        part = '/library/sections/%s?agent=%s&%s' % (self.key, agent, urlencode(kwargs))
         self._server.query(part, method=self._server._session.put)
 
         # Reload this way since the self.key dont have a full path, but is simply a id.
@@ -401,6 +404,17 @@ def all(self, sort=None, **kwargs):
         key = '/library/sections/%s/all%s' % (self.key, sortStr)
         return self.fetchItems(key, **kwargs)
 
+    def agents(self):
+        """ Returns a list of available `:class:`~plexapi.media.Agent` for this library section.
+        """
+        return self._server.agents(utils.searchType(self.type))
+
+    def settings(self):
+        """ Returns a list of all library settings. """
+        key = '/library/sections/%s/prefs' % self.key
+        data = self._server.query(key)
+        return self.findItems(data, cls=Setting)
+
     def onDeck(self):
         """ Returns a list of media items on deck from this library section. """
         key = '/library/sections/%s/onDeck' % self.key

plexapi/media.py

@@ -2,7 +2,7 @@
 
 import xml
 
-from plexapi import compat, log, utils
+from plexapi import compat, log, utils, settings
 from plexapi.base import PlexObject
 from plexapi.exceptions import BadRequest
 from plexapi.utils import cast
@@ -710,3 +710,74 @@ def _loadData(self, data):
         self._data = data
         self.name = data.attrib.get('name')
         self.locked = cast(bool, data.attrib.get('locked'))
+
+
+@utils.registerPlexObject
+class SearchResult(PlexObject):
+    """ Represents a single SearchResult.
+
+        Attributes:
+            TAG (str): 'SearchResult'
+    """
+    TAG = 'SearchResult'
+
+    def __repr__(self):
+        name = self._clean(self.firstAttr('name'))
+        score = self._clean(self.firstAttr('score'))
+        return '<%s>' % ':'.join([p for p in [self.__class__.__name__, name, score] if p])
+
+    def _loadData(self, data):
+        self._data = data
+        self.guid = data.attrib.get('guid')
+        self.lifespanEnded = data.attrib.get('lifespanEnded')
+        self.name = data.attrib.get('name')
+        self.score = cast(int, data.attrib.get('score'))
+        self.year = data.attrib.get('year')
+
+
+@utils.registerPlexObject
+class Agent(PlexObject):
+    """ Represents a single Agent.
+
+        Attributes:
+            TAG (str): 'Agent'
+    """
+    TAG = 'Agent'
+
+    def __repr__(self):
+        uid = self._clean(self.firstAttr('shortIdentifier'))
+        return '<%s>' % ':'.join([p for p in [self.__class__.__name__, uid] if p])
+
+    def _loadData(self, data):
+        self._data = data
+        self.hasAttribution = data.attrib.get('hasAttribution')
+        self.hasPrefs = data.attrib.get('hasPrefs')
+        self.identifier = data.attrib.get('identifier')
+        self.primary = data.attrib.get('primary')
+        self.shortIdentifier = self.identifier.rsplit('.', 1)[1]
+        if 'mediaType' in self._initpath:
+            self.name = data.attrib.get('name')
+            self.languageCode = []
+            for code in data:
+                self.languageCode += [code.attrib.get('code')]
+        else:
+            self.mediaTypes = [AgentMediaType(server=self._server, data=d) for d in data]
+
+    def _settings(self):
+        key = '/:/plugins/%s/prefs' % self.identifier
+        data = self._server.query(key)
+        return self.findItems(data, cls=settings.Setting)
+
+
+class AgentMediaType(Agent):
+
+    def __repr__(self):
+        uid = self._clean(self.firstAttr('name'))
+        return '<%s>' % ':'.join([p for p in [self.__class__.__name__, uid] if p])
+
+    def _loadData(self, data):
+        self.mediaType = cast(int, data.attrib.get('mediaType'))
+        self.name = data.attrib.get('name')
+        self.languageCode = []
+        for code in data:
+            self.languageCode += [code.attrib.get('code')]

plexapi/server.py

@@ -184,6 +184,13 @@ def account(self):
         data = self.query(Account.key)
         return Account(self, data)
 
+    def agents(self, mediaType=None):
+        """ Returns the `:class:`~plexapi.media.Agent` objects this server has available. """
+        key = '/system/agents'
+        if mediaType:
+            key += '?mediaType=%s' % mediaType
+        return self.fetchItems(key)
+
     def createToken(self, type='delegation', scope='all'):
         """Create a temp access token for the server."""
         q = self.query('/security/token?type=%s&scope=%s' % (type, scope))

plexapi/settings.py

@@ -124,8 +124,8 @@ def _loadData(self, data):
         self.enumValues = self._getEnumValues(data)
 
     def _cast(self, value):
-        """ Cast the specifief value to the type of this setting. """
-        if self.type != 'text':
+        """ Cast the specific value to the type of this setting. """
+        if self.type != 'enum':
             value = utils.cast(self.TYPES.get(self.type)['cast'], value)
         return value
 

plexapi/utils.py

@@ -59,15 +59,18 @@ def registerPlexObject(cls):
 
 def cast(func, value):
     """ Cast the specified value to the specified type (returned by func). Currently this
-        only support int, float, bool. Should be extended if needed.
+        only support str, int, float, bool. Should be extended if needed.
 
         Parameters:
             func (func): Calback function to used cast to type (int, bool, float).
             value (any): value to be cast and returned.
     """
     if value is not None:
         if func == bool:
-            return bool(int(value))
+            try:
+                return bool(int(value))
+            except ValueError:
+                return bool(value)
         elif func in (int, float):
             try:
                 return func(value)
@@ -375,3 +378,15 @@ def choose(msg, items, attr):  # pragma: no cover
 
         except (ValueError, IndexError):
             pass
+
+
+def getAgentIdentifier(section, agent):
+    """ Return the full agent identifier from a short identifier, name, or confirm full identifier. """
+    agents = []
+    for ag in section.agents():
+        identifiers = [ag.identifier, ag.shortIdentifier, ag.name]
+        if agent in identifiers:
+            return ag.identifier
+        agents += identifiers
+    raise NotFound('Couldnt find "%s" in agents list (%s)' %
+                   (agent, ', '.join(agents)))