nonebot.argparse

class ArgumentParser(*args, **kwargs)

• 说明

  继承自 argparse.ArgumentParser 类，修改部分函数实现使其适用于命令型聊天机器人。

  此类可用于命令参数的解析。基本用法和 Python 内置的 argparse.ArgumentParser 类一致，下面主要列出与 Python 原生含义和行为不同的属性和方法。

• 参数

  • *args

  • **kwargs: 和 Python argparse.ArgumentParser 类一致

  • session: 当前需要解析参数的命令会话，用于解析失败或遇到 --help 时发送提示消息

  • usage: 命令的使用帮助，在参数为空或遇到 --help 时发送

• 用法

  USAGE = r'''
  创建计划任务
  
  使用方法：
  XXXXXX
  '''.strip()
  
  @on_command('schedule', shell_like=True)
  async def _(session: CommandSession):
      parser = ArgumentParser(session=session, usage=USAGE)
      parser.add_argument('-S', '--second')
      parser.add_argument('-M', '--minute')
      parser.add_argument('-H', '--hour')
      parser.add_argument('-d', '--day')
      parser.add_argument('-m', '--month')
      parser.add_argument('-w', '--day-of-week')
      parser.add_argument('-f', '--force', action='store_true', default=False)
      parser.add_argument('-v', '--verbose', action='store_true', default=False)
      parser.add_argument('--name', required=True)
      parser.add_argument('commands', nargs='+')
  
      args = parser.parse_args(session.argv)
      name = args.name
      # ...
  

method parse_args(self, args=None, namespace=None)

• 说明

  解析参数。

  Python 原生的「打印到控制台」行为变为「发送消息到用户」，「退出程序」变为「结束当前命令会话」。

• 参数

  • args

  • namespace

• 返回

  • Unknown