summaryrefslogtreecommitdiff
path: root/opendc/util/exceptions.py
blob: 56a04ab966fecee62e0ae4811e94ab70dd33b4c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class RequestInitializationError(Exception):
    """Raised when a Request cannot successfully be initialized"""

class UnimplementedEndpointError(RequestInitializationError):
    """Raised when a Request path does not point to a module."""

class MissingRequestParameterError(RequestInitializationError):
    """Raised when a Request does not contain one or more required parameters."""

class UnsupportedMethodError(RequestInitializationError):
    """Raised when a Request does not use a supported REST method.
    
    The method must be in all-caps, supported by REST, and implemented by the module.
    """

class AuthorizationTokenError(RequestInitializationError):
    """Raised when an authorization token is not correctly verified."""

class ForeignKeyError(Exception):
    """Raised when a foreign key constraint is not met."""

class RowNotFoundError(Exception):
    """Raised when a database row is not found."""

    def __init__(self, table_name):
        super(RowNotFoundError, self).__init__(
            'Row in `{}` table not found.'.format(table_name)
        )

        self.table_name = table_name

class ParameterError(Exception):
    """Raised when a paramter is either missing or incorrectly typed."""

class IncorrectParameterError(ParameterError):
    """Raised when a parameter is of the wrong type."""

    def __init__(self, parameter_name, parameter_location):
        super(IncorrectParameterError, self).__init__(
            'Incorrectly typed `{}` {} parameter.'.format(
                parameter_name,
                parameter_location
            )
        )

        self.parameter_name = parameter_name
        self.parameter_location = parameter_location

class MissingParameterError(ParameterError):
    """Raised when a parameter is missing."""

    def __init__(self, parameter_name, parameter_location):
        super(MissingParameterError, self).__init__(
            'Missing required `{}` {} parameter.'.format(
                parameter_name,
                parameter_location
            )
        )

        self.parameter_name = parameter_name
        self.parameter_location = parameter_location