Module chatto.errors
Expand source code
# Copyright (c) 2021-2022, Ethan Henderson
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
class ChattoError(Exception):
"""The base exception class for Chatto."""
class HTTPError(ChattoError):
"""Exception thrown when API requests return errors.
## Arguments
* code (`int`):
The status code of the error.
* body (`str`):
The error message.
"""
def __init__(self, code: int, body: str) -> None:
super().__init__(f"{code}: {body}")
self.code = code
"""The status code of the error."""
self.body = body
"""The error message."""
class ChannelNotLive(ChattoError):
"""Exception thrown when the specified channel is not live when the
bot attempts to run."""
class NoSession(ChattoError):
"""Exception thrown when attempting to perform an action that
requires a session, but it has not been made."""
class NoEventQueue(ChattoError):
"""Exception thrown when attempting to perform an action that
requires an event queue, but it has not been made."""
class MissingRequiredInformation(ChattoError):
"""Exception thrown when insufficient information has been provided
to perform the required task."""
class NoSecrets(ChattoError):
"""Exception thrown when attempting to perform an action that
requires OAuth secrets, but they have not been set."""
class NotAuthorised(ChattoError):
"""Exception thrown when attempting to perform an action that
requires OAuth authentication, but it has not been done."""
Classes
class ChannelNotLive (*args, **kwargs)
-
Exception thrown when the specified channel is not live when the bot attempts to run.
Expand source code
class ChannelNotLive(ChattoError): """Exception thrown when the specified channel is not live when the bot attempts to run."""
Ancestors
- ChattoError
- builtins.Exception
- builtins.BaseException
class ChattoError (*args, **kwargs)
-
The base exception class for Chatto.
Expand source code
class ChattoError(Exception): """The base exception class for Chatto."""
Ancestors
- builtins.Exception
- builtins.BaseException
Subclasses
class HTTPError (code: int, body: str)
-
Exception thrown when API requests return errors.
Arguments
- code (
int
): The status code of the error. - body (
str
): The error message.
Expand source code
class HTTPError(ChattoError): """Exception thrown when API requests return errors. ## Arguments * code (`int`): The status code of the error. * body (`str`): The error message. """ def __init__(self, code: int, body: str) -> None: super().__init__(f"{code}: {body}") self.code = code """The status code of the error.""" self.body = body """The error message."""
Ancestors
- ChattoError
- builtins.Exception
- builtins.BaseException
Instance variables
var body
-
The error message.
var code
-
The status code of the error.
- code (
class MissingRequiredInformation (*args, **kwargs)
-
Exception thrown when insufficient information has been provided to perform the required task.
Expand source code
class MissingRequiredInformation(ChattoError): """Exception thrown when insufficient information has been provided to perform the required task."""
Ancestors
- ChattoError
- builtins.Exception
- builtins.BaseException
class NoEventQueue (*args, **kwargs)
-
Exception thrown when attempting to perform an action that requires an event queue, but it has not been made.
Expand source code
class NoEventQueue(ChattoError): """Exception thrown when attempting to perform an action that requires an event queue, but it has not been made."""
Ancestors
- ChattoError
- builtins.Exception
- builtins.BaseException
class NoSecrets (*args, **kwargs)
-
Exception thrown when attempting to perform an action that requires OAuth secrets, but they have not been set.
Expand source code
class NoSecrets(ChattoError): """Exception thrown when attempting to perform an action that requires OAuth secrets, but they have not been set."""
Ancestors
- ChattoError
- builtins.Exception
- builtins.BaseException
class NoSession (*args, **kwargs)
-
Exception thrown when attempting to perform an action that requires a session, but it has not been made.
Expand source code
class NoSession(ChattoError): """Exception thrown when attempting to perform an action that requires a session, but it has not been made."""
Ancestors
- ChattoError
- builtins.Exception
- builtins.BaseException
class NotAuthorised (*args, **kwargs)
-
Exception thrown when attempting to perform an action that requires OAuth authentication, but it has not been done.
Expand source code
class NotAuthorised(ChattoError): """Exception thrown when attempting to perform an action that requires OAuth authentication, but it has not been done."""
Ancestors
- ChattoError
- builtins.Exception
- builtins.BaseException