Source code for ironicclient.exc

#    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.

from __future__ import annotations

import requests  # type: ignore[import-untyped]

from ironicclient.common.apiclient import exceptions
from ironicclient.common.apiclient.exceptions import *  # noqa


# NOTE(akurilin): This alias is left here since v.0.1.3 to support backwards
# compatibility.
InvalidEndpoint = exceptions.EndpointException
CommunicationError = exceptions.ConnectionRefused
HTTPBadRequest = exceptions.BadRequest
HTTPInternalServerError = exceptions.InternalServerError
HTTPNotFound = exceptions.NotFound
HTTPServiceUnavailable = exceptions.ServiceUnavailable




class AmbiguousAuthSystem(exceptions.ClientException):
    """Could not obtain token and endpoint using provided credentials."""
    pass



# Alias for backwards compatibility
AmbigiousAuthSystem = AmbiguousAuthSystem




class InvalidAttribute(exceptions.ClientException):
    pass





class StateTransitionFailed(exceptions.ClientException):
    """Failed to reach a requested provision state."""





class StateTransitionTimeout(exceptions.ClientException):
    """Timed out while waiting for a requested provision state."""





def from_response(  # type: ignore[no-redef]
    response: requests.Response,
    message: str | None = None,
    traceback: str | None = None,
    method: str | None = None,
    url: str | None = None,
) -> exceptions.HttpError:
    """Return an HttpError instance based on response from httplib/requests."""

    error_body: dict[str, str] = {}
    if message:
        error_body['message'] = message
    if traceback:
        error_body['details'] = traceback

    if hasattr(response, 'status') and not hasattr(response, 'status_code'):
        # NOTE(akurilin): These modifications around response object give
        # ability to get all necessary information in method `from_response`
        # from common code, which expecting response object from `requests`
        # library instead of object from `httplib/httplib2` library.
        response.status_code = response.status  # type: ignore[attr-defined]
        response.headers = {  # type: ignore[assignment]
            'Content-Type':
            response.getheader(  # type: ignore[attr-defined]
                'content-type', "")}

    if hasattr(response, 'status_code'):
        # NOTE(jiangfei): These modifications allow SessionClient
        # to handle faultstring.
        response.json = (  # type: ignore[method-assign]
            lambda: {  # type: ignore[misc,assignment]
                'error': error_body})

    return exceptions.from_response(
        response, method=method or "", url=url or ""
    )