Skip to content

Errors

Exceptions raised when an error is encountered during API calls.

AccessError

Bases: Exception

A class denoting an exception raised when required permission is not satisfied.

Attributes

required : str The required permission for a path route.

Source code in ravyapi/api/errors.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
class AccessError(Exception):
    """A class denoting an exception raised when required permission is not satisfied.

    Attributes
    ----------
    required : str
        The required permission for a path route.
    """

    __slots__: tuple[str, ...] = ("_required",)

    def __init__(self, required: str) -> None:
        """
        Parameters
        ----------
        required : str
            The permission that was needed.
        """
        super().__init__()
        self._required: str = required

    def __str__(self) -> str:
        return (
            f'Insufficient permissions accessing path route requiring "{self.required}"'
        )

    @property
    def required(self) -> str:
        """The required permission for a path route."""
        return self._required

required: str property

The required permission for a path route.

__init__(required)

Parameters

required : str The permission that was needed.

Source code in ravyapi/api/errors.py 
 95
 96
 97
 98
 99
100
101
102
103
def __init__(self, required: str) -> None:
    """
    Parameters
    ----------
    required : str
        The permission that was needed.
    """
    super().__init__()
    self._required: str = required

BadRequestError

Bases: HTTPError

A class denoting an exception raised when a bad request is made.

Attributes

exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
class BadRequestError(HTTPError):
    """A class denoting an exception raised when a bad request is made.

    Attributes
    ----------
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """

    __slots__: tuple[str, ...] = ("_exc_data",)

    def __init__(self, exc_data: str | dict[str, Any]) -> None:
        """
        Parameters
        ----------
        exc_data : str | dict[str, Any]
            The error data returned by the Ravy API.
        """
        super().__init__(400, exc_data)

__init__(exc_data)

Parameters

exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
127
128
129
130
131
132
133
134
def __init__(self, exc_data: str | dict[str, Any]) -> None:
    """
    Parameters
    ----------
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """
    super().__init__(400, exc_data)

ForbiddenError

Bases: HTTPError

A class denoting an exception raised when a forbidden request is made.

Attributes

exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
class ForbiddenError(HTTPError):
    """A class denoting an exception raised when a forbidden request is made.

    Attributes
    ----------
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """

    __slots__: tuple[str, ...] = ("_exc_data",)

    def __init__(self, exc_data: str | dict[str, Any]) -> None:
        """
        Parameters
        ----------
        exc_data : str | dict[str, Any]
            The error data returned by the Ravy API.
        """
        super().__init__(403, exc_data)

__init__(exc_data)

Parameters

exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
169
170
171
172
173
174
175
176
def __init__(self, exc_data: str | dict[str, Any]) -> None:
    """
    Parameters
    ----------
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """
    super().__init__(403, exc_data)

HTTPError

Bases: Exception

A base class for all HTTP exceptions.

Parameters

status : int The HTTP status code of the response. exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Attributes

status : int The HTTP status code of the response. exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
class HTTPError(Exception):
    """A base class for all HTTP exceptions.

    Parameters
    ----------
    status : int
        The HTTP status code of the response.
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.

    Attributes
    ----------
    status : int
        The HTTP status code of the response.
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """

    __slots__: tuple[str, ...] = ("_status", "_exc_data")

    def __init__(self, status: int, exc_data: str | dict[str, Any]) -> None:
        """
        Parameters
        ----------
        status : int
            The HTTP status code of the response.
        exc_data : str | dict[str, Any]
            The error data returned by the Ravy API.
        """
        super().__init__()
        self._status: int = status
        self._exc_data: str | dict[str, Any] = exc_data

    def __str__(self) -> str:
        if isinstance(self.exc_data, dict):
            return (
                f"({self.status}) {self.exc_data['error']}"
                f" - {self.exc_data['details']}"
            )

        return f"({self.status}) {self.exc_data}"

    @property
    def status(self) -> int:
        """The HTTP status code of the response."""
        return self._status

    @property
    def exc_data(self) -> str | dict[str, Any]:
        """The error data returned by the Ravy API."""
        return self._exc_data

exc_data: str | dict[str, Any] property

The error data returned by the Ravy API.

status: int property

The HTTP status code of the response.

__init__(status, exc_data)

Parameters

status : int The HTTP status code of the response. exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
51
52
53
54
55
56
57
58
59
60
61
62
def __init__(self, status: int, exc_data: str | dict[str, Any]) -> None:
    """
    Parameters
    ----------
    status : int
        The HTTP status code of the response.
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """
    super().__init__()
    self._status: int = status
    self._exc_data: str | dict[str, Any] = exc_data

NotFoundError

Bases: HTTPError

A class denoting an exception raised when a resource is not found.

Attributes

exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
class NotFoundError(HTTPError):
    """A class denoting an exception raised when a resource is not found.

    Attributes
    ----------
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """

    __slots__: tuple[str, ...] = ("_exc_data",)

    def __init__(self, exc_data: str | dict[str, Any]) -> None:
        """
        Parameters
        ----------
        exc_data : str | dict[str, Any]
            The error data returned by the Ravy API.
        """
        super().__init__(404, exc_data)

__init__(exc_data)

Parameters

exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
190
191
192
193
194
195
196
197
def __init__(self, exc_data: str | dict[str, Any]) -> None:
    """
    Parameters
    ----------
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """
    super().__init__(404, exc_data)

TooManyRequestsError

Bases: HTTPError

A class denoting an exception raised when a request is made too frequently.

Attributes

exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
class TooManyRequestsError(HTTPError):
    """A class denoting an exception raised when a request is made too frequently.

    Attributes
    ----------
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """

    __slots__: tuple[str, ...] = ("_exc_data",)

    def __init__(self, exc_data: str | dict[str, Any]) -> None:
        """
        Parameters
        ----------
        exc_data : str | dict[str, Any]
            The error data returned by the Ravy API.
        """
        super().__init__(429, exc_data)

__init__(exc_data)

Parameters

exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
211
212
213
214
215
216
217
218
def __init__(self, exc_data: str | dict[str, Any]) -> None:
    """
    Parameters
    ----------
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """
    super().__init__(429, exc_data)

UnauthorizedError

Bases: HTTPError

A class denoting an exception raised when an unauthorized request is made.

Attributes

exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
class UnauthorizedError(HTTPError):
    """A class denoting an exception raised when an unauthorized request is made.

    Attributes
    ----------
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """

    __slots__: tuple[str, ...] = ("_exc_data",)

    def __init__(self, exc_data: str | dict[str, Any]) -> None:
        """
        Parameters
        ----------
        exc_data : str | dict[str, Any]
            The error data returned by the Ravy API.
        """
        super().__init__(401, exc_data)

__init__(exc_data)

Parameters

exc_data : str | dict[str, Any] The error data returned by the Ravy API.

Source code in ravyapi/api/errors.py 
148
149
150
151
152
153
154
155
def __init__(self, exc_data: str | dict[str, Any]) -> None:
    """
    Parameters
    ----------
    exc_data : str | dict[str, Any]
        The error data returned by the Ravy API.
    """
    super().__init__(401, exc_data)