from __future__ import annotations
from typing import TYPE_CHECKING, Tuple
from discord.ext.commands import Cooldown
if TYPE_CHECKING:
from .interpreter import Interpreter, Response
__all__: Tuple[str, ...] = (
"TagScriptError",
"WorkloadExceededError",
"ProcessError",
"EmbedParseError",
"BadColourArgument",
"StopError",
"CooldownExceeded",
)
[docs]
class WorkloadExceededError(TagScriptError):
"""Raised when the interpreter goes over its passed character limit."""
[docs]
class ProcessError(TagScriptError):
"""
Raised when an exception occurs during interpreter processing.
Attributes
----------
original: Exception
The original exception that occurred during processing.
response: Response
The incomplete response that was being processed when the exception occurred.
interpreter: Interpreter
The interpreter used for processing.
"""
def __init__(self, error: Exception, response: Response, interpreter: Interpreter) -> None:
self.original: Exception = error
self.response: Response = response
self.interpreter: Interpreter = interpreter
super().__init__(error)
[docs]
class EmbedParseError(TagScriptError):
"""Raised if an exception occurs while attempting to parse an embed."""
[docs]
class BadColourArgument(EmbedParseError):
"""
Raised when the passed input fails to convert to `discord.Colour`.
Attributes
----------
argument: str
The invalid input.
"""
def __init__(self, argument: str) -> None:
self.argument: str = argument
super().__init__(f'Colour "{argument}" is invalid.')
[docs]
class StopError(TagScriptError):
"""
Raised by the StopBlock to stop processing.
Attributes
----------
message: str
The stop error message.
"""
def __init__(self, message: str) -> None:
self.message: str = message
super().__init__(message)
[docs]
class CooldownExceeded(StopError):
"""
Raised by the cooldown block when a cooldown is exceeded.
Attributes
----------
message: str
The cooldown error message.
cooldown: discord.ext.commands.Cooldown
The cooldown bucket with information on the cooldown.
key: str
The cooldown key that reached its cooldown.
retry_after: float
The seconds left til the cooldown ends.
"""
def __init__(self, message: str, cooldown: Cooldown, key: str, retry_after: float) -> None:
self.cooldown: Cooldown = cooldown
self.key: str = key
self.retry_after: float = retry_after
super().__init__(message)