Skip to content

Commit

Permalink
Allow exclude parameters in reload kwargs (#1378)
Browse files Browse the repository at this point in the history
* Allow exclude parameters in reload

* Add test for reload kwargs
  • Loading branch information
JonnyWong16 authored Mar 16, 2024
1 parent b494e8e commit 642ba8b
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 6 deletions.
27 changes: 21 additions & 6 deletions plexapi/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,22 @@ def _buildDetailsKey(self, **kwargs):
or disable each parameter individually by setting it to False or 0.
"""
details_key = self.key
params = {}

if details_key and hasattr(self, '_INCLUDES'):
includes = {}
for k, v in self._INCLUDES.items():
value = kwargs.get(k, v)
value = kwargs.pop(k, v)
if value not in [False, 0, '0']:
includes[k] = 1 if value is True else value
if includes:
details_key += '?' + urlencode(sorted(includes.items()))
params[k] = 1 if value is True else value

if details_key and hasattr(self, '_EXCLUDES'):
for k, v in self._EXCLUDES.items():
value = kwargs.pop(k, None)
if value is not None:
params[k] = 1 if value is True else value

if params:
details_key += '?' + urlencode(sorted(params.items()))
return details_key

def _isChildOf(self, **kwargs):
Expand Down Expand Up @@ -498,7 +506,14 @@ class PlexPartialObject(PlexObject):
'includeRelated': 1,
'includeRelatedCount': 1,
'includeReviews': 1,
'includeStations': 1
'includeStations': 1,
}
_EXCLUDES = {
'excludeElements': (
'Media,Genre,Country,Guid,Rating,Collection,Director,Writer,Role,Producer,Similar,Style,Mood,Format'
),
'excludeFields': 'summary,tagline',
'skipRefresh': 1,
}

def __eq__(self, other):
Expand Down
8 changes: 8 additions & 0 deletions tests/test_video.py
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,14 @@ def test_video_Movie_isFullObject_and_reload(plex):
assert len(movie_via_section_search.roles) >= 3


def test_video_Movie_reload_kwargs(movie):
assert len(movie.media)
assert movie.summary is not None
movie.reload(includeFields=False, **movie._EXCLUDES)
assert movie.__dict__.get('media') == []
assert movie.__dict__.get('summary') is None


def test_video_movie_watched(movie):
movie.markUnplayed()
movie.markPlayed()
Expand Down

0 comments on commit 642ba8b

Please sign in to comment.