Module mailslurp_client.exceptions
MailSlurp API
MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501
The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech
Functions
def render_path(path_to_item)
-
Returns a string representation of a path
Classes
class ApiException (status=None, reason=None, http_resp=None)
-
The base exception class for all OpenAPIExceptions
Expand source code
class ApiException(OpenApiException): def __init__(self, status=None, reason=None, http_resp=None): if http_resp: self.status = http_resp.status self.reason = http_resp.reason self.body = http_resp.data 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
Ancestors
- OpenApiException
- builtins.Exception
- builtins.BaseException
class ApiKeyError (msg, path_to_item=None)
-
The base exception class for all OpenAPIExceptions
Args
msg
:str
- the exception message
Keyword Args: path_to_item (None/list) the path to the exception in the received_data dict
Expand source code
class ApiKeyError(OpenApiException, KeyError): def __init__(self, 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 """ 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)
Ancestors
- OpenApiException
- builtins.KeyError
- builtins.LookupError
- builtins.Exception
- builtins.BaseException
class ApiTypeError (msg, path_to_item=None, valid_classes=None, key_type=None)
-
The base exception class for all OpenAPIExceptions
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
Expand source code
class ApiTypeError(OpenApiException, TypeError): def __init__(self, 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 """ 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)
Ancestors
- OpenApiException
- builtins.TypeError
- builtins.Exception
- builtins.BaseException
class ApiValueError (msg, path_to_item=None)
-
The base exception class for all OpenAPIExceptions
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
Expand source code
class ApiValueError(OpenApiException, ValueError): def __init__(self, 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 """ 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)
Ancestors
- OpenApiException
- builtins.ValueError
- builtins.Exception
- builtins.BaseException
class OpenApiException (*args, **kwargs)
-
The base exception class for all OpenAPIExceptions
Expand source code
class OpenApiException(Exception): """The base exception class for all OpenAPIExceptions"""
Ancestors
- builtins.Exception
- builtins.BaseException
Subclasses