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

docstrings and better handling

Browse source 
added docstring and better handling of the parameters.
This commit is contained in:
blacktwin 2019-07-25 15:20:27 -04:00 committed by GitHub
parent 02026cc65b
commit b201df061c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
plexapi/library.py
View file

@ -1008,18 +1008,47 @@ class Collections(PlexObject):
part = '/library/metadata/%s' % self.ratingKey part = '/library/metadata/%s' % self.ratingKey
return self._server.query(part, method=self._server._session.delete) return self._server.query(part, method=self._server._session.delete)
def modeUpdate(self, mode=['default', 'hide', 'hideItems', 'showItems']): def modeUpdate(self, mode=None):
""" Update Collection Mode
Parameters:
mode: default (Library default)
hide (Hide Collection)
hideItems (Hide Items in this Collection)
showItems (Show this Collection and its Items)
Example:
colleciton = 'plexapi.library.Collections'
collection.updateMode(mode="hide")
"""
mode_dict = {'default': '-2', mode_dict = {'default': '-2',
'hide': '0', 'hide': '0',
'hideItems': '1', 'hideItems': '1',
'showItems': '2'} 'showItems': '2'}
part = '/library/metadata/%s/prefs?collectionMode=%s' % (self.ratingKey, mode_dict[mode]) key = mode_dict.get(mode)
if mode is None:
raise BadRequest('Unknown collection mode : %s. Options %s' % (mode, mode_dict.key()))
part = '/library/metadata/%s/prefs?collectionMode=%s' % (self.ratingKey, key)
return self._server.query(part, method=self._server._session.put) return self._server.query(part, method=self._server._session.put)
def sortUpdate(self, sort=['release', 'alpha']): def sortUpdate(self, sort=None):
""" Update Collection Sorting
Parameters:
mode: realease (Order Collection by realease dates)
alpha (Order Collection Alphabetically)
Example:
colleciton = 'plexapi.library.Collections'
collection.updateSort(mode="alpha")
"""
sort_dict = {'release': '0', sort_dict = {'release': '0',
'alpha': '1'} 'alpha': '1'}
part = '/library/metadata/%s/prefs?collectionSort=%s' % (self.ratingKey, sort_dict[sort]) key = sort_dict.get(sort)
if key is None:
raise BadRequest('Unknown sort dir: %s. Options: %s' % (sort, sort_dict.keys()))
part = '/library/metadata/%s/prefs?collectionSort=%s' % (self.ratingKey, key)
return self._server.query(part, method=self._server._session.put) return self._server.query(part, method=self._server._session.put)
# def edit(self, **kwargs): # def edit(self, **kwargs):