python-manilaclient/manilaclient/exceptions.py

# Copyright 2010 Jacob Kaplan-Moss
# All Rights Reserved.
#
# 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.
"""

from manilaclient.common._i18n import _
from manilaclient.common.apiclient.exceptions import *  # noqa


class ManilaclientException(Exception):
    """A generic client error."""
    message = _("An unexpected error occured.")

    def __init__(self, message):
        self.message = message or self.message

    def __str__(self):
        return self.message


class ResourceInErrorState(ManilaclientException):
    """A resource is in an unexpected 'error' state."""
    message = _("Resource is in error state")


class TimeoutException(ManilaclientException):
    """A request has timed out"""
    message = _("Request has timed out")


class NoTokenLookupException(ClientException):  # noqa: F405
    """No support for looking up endpoints.

    This form of authentication does not support looking up
    endpoints from an existing token.
    """
    pass


class VersionNotFoundForAPIMethod(Exception):
    msg_fmt = "API version '%(vers)s' is not supported on '%(method)s' method."

    def __init__(self, version, method):
        self.version = version
        self.method = method

    def __str__(self):
        return self.msg_fmt % {"vers": self.version, "method": self.method}