描述
目前 AstrBot 在指令参数缺失时会显示框架默认的错误消息,格式为:
插件 XXX: 必要参数缺失。该指令完整参数: xxx_id(int)
这种提示对用户不够友好,希望能让插件开发者自定义参数缺失时的错误提示,提供更清晰的使用说明。
使用场景
当前情况:
用户: /addcoin
Bot: 插件 RChips: 必要参数缺失。该指令完整参数: coin_num(int)
期望效果:
用户: /addcoin
Bot: 增加Coin使用说明
━━━━━━━━━━━━━━━
格式:/addcoin <coin数量>
数量必须为整数
示例:/addcoin 3
目前想要自定义的话只能够将全部参数增加默认值变为可选参数,然后再在指令内部处理,但是这样就失去了框架本身关于自动识别参数是否为必填的这个特性。希望可以增加可自定义的必要参数缺失时候返回的提示文本供插件开发者使用。
目前我想到的最简单的方法就是在@filter.command("intimate", alias={"好感度"})这种装饰器里,再增加一个参数,比如usage,填入这个参数后,当检测到必要参数缺失的时候就可以返回usage中的描述内容。
你愿意提交PR吗?
Code of Conduct
描述
目前 AstrBot 在指令参数缺失时会显示框架默认的错误消息,格式为:
这种提示对用户不够友好,希望能让插件开发者自定义参数缺失时的错误提示,提供更清晰的使用说明。
使用场景
当前情况:
用户: /addcoin
Bot: 插件 RChips: 必要参数缺失。该指令完整参数: coin_num(int)
期望效果:
用户: /addcoin
Bot: 增加Coin使用说明
━━━━━━━━━━━━━━━
格式:/addcoin <coin数量>
数量必须为整数
示例:/addcoin 3
目前想要自定义的话只能够将全部参数增加默认值变为可选参数,然后再在指令内部处理,但是这样就失去了框架本身关于自动识别参数是否为必填的这个特性。希望可以增加可自定义的必要参数缺失时候返回的提示文本供插件开发者使用。
目前我想到的最简单的方法就是在
@filter.command("intimate", alias={"好感度"})这种装饰器里,再增加一个参数,比如usage,填入这个参数后,当检测到必要参数缺失的时候就可以返回usage中的描述内容。你愿意提交PR吗?
Code of Conduct