2.8 KiB
| contentSidebar | sidebarDepth |
|---|---|
| true | 0 |
NoneBot.rule 模块
规则
每个事件响应器 Matcher 拥有一个匹配规则 Rule ，其中是 异步 RuleChecker 的集合，只有当所有 RuleChecker 检查结果为 True 时继续运行。
:::tip 提示
RuleChecker 既可以是 async function 也可以是 sync function，但在最终会被 nonebot.utils.run_sync 转换为 async function
:::
class Rule
基类：object
-
说明
Matcher规则类，当事件传递时，在Matcher运行前进行检查。 -
示例
Rule(async_function) & sync_function
# 等价于
from nonebot.utils import run_sync
Rule(async_function, run_sync(sync_function))
__init__(*checkers)
-
参数
*checkers: Callable[[Bot, Event, dict], Awaitable[bool]]: 异步 RuleChecker
checkers
-
说明
存储
RuleChecker -
类型
Set[Callable[[Bot, Event, dict], Awaitable[bool]]]
async __call__(bot, event, state)
-
说明
检查是否符合所有规则
-
参数
-
bot: Bot: Bot 对象 -
event: Event: Event 对象 -
state: dict: 当前 State
-
-
返回
bool
startswith(msg)
-
说明
匹配消息开头
-
参数
msg: str: 消息开头字符串
endswith(msg)
-
说明
匹配消息结尾
-
参数
msg: str: 消息结尾字符串
keyword(*keywords)
-
说明
匹配消息关键词
-
参数
*keywords: str: 关键词
command(*cmds)
-
说明
命令形式匹配，根据配置里提供的
command_start,command_sep判断消息是否为命令。可以通过
state["_prefix"]["command"]获取匹配成功的命令（例：("test",)），通过state["_prefix"]["raw_command"]获取匹配成功的原始命令文本（例："/test"）。 -
参数
*cmds: Union[str, Tuple[str, ...]]: 命令内容
-
示例
使用默认
command_start,command_sep配置命令
("test",)可以匹配：/test开头的消息 命令("test", "sub")可以匹配”/test.sub开头的消息
:::tip 提示 命令内容与后续消息间无需空格！ :::
regex(regex, flags=0)
-
说明
根据正则表达式进行匹配。
可以通过
state["_matched"]获取正则表达式匹配成功的文本。 -
参数
-
regex: str: 正则表达式 -
flags: Union[int, re.RegexFlag]: 正则标志
-
:::tip 提示
正则表达式匹配使用 search 而非 match，如需从头匹配请使用 r"^xxx" 来确保匹配开头
:::
to_me()
-
说明
通过
event.to_me判断消息是否是发送给机器人 -
参数
- 无