OpenStack Compute (Nova) Client
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

261 lines
6.5 KiB

# Copyright 2010 Jacob Kaplan-Moss
# 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
# 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 UnsupportedVersion(Exception):
"""Indicates that the user is trying to use an unsupported
version of the API.
class CommandError(Exception):
class AuthorizationFailure(Exception):
class NoUniqueMatch(Exception):
class AuthSystemNotFound(Exception):
"""When the user specify a AuthSystem but not installed."""
def __init__(self, auth_system):
self.auth_system = auth_system
def __str__(self):
return "AuthSystemNotFound: %s" % repr(self.auth_system)
class NoTokenLookupException(Exception):
"""This form of authentication does not support looking up
endpoints from an existing token.
class EndpointNotFound(Exception):
"""Could not find Service or Region in Service Catalog."""
class AmbiguousEndpoints(Exception):
"""Found more than one matching endpoint in Service Catalog."""
def __init__(self, endpoints=None):
self.endpoints = endpoints
def __str__(self):
return "AmbiguousEndpoints: %s" % repr(self.endpoints)
class ConnectionRefused(Exception):
Connection refused: the server refused the connection.
def __init__(self, response=None):
self.response = response
def __str__(self):
return "ConnectionRefused: %s" % repr(self.response)
class InstanceInErrorState(Exception):
"""Instance is in the error state."""
class ClientException(Exception):
The base exception class for all exceptions this library raises.
message = 'Unknown Error'
def __init__(self, code, message=None, details=None, request_id=None,
url=None, method=None):
self.code = code
self.message = message or self.__class__.message
self.details = details
self.request_id = request_id
self.url = url
self.method = method
def __str__(self):
formatted_string = "%s (HTTP %s)" % (self.message, self.code)
if self.request_id:
formatted_string += " (Request-ID: %s)" % self.request_id
return formatted_string
class RetryAfterException(ClientException):
The base exception class for ClientExceptions that use Retry-After header.
def __init__(self, *args, **kwargs):
self.retry_after = int(kwargs.pop('retry_after'))
except (KeyError, ValueError):
self.retry_after = 0
super(RetryAfterException, self).__init__(*args, **kwargs)
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: your credentials don't give you access to this
http_status = 403
message = "Forbidden"
class NotFound(ClientException):
HTTP 404 - Not found
http_status = 404
message = "Not found"
class MethodNotAllowed(ClientException):
HTTP 405 - Method Not Allowed
http_status = 405
message = "Method Not Allowed"
class Conflict(ClientException):
HTTP 409 - Conflict
http_status = 409
message = "Conflict"
class OverLimit(RetryAfterException):
HTTP 413 - Over limit: you're over the API limits for this time period.
http_status = 413
message = "Over limit"
class RateLimit(RetryAfterException):
HTTP 429 - Rate limit: you've sent too many requests for this time period.
http_status = 429
message = "Rate limit"
# NotImplemented is a python keyword.
class HTTPNotImplemented(ClientException):
HTTP 501 - Not Implemented: the 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:
_error_classes = [BadRequest, Unauthorized, Forbidden, NotFound,
MethodNotAllowed, Conflict, OverLimit, RateLimit,
_code_map = dict((c.http_status, c) for c in _error_classes)
class InvalidUsage(RuntimeError):
"""This function call is invalid in the way you are using this client.
Due to the transition to using keystoneclient some function calls are no
longer available. You should make a similar call to the session object
def from_response(response, body, url, method=None):
Return an instance of an ClientException or subclass
based on an requests response.
resp, body = requests.request(...)
if resp.status_code != 200:
raise exception_from_response(resp, rest.text)
cls = _code_map.get(response.status_code, ClientException)
kwargs = {
'code': response.status_code,
'method': method,
'url': url,
'request_id': None,
if response.headers:
kwargs['request_id'] = response.headers.get('x-compute-request-id')
if (issubclass(cls, RetryAfterException) and
'retry-after' in response.headers):
kwargs['retry_after'] = response.headers.get('retry-after')
if body:
message = "n/a"
details = "n/a"
if hasattr(body, 'keys'):
error = body[list(body)[0]]
message = error.get('message')
details = error.get('details')
kwargs['message'] = message
kwargs['details'] = details
return cls(**kwargs)
class ResourceNotFound(Exception):
"""Error in getting the resource."""