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

Merge pull request #307 from andrey-yantsen/fix-docs-in-new-sphinx

Browse source 
fix docs for Raises clauses
This commit is contained in:
Michael Shepanski 2018-10-04 09:32:17 -04:00 committed by GitHub
commit ba0821f348
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 18 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
plexapi/base.py
View file

@ -471,7 +471,7 @@ class Playable(object):
offset, copyts, protocol, mediaIndex, platform. offset, copyts, protocol, mediaIndex, platform.
Raises: Raises:
Unsupported: When the item doesn't support fetching a stream URL. :class:`plexapi.exceptions.Unsupported`: When the item doesn't support fetching a stream URL.
""" """
if self.TYPE not in ('movie', 'episode', 'track'): if self.TYPE not in ('movie', 'episode', 'track'):
raise Unsupported('Fetching stream URL for %s is unsupported.' % self.TYPE) raise Unsupported('Fetching stream URL for %s is unsupported.' % self.TYPE)

9
plexapi/client.py
View file

@ -139,7 +139,7 @@ class PlexClient(PlexObject):
value (bool): Enable or disable proxying (optional, default True). value (bool): Enable or disable proxying (optional, default True).
Raises: Raises:
:class:`~plexapi.exceptions.Unsupported`: Cannot use client proxy with unknown server. :class:`plexapi.exceptions.Unsupported`: Cannot use client proxy with unknown server.
""" """
if server: if server:
self._server = server self._server = server
@ -177,8 +177,7 @@ class PlexClient(PlexObject):
**params (dict): Additional GET parameters to include with the command. **params (dict): Additional GET parameters to include with the command.
Raises: Raises:
:class:`~plexapi.exceptions.Unsupported`: When we detect the client :class:`plexapi.exceptions.Unsupported`: When we detect the client doesn't support this capability.
doesn't support this capability.
""" """
command = command.strip('/') command = command.strip('/')
controller = command.split('/')[0] controller = command.split('/')[0]
@ -272,7 +271,7 @@ class PlexClient(PlexObject):
**params (dict): Additional GET parameters to include with the command. **params (dict): Additional GET parameters to include with the command.
Raises: Raises:
:class:`~plexapi.exceptions.Unsupported`: When no PlexServer specified in this object. :class:`plexapi.exceptions.Unsupported`: When no PlexServer specified in this object.
""" """
if not self._server: if not self._server:
raise Unsupported('A server must be specified before using this command.') raise Unsupported('A server must be specified before using this command.')
@ -440,7 +439,7 @@ class PlexClient(PlexObject):
also: https://github.com/plexinc/plex-media-player/wiki/Remote-control-API#modified-commands also: https://github.com/plexinc/plex-media-player/wiki/Remote-control-API#modified-commands
Raises: Raises:
:class:`~plexapi.exceptions.Unsupported`: When no PlexServer specified in this object. :class:`plexapi.exceptions.Unsupported`: When no PlexServer specified in this object.
""" """
if not self._server: if not self._server:
raise Unsupported('A server must be specified before using this command.') raise Unsupported('A server must be specified before using this command.')

2
plexapi/library.py
View file

@ -443,7 +443,7 @@ class LibrarySection(PlexObject):
**kwargs (dict): Additional kwargs to narrow down the choices. **kwargs (dict): Additional kwargs to narrow down the choices.
Raises: Raises:
:class:`~plexapi.exceptions.BadRequest`: Cannot include kwarg equal to specified category. :class:`plexapi.exceptions.BadRequest`: Cannot include kwarg equal to specified category.
""" """
# TODO: Should this be moved to base? # TODO: Should this be moved to base?
if category in kwargs: if category in kwargs:

10
plexapi/myplex.py
View file

@ -433,8 +433,8 @@ class MyPlexAccount(PlexObject):
:class:`plexapi.sync.SyncItem`: an instance of created syncItem. :class:`plexapi.sync.SyncItem`: an instance of created syncItem.
Raises: Raises:
:class:`plexapi.exceptions.BadRequest` when client with provided clientId wasn`t found. :class:`plexapi.exceptions.BadRequest`: when client with provided clientId wasn`t found.
:class:`plexapi.exceptions.BadRequest` provided client doesn`t provides `sync-target`. :class:`plexapi.exceptions.BadRequest`: provided client doesn`t provides `sync-target`.
""" """
if not client and not clientId: if not client and not clientId:
clientId = X_PLEX_IDENTIFIER clientId = X_PLEX_IDENTIFIER
@ -690,7 +690,7 @@ class MyPlexResource(PlexObject):
HTTP or HTTPS connection. HTTP or HTTPS connection.
Raises: Raises:
:class:`~plexapi.exceptions.NotFound`: When unable to connect to any addresses for this resource. :class:`plexapi.exceptions.NotFound`: When unable to connect to any addresses for this resource.
""" """
# Sort connections from (https, local) to (http, remote) # Sort connections from (https, local) to (http, remote)
# Only check non-local connections unless we own the resource # Only check non-local connections unless we own the resource
@ -797,7 +797,7 @@ class MyPlexDevice(PlexObject):
at least one connection was successful, the PlexClient object is built and returned. at least one connection was successful, the PlexClient object is built and returned.
Raises: Raises:
:class:`~plexapi.exceptions.NotFound`: When unable to connect to any addresses for this device. :class:`plexapi.exceptions.NotFound`: When unable to connect to any addresses for this device.
""" """
cls = PlexServer if 'server' in self.provides else PlexClient cls = PlexServer if 'server' in self.provides else PlexClient
listargs = [[cls, url, self.token, timeout] for url in self.connections] listargs = [[cls, url, self.token, timeout] for url in self.connections]
@ -814,7 +814,7 @@ class MyPlexDevice(PlexObject):
""" Returns an instance of :class:`plexapi.sync.SyncList` for current device. """ Returns an instance of :class:`plexapi.sync.SyncList` for current device.
Raises: Raises:
:class:`plexapi.exceptions.BadRequest` when the device doesn`t provides `sync-target`. :class:`plexapi.exceptions.BadRequest`: when the device doesn`t provides `sync-target`.
""" """
if 'sync-target' not in self.provides: if 'sync-target' not in self.provides:
raise BadRequest('Requested syncList for device which do not provides sync-target') raise BadRequest('Requested syncList for device which do not provides sync-target')

6
plexapi/server.py
View file

@ -232,7 +232,7 @@ class PlexServer(PlexObject):
name (str): Name of the client to return. name (str): Name of the client to return.
Raises: Raises:
:class:`~plexapi.exceptions.NotFound`: Unknown client name :class:`plexapi.exceptions.NotFound`: Unknown client name
""" """
for client in self.clients(): for client in self.clients():
if client and client.title == name: if client and client.title == name:
@ -326,7 +326,7 @@ class PlexServer(PlexObject):
title (str): Title of the playlist to return. title (str): Title of the playlist to return.
Raises: Raises:
:class:`~plexapi.exceptions.NotFound`: Invalid playlist title :class:`plexapi.exceptions.NotFound`: Invalid playlist title
""" """
return self.fetchItem('/playlists', title=title) return self.fetchItem('/playlists', title=title)
@ -393,7 +393,7 @@ class PlexServer(PlexObject):
callback (func): Callback function to call on recieved messages. callback (func): Callback function to call on recieved messages.
raises: raises:
:class:`~plexapi.exception.Unsupported`: Websocket-client not installed. :class:`plexapi.exception.Unsupported`: Websocket-client not installed.
""" """
notifier = AlertListener(self, callback) notifier = AlertListener(self, callback)
notifier.start() notifier.start()

2
plexapi/sync.py
View file

@ -201,7 +201,7 @@ class MediaSettings(object):
videoQuality (int): idx of quality of the video, one of VIDEO_QUALITY_* values defined in this module. videoQuality (int): idx of quality of the video, one of VIDEO_QUALITY_* values defined in this module.
Raises: Raises:
:class:`plexapi.exceptions.BadRequest` when provided unknown video quality. :class:`plexapi.exceptions.BadRequest`: when provided unknown video quality.
""" """
if videoQuality == VIDEO_QUALITY_ORIGINAL: if videoQuality == VIDEO_QUALITY_ORIGINAL:
return MediaSettings('', '', '') return MediaSettings('', '', '')

2
plexapi/utils.py
View file

@ -133,7 +133,7 @@ def searchType(libtype):
libtype (str): LibType to lookup (movie, show, season, episode, artist, album, track, libtype (str): LibType to lookup (movie, show, season, episode, artist, album, track,
collection) collection)
Raises: Raises:
NotFound: Unknown libtype :class:`plexapi.exceptions.NotFound`: Unknown libtype
""" """
libtype = compat.ustr(libtype) libtype = compat.ustr(libtype)
if libtype in [compat.ustr(v) for v in SEARCHTYPES.values()]: if libtype in [compat.ustr(v) for v in SEARCHTYPES.values()]:

4
plexapi/video.py
View file

@ -351,8 +351,8 @@ class Show(Video):
episode (int): Episode number (default:None; required if title not specified). episode (int): Episode number (default:None; required if title not specified).
Raises: Raises:
BadRequest: If season and episode is missing. :class:`plexapi.exceptions.BadRequest`: If season and episode is missing.
NotFound: If the episode is missing. :class:`plexapi.exceptions.NotFound`: If the episode is missing.
""" """
if title: if title:
key = '/library/metadata/%s/allLeaves' % self.ratingKey key = '/library/metadata/%s/allLeaves' % self.ratingKey