discord.py - 出现 MissingRequiredArgument 错误时显示正确的命令语法

Question

我已经开始开发一个新的不和谐机器人。目前每当出现错误时，我都会调用on_command_error 函数来发送消息。现在，每当出现 MissingRequiredArgument 错误时，我希望机器人显示错误消息和命令的正确语法。目前我已经尝试手动添加所有这些，但是非常耗时且不值得。我知道 discord.py 可以显示命令语法，因为默认的帮助命令也会这样做。

那么有什么方法可以将相同的逻辑导入到我的代码中？

Answer 1

您可以为此使用一些commands.Command 类属性。
查看文档，这个类有一个usage 属性，您可以使用commands.command 装饰器进行设置。

假设我想做一个圆形命令：

from discord.ext import commands

bot = commands.Bot(command_prefix='!')

# Setting the command's name in the decorator to avoir overwriting the built-in round function
@bot.command(name='round', usage='3.14159265359')
async def _round(ctx, to_round: float):
    number = round(to_round, 1)
    await ctx.send(f'Rounded to one decimal: {number}')

如果我发送!round e，我会收到以下错误：

BadArgument: Converting to "float" failed for parameter "to_round"

但我可以处理它，就像你做的那样，on_command_error：

@bot.event
async def on_command_error(ctx, error):
    if isinstance(error, commands.BadArgument):
        usage = f'{bot.command_prefix}{ctx.command.name} {ctx.command.usage}'
        await ctx.send('Failed converting an argument\nCorrect usage: {usage}')

现在，如果我发送 !round e，机器人会发送：

转换参数失败
正确用法：!round 3.14159265359