Skip to content

exceptions

😸 Cheshire-Cat API

Production ready AI assistant framework

The version of the OpenAPI document: 1.3.1 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

ApiAttributeError

Bases: OpenApiException, AttributeError

Source code in cheshire_cat_api/exceptions.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
class ApiAttributeError(OpenApiException, AttributeError):
    def __init__(self, msg, path_to_item=None) -> None:
        """
        Raised when an attribute reference or assignment fails.

        Args:
            msg (str): the exception message

        Keyword Args:
            path_to_item (None/list) the path to the exception in the
                received_data dict
        """
        self.path_to_item = path_to_item
        full_msg = msg
        if path_to_item:
            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
        super(ApiAttributeError, self).__init__(full_msg)

__init__(msg, path_to_item=None)

Raised when an attribute reference or assignment fails.

Args: msg (str): the exception message

Keyword Args: path_to_item (None/list) the path to the exception in the received_data dict

Source code in cheshire_cat_api/exceptions.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def __init__(self, msg, path_to_item=None) -> None:
    """
    Raised when an attribute reference or assignment fails.

    Args:
        msg (str): the exception message

    Keyword Args:
        path_to_item (None/list) the path to the exception in the
            received_data dict
    """
    self.path_to_item = path_to_item
    full_msg = msg
    if path_to_item:
        full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
    super(ApiAttributeError, self).__init__(full_msg)

ApiException

Bases: OpenApiException

Source code in cheshire_cat_api/exceptions.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
class ApiException(OpenApiException):

    def __init__(self, status=None, reason=None, http_resp=None) -> None:
        if http_resp:
            self.status = http_resp.status
            self.reason = http_resp.reason
            self.body = http_resp.data.decode('utf-8')
            self.headers = http_resp.getheaders()
        else:
            self.status = status
            self.reason = reason
            self.body = None
            self.headers = None

    def __str__(self):
        """Custom error messages for exception"""
        error_message = "({0})\n"\
                        "Reason: {1}\n".format(self.status, self.reason)
        if self.headers:
            error_message += "HTTP response headers: {0}\n".format(
                self.headers)

        if self.body:
            error_message += "HTTP response body: {0}\n".format(self.body)

        return error_message

__str__()

Custom error messages for exception

Source code in cheshire_cat_api/exceptions.py 
116
117
118
119
120
121
122
123
124
125
126
127
def __str__(self):
    """Custom error messages for exception"""
    error_message = "({0})\n"\
                    "Reason: {1}\n".format(self.status, self.reason)
    if self.headers:
        error_message += "HTTP response headers: {0}\n".format(
            self.headers)

    if self.body:
        error_message += "HTTP response body: {0}\n".format(self.body)

    return error_message

ApiKeyError

Bases: OpenApiException, KeyError

Source code in cheshire_cat_api/exceptions.py 
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
class ApiKeyError(OpenApiException, KeyError):
    def __init__(self, msg, path_to_item=None) -> None:
        """
        Args:
            msg (str): the exception message

        Keyword Args:
            path_to_item (None/list) the path to the exception in the
                received_data dict
        """
        self.path_to_item = path_to_item
        full_msg = msg
        if path_to_item:
            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
        super(ApiKeyError, self).__init__(full_msg)

__init__(msg, path_to_item=None)

Args: msg (str): the exception message

Keyword Args: path_to_item (None/list) the path to the exception in the received_data dict

Source code in cheshire_cat_api/exceptions.py 
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def __init__(self, msg, path_to_item=None) -> None:
    """
    Args:
        msg (str): the exception message

    Keyword Args:
        path_to_item (None/list) the path to the exception in the
            received_data dict
    """
    self.path_to_item = path_to_item
    full_msg = msg
    if path_to_item:
        full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
    super(ApiKeyError, self).__init__(full_msg)

ApiTypeError

Bases: OpenApiException, TypeError

Source code in cheshire_cat_api/exceptions.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class ApiTypeError(OpenApiException, TypeError):
    def __init__(self, msg, path_to_item=None, valid_classes=None,
                 key_type=None) -> None:
        """ Raises an exception for TypeErrors

        Args:
            msg (str): the exception message

        Keyword Args:
            path_to_item (list): a list of keys an indices to get to the
                                 current_item
                                 None if unset
            valid_classes (tuple): the primitive classes that current item
                                   should be an instance of
                                   None if unset
            key_type (bool): False if our value is a value in a dict
                             True if it is a key in a dict
                             False if our item is an item in a list
                             None if unset
        """
        self.path_to_item = path_to_item
        self.valid_classes = valid_classes
        self.key_type = key_type
        full_msg = msg
        if path_to_item:
            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
        super(ApiTypeError, self).__init__(full_msg)

__init__(msg, path_to_item=None, valid_classes=None, key_type=None)

Raises an exception for TypeErrors

Args: msg (str): the exception message

Keyword Args: path_to_item (list): a list of keys an indices to get to the current_item None if unset valid_classes (tuple): the primitive classes that current item should be an instance of None if unset key_type (bool): False if our value is a value in a dict True if it is a key in a dict False if our item is an item in a list None if unset

Source code in cheshire_cat_api/exceptions.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def __init__(self, msg, path_to_item=None, valid_classes=None,
             key_type=None) -> None:
    """ Raises an exception for TypeErrors

    Args:
        msg (str): the exception message

    Keyword Args:
        path_to_item (list): a list of keys an indices to get to the
                             current_item
                             None if unset
        valid_classes (tuple): the primitive classes that current item
                               should be an instance of
                               None if unset
        key_type (bool): False if our value is a value in a dict
                         True if it is a key in a dict
                         False if our item is an item in a list
                         None if unset
    """
    self.path_to_item = path_to_item
    self.valid_classes = valid_classes
    self.key_type = key_type
    full_msg = msg
    if path_to_item:
        full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
    super(ApiTypeError, self).__init__(full_msg)

ApiValueError

Bases: OpenApiException, ValueError

Source code in cheshire_cat_api/exceptions.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
class ApiValueError(OpenApiException, ValueError):
    def __init__(self, msg, path_to_item=None) -> None:
        """
        Args:
            msg (str): the exception message

        Keyword Args:
            path_to_item (list) the path to the exception in the
                received_data dict. None if unset
        """

        self.path_to_item = path_to_item
        full_msg = msg
        if path_to_item:
            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
        super(ApiValueError, self).__init__(full_msg)

__init__(msg, path_to_item=None)

Args: msg (str): the exception message

Keyword Args: path_to_item (list) the path to the exception in the received_data dict. None if unset

Source code in cheshire_cat_api/exceptions.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def __init__(self, msg, path_to_item=None) -> None:
    """
    Args:
        msg (str): the exception message

    Keyword Args:
        path_to_item (list) the path to the exception in the
            received_data dict. None if unset
    """

    self.path_to_item = path_to_item
    full_msg = msg
    if path_to_item:
        full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
    super(ApiValueError, self).__init__(full_msg)

OpenApiException

Bases: Exception

The base exception class for all OpenAPIExceptions

Source code in cheshire_cat_api/exceptions.py 
15
16
class OpenApiException(Exception):
    """The base exception class for all OpenAPIExceptions"""

render_path(path_to_item)

Returns a string representation of a path

Source code in cheshire_cat_api/exceptions.py 
158
159
160
161
162
163
164
165
166
def render_path(path_to_item):
    """Returns a string representation of a path"""
    result = ""
    for pth in path_to_item:
        if isinstance(pth, int):
            result += "[{0}]".format(pth)
        else:
            result += "['{0}']".format(pth)
    return result