diaspy/errors.py

   1 #!/usr/bin/env python3
   2
   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.
   6
   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:
   9
  10         # this line imports all errors
  11         from diaspy.errors import *
  12
  13         try:
  14                 # your code...
  15         except DiaspyError as e:
  16                 # your error handling code...
  17         finally:
  18                 # closing code...
  19 """
  20
  21 import warnings
  22
  23
  24 class DiaspyError(Exception):
  25         """Base exception for all errors
  26         raised by diaspy.
  27         """
  28         pass
  29
  30
  31 class LoginError(DiaspyError):
  32         """Exception raised when something
  33         bad happens while performing actions
  34         related to logging in.
  35         """
  36         pass
  37
  38
  39 class TokenError(DiaspyError):
  40         pass
  41
  42 class CSRFProtectionKickedIn(TokenError):
  43         pass
  44
  45
  46 class DataError(DiaspyError):
  47         pass
  48
  49
  50 class InvalidDataError(DataError):
  51         pass
  52
  53
  54 class KeyMissingFromFetchedData(InvalidDataError):
  55         pass
  56
  57
  58 class UserError(DiaspyError):
  59         """Exception raised when something related to users goes wrong.
  60         """
  61         pass
  62
  63
  64 class InvalidHandleError(DiaspyError):
  65         """Raised when invalid handle is found.
  66         """
  67         pass
  68
  69
  70 class SearchError(DiaspyError):
  71         """Exception raised when something related to search goes wrong.
  72         """
  73         pass
  74
  75 class NotificationError(DiaspyError):
  76         """Exception raised when something related to notifications goes wrong.
  77         """
  78         pass
  79
  80 class ConversationError(DiaspyError):
  81         """Exception raised when something related to conversations goes wrong.
  82         """
  83         pass
  84
  85
  86 class AspectError(DiaspyError):
  87         """Exception raised when something related to aspects goes wrong.
  88         """
  89         pass
  90
  91 class UserIsNotMemberOfAspect(AspectError):
  92         pass
  93
  94
  95 class PostError(DiaspyError):
  96         """Exception raised when something related to posts goes wrong.
  97         """
  98         pass
  99
 100
 101 class StreamError(DiaspyError):
 102         """Exception raised when something related to streams goes wrong.
 103         """
 104         pass
 105
 106
 107 class SettingsError(DiaspyError):
 108         """Exception raised when something related to settings goes wrong.
 109         """
 110         pass
 111
 112 class SearchError(DiaspyError):
 113         """Exception raised when something related to searching goes wrong.
 114         """
 115         pass
 116
 117 class TagError(DiaspyError):
 118         """Exception raised when something related to a tag goes wrong.
 119         """
 120         pass
 121
 122 def react(r, message='', accepted=[200, 201, 202, 203, 204, 205, 206], exception=DiaspyError):
 123         """This method tries to decide how to react
 124         to a response code passed to it. If it's an
 125         error code it will raise an exception (it will
 126         call `throw()` method.
 127
 128         If response code is not accepted AND cannot
 129         be matched to any exception, generic exception
 130         (DiaspyError) is raised (provided that `exception`
 131         param was left untouched).
 132
 133         By default `accepted` param contains all HTTP
 134         success codes.
 135
 136         User can force type of exception to raise by passing
 137         `exception` param.
 138
 139         :param r: response code
 140         :type r: int
 141         :param message: message for the exception
 142         :type message: str
 143         :param accepted: list of accepted error codes
 144         :type accepted: list
 145         :param exception: preferred exception to raise
 146         :type exception: valid exception type (default: DiaspyError)
 147         """
 148         warnings.warn(DeprecationWarning)
 149         if r in accepted: e = None
 150         else: e = DiaspyError
 151
 152         if e is not None: e = exception
 153         throw(e, message=message)
 154
 155
 156 def throw(e, message=''):
 157         """This function throws an error with given message.
 158         If None is passed as `e` throw() will not raise
 159         anything.
 160
 161         :param e: exception to throw
 162         :type e: any valid exception type or None
 163         :param message: message for exception
 164         :type message: str
 165         """
 166         warnings.warn(DeprecationWarning)
 167         if e is None: pass
 168         else: raise e(message)