Version: Next

nonebot.rule

本模块是 {ref}nonebot.matcher.Matcher.rule 的类型定义。

每个事件响应器 Matcher 拥有一个匹配规则 Rule 其中是 RuleChecker 的集合,只有当所有 RuleChecker 检查结果为 True 时继续运行。

class Rule(*checkers)

  • 说明

    Matcher 规则类。

    当事件传递时,在 Matcher 运行前进行检查。

  • 参数

    • *checkers ((Any, **Any) -> bool | (Any, **Any) -> Awaitable[bool] | Dependent[bool])
  • 用法

    Rule(async_function) & sync_function
    # 等价于
    Rule(async_function, sync_function)

async method __call__(self, bot, event, state, stack=None, dependency_cache=None) {#Rule-call}

  • 说明

    检查是否符合所有规则

  • 参数

    • bot (nonebot.internal.adapter.bot.Bot): Bot 对象

    • event (nonebot.internal.adapter.event.Event): Event 对象

    • state (dict[Any, Any]): 当前 State

    • stack (contextlib.AsyncExitStack | None): 异步上下文栈

    • dependency_cache (dict[(Any, **Any) -> Any | (Any, **Any) -> Awaitable[Any], Task[Any]] | None): 依赖缓存

  • 返回

    • bool

class CMD_RESULT()

class TRIE_VALUE(command_start, command)

  • 说明

    TRIE_VALUE(command_start, command)

  • 参数

    • command_start (str)

    • command (tuple[str, ...])

class StartswithRule(msg, ignorecase=False)

  • 说明

    检查消息纯文本是否以指定字符串开头。

  • 参数

    • msg (tuple[str, ...]): 指定消息开头字符串元组

    • ignorecase (bool): 是否忽略大小写

def startswith(msg, ignorecase=False)

  • 说明

    匹配消息纯文本开头。

  • 参数

    • msg (str | tuple[str, ...]): 指定消息开头字符串元组

    • ignorecase (bool): 是否忽略大小写

  • 返回

    • nonebot.internal.rule.Rule

class EndswithRule(msg, ignorecase=False)

  • 说明

    检查消息纯文本是否以指定字符串结尾。

  • 参数

    • msg (tuple[str, ...]): 指定消息结尾字符串元组

    • ignorecase (bool): 是否忽略大小写

def endswith(msg, ignorecase=False)

  • 说明

    匹配消息纯文本结尾。

  • 参数

    • msg (str | tuple[str, ...]): 指定消息开头字符串元组

    • ignorecase (bool): 是否忽略大小写

  • 返回

    • nonebot.internal.rule.Rule

class FullmatchRule(msg, ignorecase=False)

  • 说明

    检查消息纯文本是否与指定字符串全匹配。

  • 参数

    • msg (tuple[str, ...]): 指定消息全匹配字符串元组

    • ignorecase (bool): 是否忽略大小写

def fullmatch(msg, ignorecase=False)

  • 说明

    完全匹配消息。

  • 参数

    • msg (str | tuple[str, ...]): 指定消息全匹配字符串元组

    • ignorecase (bool): 是否忽略大小写

  • 返回

    • nonebot.internal.rule.Rule

class KeywordsRule(*keywords)

  • 说明

    检查消息纯文本是否包含指定关键字。

  • 参数

    • *keywords (str): 指定关键字元组

def keyword(*keywords)

  • 说明

    匹配消息纯文本关键词。

  • 参数

    • *keywords (str): 指定关键字元组
  • 返回

    • nonebot.internal.rule.Rule

class CommandRule(cmds)

  • 说明

    检查消息是否为指定命令。

  • 参数

    • cmds (list[tuple[str, ...]]): 指定命令元组列表

def command(*cmds)

  • 说明

    匹配消息命令。

    根据配置里提供的 command_start, command_sep 判断消息是否为命令。

    可以通过 Command 获取匹配成功的命令(例: ("test",)), 通过 RawCommand 获取匹配成功的原始命令文本(例: "/test"), 通过 CommandArg 获取匹配成功的命令参数。

  • 参数

    • *cmds (str | tuple[str, ...]): 命令文本或命令元组
  • 返回

    • nonebot.internal.rule.Rule
  • 用法

    使用默认 command_start, command_sep 配置

    命令 `("test",)` 可以匹配: `/test` 开头的消息
    命令 `("test", "sub")` 可以匹配: `/test.sub` 开头的消息
    提示

    命令内容与后续消息间无需空格!

class ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)

  • 说明

    shell_like 命令参数解析器,解析出错时不会退出程序。

  • 参数

    • prog

    • usage

    • description

    • epilog

    • parents

    • formatter_class

    • prefix_chars

    • fromfile_prefix_chars

    • argument_default

    • conflict_handler

    • add_help

    • allow_abbrev

    • exit_on_error

  • 用法

    用法与 argparse.ArgumentParser 相同, 参考文档: argparse

class ShellCommandRule(cmds, parser)

  • 说明

    检查消息是否为指定 shell 命令。

  • 参数

    • cmds (list[tuple[str, ...]]): 指定命令元组列表

    • parser (ArgumentParser | None): 可选参数解析器

def shell_command(*cmds, parser=None)

  • 说明

    匹配 shell_like 形式的消息命令。

    根据配置里提供的 command_start, command_sep 判断消息是否为命令。

    可以通过 Command 获取匹配成功的命令(例: ("test",)), 通过 RawCommand 获取匹配成功的原始命令文本(例: "/test"), 通过 ShellCommandArgv 获取解析前的参数列表(例: ["arg", "-h"]), 通过 ShellCommandArgs 获取解析后的参数字典(例: {"arg": "arg", "h": True})。

    警告

    如果参数解析失败,则通过 ShellCommandArgs 获取的将是 ParserExit 异常。

  • 参数

    • *cmds (str | tuple[str, ...]): 命令文本或命令元组

    • parser (ArgumentParser | None): ArgumentParser 对象

  • 返回

    • nonebot.internal.rule.Rule
  • 用法

    使用默认 command_start, command_sep 配置,更多示例参考 argparse 标准库文档。

    ```python
    from nonebot.rule import ArgumentParser

    parser = ArgumentParser()
    parser.add_argument("-a", action="store_true")

    rule = shell_command("ls", parser=parser)
    ```
    提示

    命令内容与后续消息间无需空格!

class RegexRule(regex, flags=0)

  • 说明

    检查消息字符串是否符合指定正则表达式。

  • 参数

    • regex (str): 正则表达式

    • flags (int): 正则表达式标记

def regex(regex, flags=0)

  • 说明

    匹配符合正则表达式的消息字符串。

    可以通过 RegexMatched 获取匹配成功的字符串, 通过 RegexGroup 获取匹配成功的 group 元组, 通过 RegexDict 获取匹配成功的 group 字典。

  • 参数

    • regex (str): 正则表达式

      flags: 正则表达式标记

      提示

      正则表达式匹配使用 search 而非 match,如需从头匹配请使用 r"^xxx" 来确保匹配开头

      提示

      正则表达式匹配使用 EventMessage 的 str 字符串,而非 EventMessage 的 PlainText 纯文本字符串

    • flags (int | re.RegexFlag)

  • 返回

    • nonebot.internal.rule.Rule

class ToMeRule()

  • 说明

    检查事件是否与机器人有关。

def to_me()

  • 说明

    匹配与机器人有关的事件。

  • 返回

    • nonebot.internal.rule.Rule

class IsTypeRule(*types)

  • 说明

    检查事件类型是否为指定类型。

  • 参数

    • *types (Type[nonebot.internal.adapter.event.Event])

def is_type(*types)

  • 说明

    匹配事件类型。

  • 参数

    • *types (Type[nonebot.internal.adapter.event.Event]): 事件类型
  • 返回

    • nonebot.internal.rule.Rule