3 """This module contains custom exceptions that are raised by diaspy.
4 These are not described by DIASPORA* protocol as exceptions that should be
5 raised by API implementations but are specific to this particular implementation.
7 If your program should catch all exceptions raised by diaspy and
8 does not need to handle them specifically you can use following code:
10 # this line imports all errors
11 from diaspy.errors import *
15 except DiaspyError as e:
16 # your error handling code...
24 class DiaspyError(Exception):
25 """Base exception for all errors
31 class LoginError(DiaspyError
):
32 """Exception raised when something
33 bad happens while performing actions
34 related to logging in.
39 class TokenError(DiaspyError
):
43 class DataError(DiaspyError
):
47 class InvalidDataError(DataError
):
51 class KeyMissingFromFetchedData(InvalidDataError
):
55 class UserError(DiaspyError
):
56 """Exception raised when something related to users goes wrong.
61 class InvalidHandleError(DiaspyError
):
62 """Raised when invalid handle is found.
67 class SearchError(DiaspyError
):
68 """Exception raised when something related to search goes wrong.
73 class ConversationError(DiaspyError
):
74 """Exception raised when something related to conversations goes wrong.
79 class AspectError(DiaspyError
):
80 """Exception raised when something related to aspects goes wrong.
84 class UserIsNotMemberOfAspect(AspectError
):
88 class PostError(DiaspyError
):
89 """Exception raised when something related to posts goes wrong.
94 class StreamError(DiaspyError
):
95 """Exception raised when something related to streams goes wrong.
100 class SettingsError(DiaspyError
):
101 """Exception raised when something related to settings goes wrong.
106 def react(r
, message
='', accepted
=[200, 201, 202, 203, 204, 205, 206], exception
=DiaspyError
):
107 """This method tries to decide how to react
108 to a response code passed to it. If it's an
109 error code it will raise an exception (it will
110 call `throw()` method.
112 If response code is not accepted AND cannot
113 be matched to any exception, generic exception
114 (DiaspyError) is raised (provided that `exception`
115 param was left untouched).
117 By default `accepted` param contains all HTTP
120 User can force type of exception to raise by passing
123 :param r: response code
125 :param message: message for the exception
127 :param accepted: list of accepted error codes
129 :param exception: preferred exception to raise
130 :type exception: valid exception type (default: DiaspyError)
132 warnings
.warn(DeprecationWarning)
133 if r
in accepted
: e
= None
134 else: e
= DiaspyError
136 if e
is not None: e
= exception
137 throw(e
, message
=message
)
140 def throw(e
, message
=''):
141 """This function throws an error with given message.
142 If None is passed as `e` throw() will not raise
145 :param e: exception to throw
146 :type e: any valid exception type or None
147 :param message: message for exception
150 warnings
.warn(DeprecationWarning)
152 else: raise e(message
)