File: exceptions.py

package info (click to toggle)
python-osc-lib 4.2.0-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 820 kB
  • sloc: python: 6,505; makefile: 21; sh: 2
file content (148 lines) | stat: -rw-r--r-- 3,563 bytes parent folder | download
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
#   Copyright 2012-2013 OpenStack Foundation
#
#   Licensed under the Apache License, Version 2.0 (the "License"); you may
#   not use this file except in compliance with the License. You may obtain
#   a copy of the License at
#
#        http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#   License for the specific language governing permissions and limitations
#   under the License.
#

"""Exception definitions."""


class CommandError(Exception):
    pass


class AuthorizationFailure(Exception):
    pass


class PluginAttributeError(Exception):
    """A plugin threw an AttributeError while being lazily loaded."""

    # This *must not* inherit from AttributeError;
    # that would defeat the whole purpose.
    pass


class NoTokenLookupException(Exception):
    """This does not support looking up endpoints from an existing token."""

    pass


class EndpointNotFound(Exception):
    """Could not find Service or Region in Service Catalog."""

    pass


class UnsupportedVersion(Exception):
    """The user is trying to use an unsupported version of the API"""

    pass


class InvalidValue(Exception):
    """An argument value is not valid: wrong type, out of range, etc"""

    message = "Supplied value is not valid"


class ClientException(Exception):
    """The base exception class for all exceptions this library raises."""

    http_status: int
    message: str

    def __init__(
        self,
        code: int | str,
        message: str | None = None,
        details: str | None = None,
    ):
        if not isinstance(code, int) and message is None:
            message = code
            code = self.http_status
        self.code = code
        self.message = message or self.__class__.message
        self.details = details

    def __str__(self) -> str:
        return f"{self.message} (HTTP {self.code})"


class BadRequest(ClientException):
    """HTTP 400 - Bad request: you sent some malformed data."""

    http_status = 400
    message = "Bad request"


class Unauthorized(ClientException):
    """HTTP 401 - Unauthorized: bad credentials."""

    http_status = 401
    message = "Unauthorized"


class Forbidden(ClientException):
    """HTTP 403 - Forbidden: not authorized to access to this resource."""

    http_status = 403
    message = "Forbidden"


class NotFound(ClientException):
    """HTTP 404 - Not found"""

    http_status = 404
    message = "Not found"


class Conflict(ClientException):
    """HTTP 409 - Conflict"""

    http_status = 409
    message = "Conflict"


class OverLimit(ClientException):
    """HTTP 413 - Over limit: reached the API limits for this time period."""

    http_status = 413
    message = "Over limit"


# NotImplemented is a python keyword.
class HTTPNotImplemented(ClientException):
    """HTTP 501 - Not Implemented: server does not support this operation."""

    http_status = 501
    message = "Not Implemented"


# In Python 2.4 Exception is old-style and thus doesn't have a __subclasses__()
# so we can do this:
#     _code_map = dict((c.http_status, c)
#                      for c in ClientException.__subclasses__())
#
# Instead, we have to hardcode it:
_code_map = dict(
    (c.http_status, c)
    for c in [
        BadRequest,
        Unauthorized,
        Forbidden,
        NotFound,
        OverLimit,
        HTTPNotImplemented,
    ]
)