Merge pull request #765 from JonnyWong16/feature/auto_reload

Allow overwriting attributes with None when manually reloading

Author: JonnyWong16

plexapi/base.py

@@ -7,8 +7,9 @@
 from plexapi import log, utils
 from plexapi.exceptions import BadRequest, NotFound, UnknownType, Unsupported
 
-DONT_RELOAD_FOR_KEYS = {'key', 'session'}
-DONT_OVERWRITE_SESSION_KEYS = {'usernames', 'players', 'transcodeSessions', 'session'}
+USER_DONT_RELOAD_FOR_KEYS = set()
+_DONT_RELOAD_FOR_KEYS = {'key', 'session'}
+_DONT_OVERWRITE_SESSION_KEYS = {'usernames', 'players', 'transcodeSessions', 'session'}
 OPERATORS = {
     'exact': lambda v, q: v == q,
     'iexact': lambda v, q: v.lower() == q.lower(),
@@ -52,6 +53,7 @@ def __init__(self, server, data, initpath=None, parent=None):
         if data is not None:
             self._loadData(data)
         self._details_key = self._buildDetailsKey()
+        self._autoReload = False
 
     def __repr__(self):
         uid = self._clean(self.firstAttr('_baseurl', 'key', 'id', 'playQueueID', 'uri'))
@@ -60,10 +62,12 @@ def __repr__(self):
 
     def __setattr__(self, attr, value):
         # Don't overwrite session specific attr with []
-        if attr in DONT_OVERWRITE_SESSION_KEYS and value == []:
+        if attr in _DONT_OVERWRITE_SESSION_KEYS and value == []:
             value = getattr(self, attr, [])
-        # Don't overwrite an attr with None unless it's a private variable
-        if value is not None or attr.startswith('_') or attr not in self.__dict__:
+
+        autoReload = self.__dict__.get('_autoReload')
+        # Don't overwrite an attr with None unless it's a private variable or not auto reload
+        if value is not None or attr.startswith('_') or attr not in self.__dict__ or not autoReload:
             self.__dict__[attr] = value
 
     def _clean(self, value):
@@ -331,13 +335,19 @@ def reload(self, key=None, **kwargs):
                     movie.isFullObject()  # Returns True
 
         """
+        return self._reload(key=key, **kwargs)
+
+    def _reload(self, key=None, _autoReload=False, **kwargs):
+        """ Perform the actual reload. """
         details_key = self._buildDetailsKey(**kwargs) if kwargs else self._details_key
         key = key or details_key or self.key
         if not key:
             raise Unsupported('Cannot reload an object not built from a URL.')
         self._initpath = key
         data = self._server.query(key)
+        self._autoReload = _autoReload
         self._loadData(data[0])
+        self._autoReload = False
         return self
 
     def _checkAttrs(self, elem, **kwargs):
@@ -443,8 +453,9 @@ def __getattribute__(self, attr):
         # Dragons inside.. :-/
         value = super(PlexPartialObject, self).__getattribute__(attr)
         # Check a few cases where we dont want to reload
-        if attr in DONT_RELOAD_FOR_KEYS: return value
-        if attr in DONT_OVERWRITE_SESSION_KEYS: return value
+        if attr in _DONT_RELOAD_FOR_KEYS: return value
+        if attr in _DONT_OVERWRITE_SESSION_KEYS: return value
+        if attr in USER_DONT_RELOAD_FOR_KEYS: return
         if attr.startswith('_'): return value
         if value not in (None, []): return value
         if self.isFullObject(): return value
@@ -454,7 +465,7 @@ def __getattribute__(self, attr):
         objname = "%s '%s'" % (clsname, title) if title else clsname
         log.debug("Reloading %s for attr '%s'", objname, attr)
         # Reload and return the value
-        self.reload()
+        self._reload(_autoReload=True)
         return super(PlexPartialObject, self).__getattribute__(attr)
 
     def analyze(self):
@@ -696,7 +707,7 @@ def updateProgress(self, time, state='stopped'):
         key = '/:/progress?key=%s&identifier=com.plexapp.plugins.library&time=%d&state=%s' % (self.ratingKey,
                                                                                               time, state)
         self._server.query(key)
-        self.reload()
+        self._reload(_autoReload=True)
 
     def updateTimeline(self, time, state='stopped', duration=None):
         """ Set the timeline progress for this video.
@@ -714,7 +725,7 @@ def updateTimeline(self, time, state='stopped', duration=None):
         key = '/:/timeline?ratingKey=%s&key=%s&identifier=com.plexapp.plugins.library&time=%d&state=%s%s'
         key %= (self.ratingKey, self.key, time, state, durationStr)
         self._server.query(key)
-        self.reload()
+        self._reload(_autoReload=True)
 
 
 class MediaContainer(PlexObject):

tests/test_collection.py

@@ -135,9 +135,7 @@ def test_Collection_edit(collection, movies):
             "summary.locked": 0
         }
     )
-    # Cannot use collection.reload() since PlexObject.__setattr__()
-    # will not overwrite contentRating with None
-    collection = movies.collection("Test Collection")
+    collection.reload()
     assert collection.title == title
     assert collection.titleSort == titleSort
     assert collection.contentRating is None

tests/test_mixins.py

@@ -185,9 +185,7 @@ def edit_rating(obj):
     assert utils.is_datetime(obj.lastRatedAt)
     assert obj.userRating == 10.0
     obj.rate()
-    # Cannot use obj.reload() since PlexObject.__setattr__()
-    # will not overwrite userRating with None
-    obj = obj.fetchItem(obj._details_key)
+    obj.reload()
     assert obj.userRating is None
     with pytest.raises(BadRequest):
         assert obj.rate('bad-rating')