Mirrors/python-plexapi
2
0
Fork 0
mirror of https://github.com/pkkid/python-plexapi synced 2024-09-21 06:11:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add misssing docstring

Browse source 
fix comment.
This commit is contained in:
Hellowlol 2020-04-27 00:29:28 +03:00
parent 0647c714a3
commit 1ba8fe77f7
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
plexapi/library.py
View file

@ -534,7 +534,8 @@ class LibrarySection(PlexObject):
key = '/library/sections/%s/%s%s' % (self.key, category, utils.joinArgs(args)) key = '/library/sections/%s/%s%s' % (self.key, category, utils.joinArgs(args))
return self.fetchItems(key, cls=FilterChoice) return self.fetchItems(key, cls=FilterChoice)
def search(self, title=None, sort=None, maxresults=999999, libtype=None, container_size=None, **kwargs): def search(self, title=None, sort=None, maxresults=999999,
libtype=None, container_size=X_PLEX_CONTAINER_SIZE, **kwargs):
""" Search the library. If there are many results, they will be fetched from the server """ Search the library. If there are many results, they will be fetched from the server
in batches of X_PLEX_CONTAINER_SIZE amounts. If you're only looking for the first <num> in batches of X_PLEX_CONTAINER_SIZE amounts. If you're only looking for the first <num>
results, it would be wise to set the maxresults option to that amount so this functions results, it would be wise to set the maxresults option to that amount so this functions
@ -547,6 +548,7 @@ class LibrarySection(PlexObject):
maxresults (int): Only return the specified number of results (optional). maxresults (int): Only return the specified number of results (optional).
libtype (str): Filter results to a spcifiec libtype (movie, show, episode, artist, libtype (str): Filter results to a spcifiec libtype (movie, show, episode, artist,
album, track; optional). album, track; optional).
container_size (int): default X_PLEX_CONTAINER_SIZE in your config file.
**kwargs (dict): Any of the available filters for the current library section. Partial string **kwargs (dict): Any of the available filters for the current library section. Partial string
matches allowed. Multiple matches OR together. Negative filtering also possible, just add an matches allowed. Multiple matches OR together. Negative filtering also possible, just add an
exclamation mark to the end of filter name, e.g. `resolution!=1x1`. exclamation mark to the end of filter name, e.g. `resolution!=1x1`.
@ -582,18 +584,20 @@ class LibrarySection(PlexObject):
results = [] results = []
subresults = [] subresults = []
args['X-Plex-Container-Start'] = 0 args['X-Plex-Container-Start'] = 0
args['X-Plex-Container-Size'] = container_size or X_PLEX_CONTAINER_SIZE args['X-Plex-Container-Size'] = container_size
while True: while True:
key = '/library/sections/%s/all%s' % (self.key, utils.joinArgs(args)) key = '/library/sections/%s/all%s' % (self.key, utils.joinArgs(args))
subresults = self.fetchItems(key) subresults = self.fetchItems(key)
results.extend(subresults) results.extend(subresults)
# this si not set as condition in the while as # self.totalSize is not used as a condition in the while loop as
# this require a additional http request. # this require a additional http request.
# self.totalSize is updated from .fetchItems
if self.totalSize <= len(results): if self.totalSize <= len(results):
break break
args['X-Plex-Container-Start'] += args['X-Plex-Container-Size'] args['X-Plex-Container-Start'] += args['X-Plex-Container-Size']
return results[:maxresults] return results[:maxresults]
def _cleanSearchFilter(self, category, value, libtype=None): def _cleanSearchFilter(self, category, value, libtype=None):