926330d372
Previously, if an AttributeError was raised in a plugin's make_client
method, the plugin simply wouldn't be an attribute of the ClientManager,
producing tracebacks like
Traceback (most recent call last):
File ".../openstackclient/shell.py", line 118, in run
ret_val = super(OpenStackShell, self).run(argv)
...
File ".../openstackclient/object/v1/container.py", line 150, in take_action
data = self.app.client_manager.object_store.container_list(
File ".../openstackclient/common/clientmanager.py", line 66, in __getattr__
raise AttributeError(name)
AttributeError: object_store
This made writing minimal third-party auth plugins difficult, as it
obliterated the original AttributeError.
Now, AttributeErrors that are raised during plugin initialization will
be re-raised as PluginAttributeErrors, and the original traceback will
be preserved. This gives much more useful information to plugin
developers, as in
Traceback (most recent call last):
File ".../openstackclient/shell.py", line 118, in run
ret_val = super(OpenStackShell, self).run(argv)
...
File ".../openstackclient/object/v1/container.py", line 150, in take_action
data = self.app.client_manager.object_store.container_list(
File ".../openstackclient/common/clientmanager.py", line 57, in __get__
err_val, err_tb)
File ".../openstackclient/common/clientmanager.py", line 51, in __get__
self._handle = self.factory(instance)
File ".../openstackclient/object/client.py", line 35, in make_client
interface=instance._interface,
File ".../openstackclient/common/clientmanager.py", line 258,
in get_endpoint_for_service_type
endpoint = self.auth_ref.service_catalog.url_for(
PluginAttributeError: 'NoneType' object has no attribute 'url_for'
Change-Id: I0eee7eba6eccc6d471a699a381185c4e76da10bd
118 lines
3.0 KiB
Python
118 lines
3.0 KiB
Python
# Copyright 2012-2013 OpenStack, LLC.
|
|
#
|
|
# 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 ClientException(Exception):
|
|
"""The base exception class for all exceptions this library raises."""
|
|
|
|
def __init__(self, code, message=None, details=None):
|
|
self.code = code
|
|
self.message = message or self.__class__.message
|
|
self.details = details
|
|
|
|
def __str__(self):
|
|
return "%s (HTTP %s)" % (self.message, 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
|
|
])
|