Fix Agent object settings (#864)

* Fix mediaType argument for PlexServer.agents()

* Cleanup Agent and AgentMediaType attributes

* Add `DeprecationWarning` to `languageCode`

* Make Agent.settings() method public

* Add `DeprecationWarning` to `Agent._settings()`

* Fix parsing Setting.enumValues

* XML attribute for agent settings uses `values` instead of `enumValues`

* Add secure and option attributes to Setting

* Add test for server agents

Author: JonnyWong16

plexapi/library.py

@@ -631,7 +631,7 @@ def hubs(self):
     def agents(self):
         """ Returns a list of available :class:`~plexapi.media.Agent` for this library section.
         """
-        return self._server.agents(utils.searchType(self.type))
+        return self._server.agents(self.type)
 
     def settings(self):
         """ Returns a list of all library settings. """

plexapi/media.py

@@ -6,6 +6,7 @@
 from plexapi import log, settings, utils
 from plexapi.base import PlexObject
 from plexapi.exceptions import BadRequest
+from plexapi.utils import deprecated
 
 
 @utils.registerPlexObject
@@ -1058,31 +1059,50 @@ def _loadData(self, data):
         self.hasAttribution = data.attrib.get('hasAttribution')
         self.hasPrefs = data.attrib.get('hasPrefs')
         self.identifier = data.attrib.get('identifier')
+        self.name = data.attrib.get('name')
         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')]
+            self.languageCodes = self.listAttrs(data, 'code', etag='Language')
+            self.mediaTypes = []
         else:
-            self.mediaTypes = [AgentMediaType(server=self._server, data=d) for d in data]
+            self.languageCodes = []
+            self.mediaTypes = self.findItems(data, cls=AgentMediaType)
 
-    def _settings(self):
+    @property
+    @deprecated('use "languageCodes" instead')
+    def languageCode(self):
+        return self.languageCodes
+
+    def settings(self):
         key = '/:/plugins/%s/prefs' % self.identifier
         data = self._server.query(key)
         return self.findItems(data, cls=settings.Setting)
 
+    @deprecated('use "settings" instead')
+    def _settings(self):
+        return self.settings()
+
 
 class AgentMediaType(Agent):
+    """ Represents a single Agent MediaType.
+
+        Attributes:
+            TAG (str): 'MediaType'
+    """
+    TAG = 'MediaType'
 
     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.languageCodes = self.listAttrs(data, 'code', etag='Language')
         self.mediaType = utils.cast(int, data.attrib.get('mediaType'))
         self.name = data.attrib.get('name')
-        self.languageCode = []
-        for code in data:
-            self.languageCode += [code.attrib.get('code')]
+
+    @property
+    @deprecated('use "languageCodes" instead')
+    def languageCode(self):
+        return self.languageCodes

plexapi/server.py

@@ -229,10 +229,10 @@ def activities(self):
         return activities
 
     def agents(self, mediaType=None):
-        """ Returns the :class:`~plexapi.media.Agent` objects this server has available. """
+        """ Returns a list of :class:`~plexapi.media.Agent` objects this server has available. """
         key = '/system/agents'
         if mediaType:
-            key += '?mediaType=%s' % mediaType
+            key += '?mediaType=%s' % utils.searchType(mediaType)
         return self.fetchItems(key)
 
     def createToken(self, type='delegation', scope='all'):

plexapi/settings.py

@@ -113,17 +113,19 @@ class Setting(PlexObject):
 
     def _loadData(self, data):
         """ Load attribute values from Plex XML response. """
-        self._setValue = None
+        self.type = data.attrib.get('type')
+        self.advanced = utils.cast(bool, data.attrib.get('advanced'))
+        self.default = self._cast(data.attrib.get('default'))
+        self.enumValues = self._getEnumValues(data)
+        self.group = data.attrib.get('group')
+        self.hidden = utils.cast(bool, data.attrib.get('hidden'))
         self.id = data.attrib.get('id')
         self.label = data.attrib.get('label')
+        self.option = data.attrib.get('option')
+        self.secure = utils.cast(bool, data.attrib.get('secure'))
         self.summary = data.attrib.get('summary')
-        self.type = data.attrib.get('type')
-        self.default = self._cast(data.attrib.get('default'))
         self.value = self._cast(data.attrib.get('value'))
-        self.hidden = utils.cast(bool, data.attrib.get('hidden'))
-        self.advanced = utils.cast(bool, data.attrib.get('advanced'))
-        self.group = data.attrib.get('group')
-        self.enumValues = self._getEnumValues(data)
+        self._setValue = None
 
     def _cast(self, value):
         """ Cast the specific value to the type of this setting. """
@@ -132,8 +134,8 @@ def _cast(self, value):
         return value
 
     def _getEnumValues(self, data):
-        """ Returns a list of dictionary of valis value for this setting. """
-        enumstr = data.attrib.get('enumValues')
+        """ Returns a list or dictionary of values for this setting. """
+        enumstr = data.attrib.get('enumValues') or data.attrib.get('values')
         if not enumstr:
             return None
         if ':' in enumstr:

tests/test_server.py

@@ -571,3 +571,15 @@ def test_server_PlexWebURL_playlists(plex):
     assert plex.machineIdentifier in url
     assert 'source=playlists' in url
     assert 'pivot=playlists.%s' % tab in url
+
+
+def test_server_agents(plex):
+    agents = plex.agents()
+    assert agents
+    agent = next((a for a in agents if a.identifier == 'com.plexapp.agents.imdb'), None)
+    assert agent
+    settings = agent.settings()
+    assert settings
+    setting = next((s for s in settings if s.id == 'country'), None)
+    assert setting
+    assert setting.enumValues is not None