66 lines
2.0 KiB
Python
66 lines
2.0 KiB
Python
# Copyright 2017 Cloudbase Solutions Srl
|
|
#
|
|
# 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.
|
|
|
|
"""HNV client exception handling."""
|
|
|
|
|
|
class HNVException(Exception):
|
|
|
|
"""Base hnv_client exception.
|
|
|
|
To correctly use this class, inherit from it and define
|
|
a `template` property.
|
|
|
|
That `template` will be formated using the keyword arguments
|
|
provided to the constructor.
|
|
|
|
Example:
|
|
::
|
|
class NotFound(HNVException):
|
|
|
|
template = "The %(object)r was not found in %(container)s."
|
|
|
|
raise NotFound(object="subnet_id", container="network_id")
|
|
"""
|
|
|
|
template = "An unknown exception occurred."
|
|
|
|
def __init__(self, message=None, **kwargs):
|
|
message = message or self.template
|
|
|
|
try:
|
|
message = message % kwargs
|
|
except (TypeError, KeyError):
|
|
# Something went wrong during message formatting.
|
|
# Probably kwargs doesn't match a variable in the message.
|
|
message = ("Message: %(template)s. Extra or "
|
|
"missing info: %(kwargs)s" %
|
|
{"template": message, "kwargs": kwargs})
|
|
|
|
super(HNVException, self).__init__(message)
|
|
|
|
|
|
class NotFound(HNVException):
|
|
|
|
"""The required object is not available in container."""
|
|
|
|
template = "The %(object)r was not found in %(container)s."
|
|
|
|
|
|
class NotSupported(HNVException):
|
|
|
|
"""The functionality required is not available in the current context."""
|
|
|
|
template = "%(feature)s is not available in %(context)s."
|