pinecone.core.client.exceptions

  1"""
  2    Pinecone API
  3
  4    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
  5
  6    The version of the OpenAPI document: version not set
  7    Contact: support@pinecone.io
  8    Generated by: https://openapi-generator.tech
  9"""
 10
 11
 12from pinecone.core.exceptions import PineconeException
 13
 14
 15class OpenApiException(PineconeException):
 16    """The base exception class for all OpenAPIExceptions"""
 17
 18
 19class ApiTypeError(OpenApiException, TypeError):
 20    def __init__(self, msg, path_to_item=None, valid_classes=None, key_type=None):
 21        """Raises an exception for TypeErrors
 22
 23        Args:
 24            msg (str): the exception message
 25
 26        Keyword Args:
 27            path_to_item (list): a list of keys an indices to get to the
 28                                 current_item
 29                                 None if unset
 30            valid_classes (tuple): the primitive classes that current item
 31                                   should be an instance of
 32                                   None if unset
 33            key_type (bool): False if our value is a value in a dict
 34                             True if it is a key in a dict
 35                             False if our item is an item in a list
 36                             None if unset
 37        """
 38        self.path_to_item = path_to_item
 39        self.valid_classes = valid_classes
 40        self.key_type = key_type
 41        full_msg = msg
 42        if path_to_item:
 43            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
 44        super(ApiTypeError, self).__init__(full_msg)
 45
 46
 47class ApiValueError(OpenApiException, ValueError):
 48    def __init__(self, msg, path_to_item=None):
 49        """
 50        Args:
 51            msg (str): the exception message
 52
 53        Keyword Args:
 54            path_to_item (list) the path to the exception in the
 55                received_data dict. None if unset
 56        """
 57
 58        self.path_to_item = path_to_item
 59        full_msg = msg
 60        if path_to_item:
 61            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
 62        super(ApiValueError, self).__init__(full_msg)
 63
 64
 65class ApiAttributeError(OpenApiException, AttributeError):
 66    def __init__(self, msg, path_to_item=None):
 67        """
 68        Raised when an attribute reference or assignment fails.
 69
 70        Args:
 71            msg (str): the exception message
 72
 73        Keyword Args:
 74            path_to_item (None/list) the path to the exception in the
 75                received_data dict
 76        """
 77        self.path_to_item = path_to_item
 78        full_msg = msg
 79        if path_to_item:
 80            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
 81        super(ApiAttributeError, self).__init__(full_msg)
 82
 83
 84class ApiKeyError(OpenApiException, KeyError):
 85    def __init__(self, msg, path_to_item=None):
 86        """
 87        Args:
 88            msg (str): the exception message
 89
 90        Keyword Args:
 91            path_to_item (None/list) the path to the exception in the
 92                received_data dict
 93        """
 94        self.path_to_item = path_to_item
 95        full_msg = msg
 96        if path_to_item:
 97            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
 98        super(ApiKeyError, self).__init__(full_msg)
 99
100
101class ApiException(OpenApiException):
102    def __init__(self, status=None, reason=None, http_resp=None):
103        if http_resp:
104            self.status = http_resp.status
105            self.reason = http_resp.reason
106            self.body = http_resp.data
107            self.headers = http_resp.getheaders()
108        else:
109            self.status = status
110            self.reason = reason
111            self.body = None
112            self.headers = None
113
114    def __str__(self):
115        """Custom error messages for exception"""
116        error_message = "({0})\n" "Reason: {1}\n".format(self.status, self.reason)
117        if self.headers:
118            error_message += "HTTP response headers: {0}\n".format(self.headers)
119
120        if self.body:
121            error_message += "HTTP response body: {0}\n".format(self.body)
122
123        return error_message
124
125
126class NotFoundException(ApiException):
127    def __init__(self, status=None, reason=None, http_resp=None):
128        super(NotFoundException, self).__init__(status, reason, http_resp)
129
130
131class UnauthorizedException(ApiException):
132    def __init__(self, status=None, reason=None, http_resp=None):
133        super(UnauthorizedException, self).__init__(status, reason, http_resp)
134
135
136class ForbiddenException(ApiException):
137    def __init__(self, status=None, reason=None, http_resp=None):
138        super(ForbiddenException, self).__init__(status, reason, http_resp)
139
140
141class ServiceException(ApiException):
142    def __init__(self, status=None, reason=None, http_resp=None):
143        super(ServiceException, self).__init__(status, reason, http_resp)
144
145
146def render_path(path_to_item):
147    """Returns a string representation of a path"""
148    result = ""
149    for pth in path_to_item:
150        if isinstance(pth, int):
151            result += "[{0}]".format(pth)
152        else:
153            result += "['{0}']".format(pth)
154    return result