5010e7dc55
This is for exceptions that are inherently based on user errors and not permission based. e.g. passing incorrect number of arguments, too many arguments, or an invalid argument. CommandNotFound is not classified under this since it isn't inherently a user input error in all cases. Some invalid commands can simply be due to an odd bot prefix. It would also diminish the usefulness of the new parent class if CommandNotFound was included.
113 lines
3.8 KiB
Python
113 lines
3.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2015-2016 Rapptz
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a
|
|
copy of this software and associated documentation files (the "Software"),
|
|
to deal in the Software without restriction, including without limitation
|
|
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
and/or sell copies of the Software, and to permit persons to whom the
|
|
Software is furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
DEALINGS IN THE SOFTWARE.
|
|
"""
|
|
|
|
from discord.errors import DiscordException
|
|
|
|
|
|
__all__ = [ 'CommandError', 'MissingRequiredArgument', 'BadArgument',
|
|
'NoPrivateMessage', 'CheckFailure', 'CommandNotFound',
|
|
'DisabledCommand', 'CommandInvokeError', 'TooManyArguments',
|
|
'UserInputError' ]
|
|
|
|
class CommandError(DiscordException):
|
|
"""The base exception type for all command related errors.
|
|
|
|
This inherits from :exc:`discord.DiscordException`.
|
|
|
|
This exception and exceptions derived from it are handled
|
|
in a special way as they are caught and passed into a special event
|
|
from :class:`Bot`\, :func:`on_command_error`.
|
|
"""
|
|
def __init__(self, message=None, *args):
|
|
if message is not None:
|
|
# clean-up @everyone and @here mentions
|
|
m = message.replace('@everyone', '@\u200beveryone').replace('@here', '@\u200bhere')
|
|
super().__init__(m, *args)
|
|
else:
|
|
super().__init__(*args)
|
|
|
|
class UserInputError(CommandError):
|
|
"""The base exception type for errors that involve errors
|
|
regarding user input.
|
|
|
|
This inherits from :exc:`CommandError`.
|
|
"""
|
|
pass
|
|
|
|
class CommandNotFound(CommandError):
|
|
"""Exception raised when a command is attempted to be invoked
|
|
but no command under that name is found.
|
|
|
|
This is not raised for invalid subcommands, rather just the
|
|
initial main command that is attempted to be invoked.
|
|
"""
|
|
pass
|
|
|
|
class MissingRequiredArgument(UserInputError):
|
|
"""Exception raised when parsing a command and a parameter
|
|
that is required is not encountered.
|
|
"""
|
|
pass
|
|
|
|
class TooManyArguments(UserInputError):
|
|
"""Exception raised when the command was passed too many arguments and its
|
|
:attr:`Command.ignore_extra` attribute was not set to ``True``.
|
|
"""
|
|
pass
|
|
|
|
class BadArgument(UserInputError):
|
|
"""Exception raised when a parsing or conversion failure is encountered
|
|
on an argument to pass into a command.
|
|
"""
|
|
pass
|
|
|
|
class NoPrivateMessage(CommandError):
|
|
"""Exception raised when an operation does not work in private message
|
|
contexts.
|
|
"""
|
|
pass
|
|
|
|
class CheckFailure(CommandError):
|
|
"""Exception raised when the predicates in :attr:`Command.checks` have failed."""
|
|
pass
|
|
|
|
class DisabledCommand(CommandError):
|
|
"""Exception raised when the command being invoked is disabled."""
|
|
pass
|
|
|
|
class CommandInvokeError(CommandError):
|
|
"""Exception raised when the command being invoked raised an exception.
|
|
|
|
Attributes
|
|
-----------
|
|
original
|
|
The original exception that was raised. You can also get this via
|
|
the ``__cause__`` attribute.
|
|
"""
|
|
def __init__(self, e):
|
|
self.original = e
|
|
super().__init__('Command raised an exception: {0.__class__.__name__}: {0}'.format(e))
|
|
|