@ -100,6 +100,7 @@ __all__ = (
' MissingRequiredFlag ' , ' MissingRequiredFlag ' ,
) )
class CommandError ( DiscordException ) : class CommandError ( DiscordException ) :
r """ The base exception type for all command related errors. r """ The base exception type for all command related errors.
@ -109,6 +110,7 @@ class CommandError(DiscordException):
in a special way as they are caught and passed into a special event in a special way as they are caught and passed into a special event
from : class : ` . Bot ` \, : func : ` . on_command_error ` . from : class : ` . Bot ` \, : func : ` . on_command_error ` .
""" """
def __init__ ( self , message : Optional [ str ] = None , * args : Any ) - > None : def __init__ ( self , message : Optional [ str ] = None , * args : Any ) - > None :
if message is not None : if message is not None :
# clean-up @everyone and @here mentions # clean-up @everyone and @here mentions
@ -117,6 +119,7 @@ class CommandError(DiscordException):
else : else :
super ( ) . __init__ ( * args ) super ( ) . __init__ ( * args )
class ConversionError ( CommandError ) : class ConversionError ( CommandError ) :
""" Exception raised when a Converter class raises non-CommandError. """ Exception raised when a Converter class raises non-CommandError.
@ -130,18 +133,22 @@ class ConversionError(CommandError):
The original exception that was raised . You can also get this via The original exception that was raised . You can also get this via
the ` ` __cause__ ` ` attribute . the ` ` __cause__ ` ` attribute .
""" """
def __init__ ( self , converter : Converter , original : Exception ) - > None : def __init__ ( self , converter : Converter , original : Exception ) - > None :
self . converter : Converter = converter self . converter : Converter = converter
self . original : Exception = original self . original : Exception = original
class UserInputError ( CommandError ) : class UserInputError ( CommandError ) :
""" The base exception type for errors that involve errors """ The base exception type for errors that involve errors
regarding user input . regarding user input .
This inherits from : exc : ` CommandError ` . This inherits from : exc : ` CommandError ` .
""" """
pass pass
class CommandNotFound ( CommandError ) : class CommandNotFound ( CommandError ) :
""" Exception raised when a command is attempted to be invoked """ Exception raised when a command is attempted to be invoked
but no command under that name is found . but no command under that name is found .
@ -151,8 +158,10 @@ class CommandNotFound(CommandError):
This inherits from : exc : ` CommandError ` . This inherits from : exc : ` CommandError ` .
""" """
pass pass
class MissingRequiredArgument ( UserInputError ) : class MissingRequiredArgument ( UserInputError ) :
""" Exception raised when parsing a command and a parameter """ Exception raised when parsing a command and a parameter
that is required is not encountered . that is required is not encountered .
@ -164,33 +173,41 @@ class MissingRequiredArgument(UserInputError):
param : : class : ` inspect . Parameter ` param : : class : ` inspect . Parameter `
The argument that is missing . The argument that is missing .
""" """
def __init__ ( self , param : Parameter ) - > None : def __init__ ( self , param : Parameter ) - > None :
self . param : Parameter = param self . param : Parameter = param
super ( ) . __init__ ( f ' { param . name } is a required argument that is missing. ' ) super ( ) . __init__ ( f ' { param . name } is a required argument that is missing. ' )
class TooManyArguments ( UserInputError ) : class TooManyArguments ( UserInputError ) :
""" Exception raised when the command was passed too many arguments and its """ Exception raised when the command was passed too many arguments and its
: attr : ` . Command . ignore_extra ` attribute was not set to ` ` True ` ` . : attr : ` . Command . ignore_extra ` attribute was not set to ` ` True ` ` .
This inherits from : exc : ` UserInputError ` This inherits from : exc : ` UserInputError `
""" """
pass pass
class BadArgument ( UserInputError ) : class BadArgument ( UserInputError ) :
""" Exception raised when a parsing or conversion failure is encountered """ Exception raised when a parsing or conversion failure is encountered
on an argument to pass into a command . on an argument to pass into a command .
This inherits from : exc : ` UserInputError ` This inherits from : exc : ` UserInputError `
""" """
pass pass
class CheckFailure ( CommandError ) : class CheckFailure ( CommandError ) :
""" Exception raised when the predicates in :attr:`.Command.checks` have failed. """ Exception raised when the predicates in :attr:`.Command.checks` have failed.
This inherits from : exc : ` CommandError ` This inherits from : exc : ` CommandError `
""" """
pass pass
class CheckAnyFailure ( CheckFailure ) : class CheckAnyFailure ( CheckFailure ) :
""" Exception raised when all predicates in :func:`check_any` fail. """ Exception raised when all predicates in :func:`check_any` fail.
@ -211,15 +228,18 @@ class CheckAnyFailure(CheckFailure):
self . errors : List [ Callable [ [ Context ] , bool ] ] = errors self . errors : List [ Callable [ [ Context ] , bool ] ] = errors
super ( ) . __init__ ( ' You do not have permission to run this command. ' ) super ( ) . __init__ ( ' You do not have permission to run this command. ' )
class PrivateMessageOnly ( CheckFailure ) : class PrivateMessageOnly ( CheckFailure ) :
""" Exception raised when an operation does not work outside of private """ Exception raised when an operation does not work outside of private
message contexts . message contexts .
This inherits from : exc : ` CheckFailure ` This inherits from : exc : ` CheckFailure `
""" """
def __init__ ( self , message : Optional [ str ] = None ) - > None : def __init__ ( self , message : Optional [ str ] = None ) - > None :
super ( ) . __init__ ( message or ' This command can only be used in private messages. ' ) super ( ) . __init__ ( message or ' This command can only be used in private messages. ' )
class NoPrivateMessage ( CheckFailure ) : class NoPrivateMessage ( CheckFailure ) :
""" Exception raised when an operation does not work in private message """ Exception raised when an operation does not work in private message
contexts . contexts .
@ -230,13 +250,16 @@ class NoPrivateMessage(CheckFailure):
def __init__ ( self , message : Optional [ str ] = None ) - > None : def __init__ ( self , message : Optional [ str ] = None ) - > None :
super ( ) . __init__ ( message or ' This command cannot be used in private messages. ' ) super ( ) . __init__ ( message or ' This command cannot be used in private messages. ' )
class NotOwner ( CheckFailure ) : class NotOwner ( CheckFailure ) :
""" Exception raised when the message author is not the owner of the bot. """ Exception raised when the message author is not the owner of the bot.
This inherits from : exc : ` CheckFailure ` This inherits from : exc : ` CheckFailure `
""" """
pass pass
class ObjectNotFound ( BadArgument ) : class ObjectNotFound ( BadArgument ) :
""" Exception raised when the argument provided did not match the format """ Exception raised when the argument provided did not match the format
of an ID or a mention . of an ID or a mention .
@ -250,10 +273,12 @@ class ObjectNotFound(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The argument supplied by the caller that was not matched The argument supplied by the caller that was not matched
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' { argument !r} does not follow a valid ID or mention format. ' ) super ( ) . __init__ ( f ' { argument !r} does not follow a valid ID or mention format. ' )
class MemberNotFound ( BadArgument ) : class MemberNotFound ( BadArgument ) :
""" Exception raised when the member provided was not found in the bot ' s """ Exception raised when the member provided was not found in the bot ' s
cache . cache .
@ -267,10 +292,12 @@ class MemberNotFound(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The member supplied by the caller that was not found The member supplied by the caller that was not found
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' Member " { argument } " not found. ' ) super ( ) . __init__ ( f ' Member " { argument } " not found. ' )
class GuildNotFound ( BadArgument ) : class GuildNotFound ( BadArgument ) :
""" Exception raised when the guild provided was not found in the bot ' s cache. """ Exception raised when the guild provided was not found in the bot ' s cache.
@ -283,10 +310,12 @@ class GuildNotFound(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The guild supplied by the called that was not found The guild supplied by the called that was not found
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' Guild " { argument } " not found. ' ) super ( ) . __init__ ( f ' Guild " { argument } " not found. ' )
class UserNotFound ( BadArgument ) : class UserNotFound ( BadArgument ) :
""" Exception raised when the user provided was not found in the bot ' s """ Exception raised when the user provided was not found in the bot ' s
cache . cache .
@ -300,10 +329,12 @@ class UserNotFound(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The user supplied by the caller that was not found The user supplied by the caller that was not found
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' User " { argument } " not found. ' ) super ( ) . __init__ ( f ' User " { argument } " not found. ' )
class MessageNotFound ( BadArgument ) : class MessageNotFound ( BadArgument ) :
""" Exception raised when the message provided was not found in the channel. """ Exception raised when the message provided was not found in the channel.
@ -316,10 +347,12 @@ class MessageNotFound(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The message supplied by the caller that was not found The message supplied by the caller that was not found
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' Message " { argument } " not found. ' ) super ( ) . __init__ ( f ' Message " { argument } " not found. ' )
class ChannelNotReadable ( BadArgument ) : class ChannelNotReadable ( BadArgument ) :
""" Exception raised when the bot does not have permission to read messages """ Exception raised when the bot does not have permission to read messages
in the channel . in the channel .
@ -333,10 +366,12 @@ class ChannelNotReadable(BadArgument):
argument : Union [ : class : ` . abc . GuildChannel ` , : class : ` . Thread ` ] argument : Union [ : class : ` . abc . GuildChannel ` , : class : ` . Thread ` ]
The channel supplied by the caller that was not readable The channel supplied by the caller that was not readable
""" """
def __init__ ( self , argument : Union [ GuildChannel , Thread ] ) - > None : def __init__ ( self , argument : Union [ GuildChannel , Thread ] ) - > None :
self . argument : Union [ GuildChannel , Thread ] = argument self . argument : Union [ GuildChannel , Thread ] = argument
super ( ) . __init__ ( f " Can ' t read messages in { argument . mention } . " ) super ( ) . __init__ ( f " Can ' t read messages in { argument . mention } . " )
class ChannelNotFound ( BadArgument ) : class ChannelNotFound ( BadArgument ) :
""" Exception raised when the bot can not find the channel. """ Exception raised when the bot can not find the channel.
@ -349,10 +384,12 @@ class ChannelNotFound(BadArgument):
argument : Union [ : class : ` int ` , : class : ` str ` ] argument : Union [ : class : ` int ` , : class : ` str ` ]
The channel supplied by the caller that was not found The channel supplied by the caller that was not found
""" """
def __init__ ( self , argument : Union [ int , str ] ) - > None : def __init__ ( self , argument : Union [ int , str ] ) - > None :
self . argument : Union [ int , str ] = argument self . argument : Union [ int , str ] = argument
super ( ) . __init__ ( f ' Channel " { argument } " not found. ' ) super ( ) . __init__ ( f ' Channel " { argument } " not found. ' )
class ThreadNotFound ( BadArgument ) : class ThreadNotFound ( BadArgument ) :
""" Exception raised when the bot can not find the thread. """ Exception raised when the bot can not find the thread.
@ -365,10 +402,12 @@ class ThreadNotFound(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The thread supplied by the caller that was not found The thread supplied by the caller that was not found
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' Thread " { argument } " not found. ' ) super ( ) . __init__ ( f ' Thread " { argument } " not found. ' )
class BadColourArgument ( BadArgument ) : class BadColourArgument ( BadArgument ) :
""" Exception raised when the colour is not valid. """ Exception raised when the colour is not valid.
@ -381,12 +420,15 @@ class BadColourArgument(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The colour supplied by the caller that was not valid The colour supplied by the caller that was not valid
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' Colour " { argument } " is invalid. ' ) super ( ) . __init__ ( f ' Colour " { argument } " is invalid. ' )
BadColorArgument = BadColourArgument BadColorArgument = BadColourArgument
class RoleNotFound ( BadArgument ) : class RoleNotFound ( BadArgument ) :
""" Exception raised when the bot can not find the role. """ Exception raised when the bot can not find the role.
@ -399,10 +441,12 @@ class RoleNotFound(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The role supplied by the caller that was not found The role supplied by the caller that was not found
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' Role " { argument } " not found. ' ) super ( ) . __init__ ( f ' Role " { argument } " not found. ' )
class BadInviteArgument ( BadArgument ) : class BadInviteArgument ( BadArgument ) :
""" Exception raised when the invite is invalid or expired. """ Exception raised when the invite is invalid or expired.
@ -410,10 +454,12 @@ class BadInviteArgument(BadArgument):
. . versionadded : : 1.5 . . versionadded : : 1.5
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' Invite " { argument } " is invalid or expired. ' ) super ( ) . __init__ ( f ' Invite " { argument } " is invalid or expired. ' )
class EmojiNotFound ( BadArgument ) : class EmojiNotFound ( BadArgument ) :
""" Exception raised when the bot can not find the emoji. """ Exception raised when the bot can not find the emoji.
@ -426,10 +472,12 @@ class EmojiNotFound(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The emoji supplied by the caller that was not found The emoji supplied by the caller that was not found
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' Emoji " { argument } " not found. ' ) super ( ) . __init__ ( f ' Emoji " { argument } " not found. ' )
class PartialEmojiConversionFailure ( BadArgument ) : class PartialEmojiConversionFailure ( BadArgument ) :
""" Exception raised when the emoji provided does not match the correct """ Exception raised when the emoji provided does not match the correct
format . format .
@ -443,10 +491,12 @@ class PartialEmojiConversionFailure(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The emoji supplied by the caller that did not match the regex The emoji supplied by the caller that did not match the regex
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' Couldn \' t convert " { argument } " to PartialEmoji. ' ) super ( ) . __init__ ( f ' Couldn \' t convert " { argument } " to PartialEmoji. ' )
class GuildStickerNotFound ( BadArgument ) : class GuildStickerNotFound ( BadArgument ) :
""" Exception raised when the bot can not find the sticker. """ Exception raised when the bot can not find the sticker.
@ -459,10 +509,12 @@ class GuildStickerNotFound(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The sticker supplied by the caller that was not found The sticker supplied by the caller that was not found
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' Sticker " { argument } " not found. ' ) super ( ) . __init__ ( f ' Sticker " { argument } " not found. ' )
class BadBoolArgument ( BadArgument ) : class BadBoolArgument ( BadArgument ) :
""" Exception raised when a boolean argument was not convertable. """ Exception raised when a boolean argument was not convertable.
@ -475,17 +527,21 @@ class BadBoolArgument(BadArgument):
argument : : class : ` str ` argument : : class : ` str `
The boolean argument supplied by the caller that is not in the predefined list The boolean argument supplied by the caller that is not in the predefined list
""" """
def __init__ ( self , argument : str ) - > None : def __init__ ( self , argument : str ) - > None :
self . argument : str = argument self . argument : str = argument
super ( ) . __init__ ( f ' { argument } is not a recognised boolean option ' ) super ( ) . __init__ ( f ' { argument } is not a recognised boolean option ' )
class DisabledCommand ( CommandError ) : class DisabledCommand ( CommandError ) :
""" Exception raised when the command being invoked is disabled. """ Exception raised when the command being invoked is disabled.
This inherits from : exc : ` CommandError ` This inherits from : exc : ` CommandError `
""" """
pass pass
class CommandInvokeError ( CommandError ) : class CommandInvokeError ( CommandError ) :
""" Exception raised when the command being invoked raised an exception. """ Exception raised when the command being invoked raised an exception.
@ -497,10 +553,12 @@ class CommandInvokeError(CommandError):
The original exception that was raised . You can also get this via The original exception that was raised . You can also get this via
the ` ` __cause__ ` ` attribute . the ` ` __cause__ ` ` attribute .
""" """
def __init__ ( self , e : Exception ) - > None : def __init__ ( self , e : Exception ) - > None :
self . original : Exception = e self . original : Exception = e
super ( ) . __init__ ( f ' Command raised an exception: { e . __class__ . __name__ } : { e } ' ) super ( ) . __init__ ( f ' Command raised an exception: { e . __class__ . __name__ } : { e } ' )
class CommandOnCooldown ( CommandError ) : class CommandOnCooldown ( CommandError ) :
""" Exception raised when the command being invoked is on cooldown. """ Exception raised when the command being invoked is on cooldown.
@ -516,12 +574,14 @@ class CommandOnCooldown(CommandError):
retry_after : : class : ` float ` retry_after : : class : ` float `
The amount of seconds to wait before you can retry again . The amount of seconds to wait before you can retry again .
""" """
def __init__ ( self , cooldown : Cooldown , retry_after : float , type : BucketType ) - > None : def __init__ ( self , cooldown : Cooldown , retry_after : float , type : BucketType ) - > None :
self . cooldown : Cooldown = cooldown self . cooldown : Cooldown = cooldown
self . retry_after : float = retry_after self . retry_after : float = retry_after
self . type : BucketType = type self . type : BucketType = type
super ( ) . __init__ ( f ' You are on cooldown. Try again in { retry_after : .2f } s ' ) super ( ) . __init__ ( f ' You are on cooldown. Try again in { retry_after : .2f } s ' )
class MaxConcurrencyReached ( CommandError ) : class MaxConcurrencyReached ( CommandError ) :
""" Exception raised when the command being invoked has reached its maximum concurrency. """ Exception raised when the command being invoked has reached its maximum concurrency.
@ -544,6 +604,7 @@ class MaxConcurrencyReached(CommandError):
fmt = plural % ( number , suffix ) fmt = plural % ( number , suffix )
super ( ) . __init__ ( f ' Too many people are using this command. It can only be used { fmt } concurrently. ' ) super ( ) . __init__ ( f ' Too many people are using this command. It can only be used { fmt } concurrently. ' )
class MissingRole ( CheckFailure ) : class MissingRole ( CheckFailure ) :
""" Exception raised when the command invoker lacks a role to run a command. """ Exception raised when the command invoker lacks a role to run a command.
@ -557,11 +618,13 @@ class MissingRole(CheckFailure):
The required role that is missing . The required role that is missing .
This is the parameter passed to : func : ` ~ . commands . has_role ` . This is the parameter passed to : func : ` ~ . commands . has_role ` .
""" """
def __init__ ( self , missing_role : Snowflake ) - > None : def __init__ ( self , missing_role : Snowflake ) - > None :
self . missing_role : Snowflake = missing_role self . missing_role : Snowflake = missing_role
message = f ' Role { missing_role !r} is required to run this command. ' message = f ' Role { missing_role !r} is required to run this command. '
super ( ) . __init__ ( message ) super ( ) . __init__ ( message )
class BotMissingRole ( CheckFailure ) : class BotMissingRole ( CheckFailure ) :
""" Exception raised when the bot ' s member lacks a role to run a command. """ Exception raised when the bot ' s member lacks a role to run a command.
@ -575,11 +638,13 @@ class BotMissingRole(CheckFailure):
The required role that is missing . The required role that is missing .
This is the parameter passed to : func : ` ~ . commands . has_role ` . This is the parameter passed to : func : ` ~ . commands . has_role ` .
""" """
def __init__ ( self , missing_role : Snowflake ) - > None : def __init__ ( self , missing_role : Snowflake ) - > None :
self . missing_role : Snowflake = missing_role self . missing_role : Snowflake = missing_role
message = f ' Bot requires the role { missing_role !r} to run this command ' message = f ' Bot requires the role { missing_role !r} to run this command '
super ( ) . __init__ ( message ) super ( ) . __init__ ( message )
class MissingAnyRole ( CheckFailure ) : class MissingAnyRole ( CheckFailure ) :
""" Exception raised when the command invoker lacks any of """ Exception raised when the command invoker lacks any of
the roles specified to run a command . the roles specified to run a command .
@ -594,6 +659,7 @@ class MissingAnyRole(CheckFailure):
The roles that the invoker is missing . The roles that the invoker is missing .
These are the parameters passed to : func : ` ~ . commands . has_any_role ` . These are the parameters passed to : func : ` ~ . commands . has_any_role ` .
""" """
def __init__ ( self , missing_roles : SnowflakeList ) - > None : def __init__ ( self , missing_roles : SnowflakeList ) - > None :
self . missing_roles : SnowflakeList = missing_roles self . missing_roles : SnowflakeList = missing_roles
@ -623,6 +689,7 @@ class BotMissingAnyRole(CheckFailure):
These are the parameters passed to : func : ` ~ . commands . has_any_role ` . These are the parameters passed to : func : ` ~ . commands . has_any_role ` .
""" """
def __init__ ( self , missing_roles : SnowflakeList ) - > None : def __init__ ( self , missing_roles : SnowflakeList ) - > None :
self . missing_roles : SnowflakeList = missing_roles self . missing_roles : SnowflakeList = missing_roles
@ -636,6 +703,7 @@ class BotMissingAnyRole(CheckFailure):
message = f " Bot is missing at least one of the required roles: { fmt } " message = f " Bot is missing at least one of the required roles: { fmt } "
super ( ) . __init__ ( message ) super ( ) . __init__ ( message )
class NSFWChannelRequired ( CheckFailure ) : class NSFWChannelRequired ( CheckFailure ) :
""" Exception raised when a channel does not have the required NSFW setting. """ Exception raised when a channel does not have the required NSFW setting.
@ -648,10 +716,12 @@ class NSFWChannelRequired(CheckFailure):
channel : Union [ : class : ` . abc . GuildChannel ` , : class : ` . Thread ` ] channel : Union [ : class : ` . abc . GuildChannel ` , : class : ` . Thread ` ]
The channel that does not have NSFW enabled . The channel that does not have NSFW enabled .
""" """
def __init__ ( self , channel : Union [ GuildChannel , Thread ] ) - > None : def __init__ ( self , channel : Union [ GuildChannel , Thread ] ) - > None :
self . channel : Union [ GuildChannel , Thread ] = channel self . channel : Union [ GuildChannel , Thread ] = channel
super ( ) . __init__ ( f " Channel ' { channel } ' needs to be NSFW for this command to work. " ) super ( ) . __init__ ( f " Channel ' { channel } ' needs to be NSFW for this command to work. " )
class MissingPermissions ( CheckFailure ) : class MissingPermissions ( CheckFailure ) :
""" Exception raised when the command invoker lacks permissions to run a """ Exception raised when the command invoker lacks permissions to run a
command . command .
@ -663,6 +733,7 @@ class MissingPermissions(CheckFailure):
missing_permissions : List [ : class : ` str ` ] missing_permissions : List [ : class : ` str ` ]
The required permissions that are missing . The required permissions that are missing .
""" """
def __init__ ( self , missing_permissions : List [ str ] , * args : Any ) - > None : def __init__ ( self , missing_permissions : List [ str ] , * args : Any ) - > None :
self . missing_permissions : List [ str ] = missing_permissions self . missing_permissions : List [ str ] = missing_permissions
@ -675,6 +746,7 @@ class MissingPermissions(CheckFailure):
message = f ' You are missing { fmt } permission(s) to run this command. ' message = f ' You are missing { fmt } permission(s) to run this command. '
super ( ) . __init__ ( message , * args ) super ( ) . __init__ ( message , * args )
class BotMissingPermissions ( CheckFailure ) : class BotMissingPermissions ( CheckFailure ) :
""" Exception raised when the bot ' s member lacks permissions to run a """ Exception raised when the bot ' s member lacks permissions to run a
command . command .
@ -686,6 +758,7 @@ class BotMissingPermissions(CheckFailure):
missing_permissions : List [ : class : ` str ` ] missing_permissions : List [ : class : ` str ` ]
The required permissions that are missing . The required permissions that are missing .
""" """
def __init__ ( self , missing_permissions : List [ str ] , * args : Any ) - > None : def __init__ ( self , missing_permissions : List [ str ] , * args : Any ) - > None :
self . missing_permissions : List [ str ] = missing_permissions self . missing_permissions : List [ str ] = missing_permissions
@ -698,6 +771,7 @@ class BotMissingPermissions(CheckFailure):
message = f ' Bot requires { fmt } permission(s) to run this command. ' message = f ' Bot requires { fmt } permission(s) to run this command. '
super ( ) . __init__ ( message , * args ) super ( ) . __init__ ( message , * args )
class BadUnionArgument ( UserInputError ) : class BadUnionArgument ( UserInputError ) :
""" Exception raised when a :data:`typing.Union` converter fails for all """ Exception raised when a :data:`typing.Union` converter fails for all
its associated types . its associated types .
@ -713,6 +787,7 @@ class BadUnionArgument(UserInputError):
errors : List [ : class : ` CommandError ` ] errors : List [ : class : ` CommandError ` ]
A list of errors that were caught from failing the conversion . A list of errors that were caught from failing the conversion .
""" """
def __init__ ( self , param : Parameter , converters : Tuple [ Type , . . . ] , errors : List [ CommandError ] ) - > None : def __init__ ( self , param : Parameter , converters : Tuple [ Type , . . . ] , errors : List [ CommandError ] ) - > None :
self . param : Parameter = param self . param : Parameter = param
self . converters : Tuple [ Type , . . . ] = converters self . converters : Tuple [ Type , . . . ] = converters
@ -734,6 +809,7 @@ class BadUnionArgument(UserInputError):
super ( ) . __init__ ( f ' Could not convert " { param . name } " into { fmt } . ' ) super ( ) . __init__ ( f ' Could not convert " { param . name } " into { fmt } . ' )
class BadLiteralArgument ( UserInputError ) : class BadLiteralArgument ( UserInputError ) :
""" Exception raised when a :data:`typing.Literal` converter fails for all """ Exception raised when a :data:`typing.Literal` converter fails for all
its associated values . its associated values .
@ -751,6 +827,7 @@ class BadLiteralArgument(UserInputError):
errors : List [ : class : ` CommandError ` ] errors : List [ : class : ` CommandError ` ]
A list of errors that were caught from failing the conversion . A list of errors that were caught from failing the conversion .
""" """
def __init__ ( self , param : Parameter , literals : Tuple [ Any , . . . ] , errors : List [ CommandError ] ) - > None : def __init__ ( self , param : Parameter , literals : Tuple [ Any , . . . ] , errors : List [ CommandError ] ) - > None :
self . param : Parameter = param self . param : Parameter = param
self . literals : Tuple [ Any , . . . ] = literals self . literals : Tuple [ Any , . . . ] = literals
@ -764,6 +841,7 @@ class BadLiteralArgument(UserInputError):
super ( ) . __init__ ( f ' Could not convert " { param . name } " into the literal { fmt } . ' ) super ( ) . __init__ ( f ' Could not convert " { param . name } " into the literal { fmt } . ' )
class ArgumentParsingError ( UserInputError ) : class ArgumentParsingError ( UserInputError ) :
""" An exception raised when the parser fails to parse a user ' s input. """ An exception raised when the parser fails to parse a user ' s input.
@ -772,8 +850,10 @@ class ArgumentParsingError(UserInputError):
There are child classes that implement more granular parsing errors for There are child classes that implement more granular parsing errors for
i18n purposes . i18n purposes .
""" """
pass pass
class UnexpectedQuoteError ( ArgumentParsingError ) : class UnexpectedQuoteError ( ArgumentParsingError ) :
""" An exception raised when the parser encounters a quote mark inside a non-quoted string. """ An exception raised when the parser encounters a quote mark inside a non-quoted string.
@ -784,10 +864,12 @@ class UnexpectedQuoteError(ArgumentParsingError):
quote : : class : ` str ` quote : : class : ` str `
The quote mark that was found inside the non - quoted string . The quote mark that was found inside the non - quoted string .
""" """
def __init__ ( self , quote : str ) - > None : def __init__ ( self , quote : str ) - > None :
self . quote : str = quote self . quote : str = quote
super ( ) . __init__ ( f ' Unexpected quote mark, { quote !r} , in non-quoted string ' ) super ( ) . __init__ ( f ' Unexpected quote mark, { quote !r} , in non-quoted string ' )
class InvalidEndOfQuotedStringError ( ArgumentParsingError ) : class InvalidEndOfQuotedStringError ( ArgumentParsingError ) :
""" An exception raised when a space is expected after the closing quote in a string """ An exception raised when a space is expected after the closing quote in a string
but a different character is found . but a different character is found .
@ -799,10 +881,12 @@ class InvalidEndOfQuotedStringError(ArgumentParsingError):
char : : class : ` str ` char : : class : ` str `
The character found instead of the expected string . The character found instead of the expected string .
""" """
def __init__ ( self , char : str ) - > None : def __init__ ( self , char : str ) - > None :
self . char : str = char self . char : str = char
super ( ) . __init__ ( f ' Expected space after closing quotation but received { char !r} ' ) super ( ) . __init__ ( f ' Expected space after closing quotation but received { char !r} ' )
class ExpectedClosingQuoteError ( ArgumentParsingError ) : class ExpectedClosingQuoteError ( ArgumentParsingError ) :
""" An exception raised when a quote character is expected but not found. """ An exception raised when a quote character is expected but not found.
@ -818,6 +902,7 @@ class ExpectedClosingQuoteError(ArgumentParsingError):
self . close_quote : str = close_quote self . close_quote : str = close_quote
super ( ) . __init__ ( f ' Expected closing { close_quote } . ' ) super ( ) . __init__ ( f ' Expected closing { close_quote } . ' )
class ExtensionError ( DiscordException ) : class ExtensionError ( DiscordException ) :
""" Base exception for extension related errors. """ Base exception for extension related errors.
@ -828,6 +913,7 @@ class ExtensionError(DiscordException):
name : : class : ` str ` name : : class : ` str `
The extension that had an error . The extension that had an error .
""" """
def __init__ ( self , message : Optional [ str ] = None , * args : Any , name : str ) - > None : def __init__ ( self , message : Optional [ str ] = None , * args : Any , name : str ) - > None :
self . name : str = name self . name : str = name
message = message or f ' Extension { name !r} had an error. ' message = message or f ' Extension { name !r} had an error. '
@ -835,30 +921,37 @@ class ExtensionError(DiscordException):
m = message . replace ( ' @everyone ' , ' @ \u200b everyone ' ) . replace ( ' @here ' , ' @ \u200b here ' ) m = message . replace ( ' @everyone ' , ' @ \u200b everyone ' ) . replace ( ' @here ' , ' @ \u200b here ' )
super ( ) . __init__ ( m , * args ) super ( ) . __init__ ( m , * args )
class ExtensionAlreadyLoaded ( ExtensionError ) : class ExtensionAlreadyLoaded ( ExtensionError ) :
""" An exception raised when an extension has already been loaded. """ An exception raised when an extension has already been loaded.
This inherits from : exc : ` ExtensionError ` This inherits from : exc : ` ExtensionError `
""" """
def __init__ ( self , name : str ) - > None : def __init__ ( self , name : str ) - > None :
super ( ) . __init__ ( f ' Extension { name !r} is already loaded. ' , name = name ) super ( ) . __init__ ( f ' Extension { name !r} is already loaded. ' , name = name )
class ExtensionNotLoaded ( ExtensionError ) : class ExtensionNotLoaded ( ExtensionError ) :
""" An exception raised when an extension was not loaded. """ An exception raised when an extension was not loaded.
This inherits from : exc : ` ExtensionError ` This inherits from : exc : ` ExtensionError `
""" """
def __init__ ( self , name : str ) - > None : def __init__ ( self , name : str ) - > None :
super ( ) . __init__ ( f ' Extension { name !r} has not been loaded. ' , name = name ) super ( ) . __init__ ( f ' Extension { name !r} has not been loaded. ' , name = name )
class NoEntryPointError ( ExtensionError ) : class NoEntryPointError ( ExtensionError ) :
""" An exception raised when an extension does not have a ``setup`` entry point function. """ An exception raised when an extension does not have a ``setup`` entry point function.
This inherits from : exc : ` ExtensionError ` This inherits from : exc : ` ExtensionError `
""" """
def __init__ ( self , name : str ) - > None : def __init__ ( self , name : str ) - > None :
super ( ) . __init__ ( f " Extension { name !r} has no ' setup ' function. " , name = name ) super ( ) . __init__ ( f " Extension { name !r} has no ' setup ' function. " , name = name )
class ExtensionFailed ( ExtensionError ) : class ExtensionFailed ( ExtensionError ) :
""" An exception raised when an extension failed to load during execution of the module or ``setup`` entry point. """ An exception raised when an extension failed to load during execution of the module or ``setup`` entry point.
@ -872,11 +965,13 @@ class ExtensionFailed(ExtensionError):
The original exception that was raised . You can also get this via The original exception that was raised . You can also get this via
the ` ` __cause__ ` ` attribute . the ` ` __cause__ ` ` attribute .
""" """
def __init__ ( self , name : str , original : Exception ) - > None : def __init__ ( self , name : str , original : Exception ) - > None :
self . original : Exception = original self . original : Exception = original
msg = f ' Extension { name !r} raised an error: { original . __class__ . __name__ } : { original } ' msg = f ' Extension { name !r} raised an error: { original . __class__ . __name__ } : { original } '
super ( ) . __init__ ( msg , name = name ) super ( ) . __init__ ( msg , name = name )
class ExtensionNotFound ( ExtensionError ) : class ExtensionNotFound ( ExtensionError ) :
""" An exception raised when an extension is not found. """ An exception raised when an extension is not found.
@ -890,10 +985,12 @@ class ExtensionNotFound(ExtensionError):
name : : class : ` str ` name : : class : ` str `
The extension that had the error . The extension that had the error .
""" """
def __init__ ( self , name : str ) - > None : def __init__ ( self , name : str ) - > None :
msg = f ' Extension { name !r} could not be loaded. ' msg = f ' Extension { name !r} could not be loaded. '
super ( ) . __init__ ( msg , name = name ) super ( ) . __init__ ( msg , name = name )
class CommandRegistrationError ( ClientException ) : class CommandRegistrationError ( ClientException ) :
""" An exception raised when the command can ' t be added """ An exception raised when the command can ' t be added
because the name is already taken by a different command . because the name is already taken by a different command .
@ -909,12 +1006,14 @@ class CommandRegistrationError(ClientException):
alias_conflict : : class : ` bool ` alias_conflict : : class : ` bool `
Whether the name that conflicts is an alias of the command we try to add . Whether the name that conflicts is an alias of the command we try to add .
""" """
def __init__ ( self , name : str , * , alias_conflict : bool = False ) - > None : def __init__ ( self , name : str , * , alias_conflict : bool = False ) - > None :
self . name : str = name self . name : str = name
self . alias_conflict : bool = alias_conflict self . alias_conflict : bool = alias_conflict
type_ = ' alias ' if alias_conflict else ' command ' type_ = ' alias ' if alias_conflict else ' command '
super ( ) . __init__ ( f ' The { type_ } { name } is already an existing command or alias. ' ) super ( ) . __init__ ( f ' The { type_ } { name } is already an existing command or alias. ' )
class FlagError ( BadArgument ) : class FlagError ( BadArgument ) :
""" The base exception type for all flag parsing related errors. """ The base exception type for all flag parsing related errors.
@ -922,8 +1021,10 @@ class FlagError(BadArgument):
. . versionadded : : 2.0 . . versionadded : : 2.0
""" """
pass pass
class TooManyFlags ( FlagError ) : class TooManyFlags ( FlagError ) :
""" An exception raised when a flag has received too many values. """ An exception raised when a flag has received too many values.
@ -938,11 +1039,13 @@ class TooManyFlags(FlagError):
values : List [ : class : ` str ` ] values : List [ : class : ` str ` ]
The values that were passed . The values that were passed .
""" """
def __init__ ( self , flag : Flag , values : List [ str ] ) - > None : def __init__ ( self , flag : Flag , values : List [ str ] ) - > None :
self . flag : Flag = flag self . flag : Flag = flag
self . values : List [ str ] = values self . values : List [ str ] = values
super ( ) . __init__ ( f ' Too many flag values, expected { flag . max_args } but received { len ( values ) } . ' ) super ( ) . __init__ ( f ' Too many flag values, expected { flag . max_args } but received { len ( values ) } . ' )
class BadFlagArgument ( FlagError ) : class BadFlagArgument ( FlagError ) :
""" An exception raised when a flag failed to convert a value. """ An exception raised when a flag failed to convert a value.
@ -955,6 +1058,7 @@ class BadFlagArgument(FlagError):
flag : : class : ` ~ discord . ext . commands . Flag ` flag : : class : ` ~ discord . ext . commands . Flag `
The flag that failed to convert . The flag that failed to convert .
""" """
def __init__ ( self , flag : Flag ) - > None : def __init__ ( self , flag : Flag ) - > None :
self . flag : Flag = flag self . flag : Flag = flag
try : try :
@ -964,6 +1068,7 @@ class BadFlagArgument(FlagError):
super ( ) . __init__ ( f ' Could not convert to { name !r} for flag { flag . name !r} ' ) super ( ) . __init__ ( f ' Could not convert to { name !r} for flag { flag . name !r} ' )
class MissingRequiredFlag ( FlagError ) : class MissingRequiredFlag ( FlagError ) :
""" An exception raised when a required flag was not given. """ An exception raised when a required flag was not given.
@ -976,10 +1081,12 @@ class MissingRequiredFlag(FlagError):
flag : : class : ` ~ discord . ext . commands . Flag ` flag : : class : ` ~ discord . ext . commands . Flag `
The required flag that was not found . The required flag that was not found .
""" """
def __init__ ( self , flag : Flag ) - > None : def __init__ ( self , flag : Flag ) - > None :
self . flag : Flag = flag self . flag : Flag = flag
super ( ) . __init__ ( f ' Flag { flag . name !r} is required and missing ' ) super ( ) . __init__ ( f ' Flag { flag . name !r} is required and missing ' )
class MissingFlagArgument ( FlagError ) : class MissingFlagArgument ( FlagError ) :
""" An exception raised when a flag did not get a value. """ An exception raised when a flag did not get a value.
@ -992,6 +1099,7 @@ class MissingFlagArgument(FlagError):
flag : : class : ` ~ discord . ext . commands . Flag ` flag : : class : ` ~ discord . ext . commands . Flag `
The flag that did not get a value . The flag that did not get a value .
""" """
def __init__ ( self , flag : Flag ) - > None : def __init__ ( self , flag : Flag ) - > None :
self . flag : Flag = flag self . flag : Flag = flag
super ( ) . __init__ ( f ' Flag { flag . name !r} does not have an argument ' ) super ( ) . __init__ ( f ' Flag { flag . name !r} does not have an argument ' )
Rapptz
3 years ago