📝 build api doc

This commit is contained in:
yanyongyu 2020-12-19 15:31:14 +08:00
parent 4ec4adf003
commit 168cc3801a
8 changed files with 725 additions and 108 deletions

View File

@ -178,6 +178,159 @@ await bot.send_msg(message="hello world")
基类:`abc.ABC`, `pydantic.main.BaseModel`
Event 基类。提供获取关键信息的方法,其余信息可直接获取。
### _abstract_ `get_type()`
* **说明**
获取事件类型的方法,类型通常为 NoneBot 内置的四种类型。
* **返回**
* `Literal["message", "notice", "request", "meta_event"]`
### _abstract_ `get_event_name()`
* **说明**
获取事件名称的方法。
* **返回**
* `str`
### _abstract_ `get_event_description()`
* **说明**
获取事件描述的方法,通常为事件具体内容。
* **返回**
* `str`
### `get_log_string()`
* **说明**
获取事件日志信息的方法,通常你不需要修改这个方法,只有当希望 NoneBot 隐藏该事件日志时,可以抛出 `NoLogException` 异常。
* **返回**
* `str`
* **异常**
* `NoLogException`
### _abstract_ `get_user_id()`
* **说明**
获取事件主体 id 的方法,通常是用户 id 。
* **返回**
* `str`
### _abstract_ `get_session_id()`
* **说明**
获取会话 id 的方法,用于判断当前事件属于哪一个会话,通常是用户 id、群组 id 组合。
* **返回**
* `str`
### _abstract_ `get_message()`
* **说明**
获取事件消息内容的方法。
* **返回**
* `Message`
### `get_plaintext()`
* **说明**
获取消息纯文本的方法,通常不需要修改,默认通过 `get_message().extract_plain_text` 获取。
* **返回**
* `str`
### _abstract_ `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `MessageSegment`

View File

@ -286,6 +286,20 @@ CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
## _class_ `MessageSegment`
基类:[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
## _class_ `Message`
基类:[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
CQHTTP 协议 Message 适配。
## _class_ `Event`
基类:[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
@ -293,6 +307,134 @@ CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https://github.com/howmanybots/onebot/blob/master/README.md)
### `get_type()`
* **说明**
获取事件类型的方法,类型通常为 NoneBot 内置的四种类型。
* **返回**
* `Literal["message", "notice", "request", "meta_event"]`
### `get_event_name()`
* **说明**
获取事件名称的方法。
* **返回**
* `str`
### `get_event_description()`
* **说明**
获取事件描述的方法,通常为事件具体内容。
* **返回**
* `str`
### `get_message()`
* **说明**
获取事件消息内容的方法。
* **返回**
* `Message`
### `get_plaintext()`
* **说明**
获取消息纯文本的方法,通常不需要修改,默认通过 `get_message().extract_plain_text` 获取。
* **返回**
* `str`
### `get_user_id()`
* **说明**
获取事件主体 id 的方法,通常是用户 id 。
* **返回**
* `str`
### `get_session_id()`
* **说明**
获取会话 id 的方法,用于判断当前事件属于哪一个会话,通常是用户 id、群组 id 组合。
* **返回**
* `str`
### `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `MessageEvent`
基类:`nonebot.adapters.cqhttp.event.Event`
@ -330,6 +472,102 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
### `get_event_name()`
* **说明**
获取事件名称的方法。
* **返回**
* `str`
### `get_message()`
* **说明**
获取事件消息内容的方法。
* **返回**
* `Message`
### `get_plaintext()`
* **说明**
获取消息纯文本的方法,通常不需要修改,默认通过 `get_message().extract_plain_text` 获取。
* **返回**
* `str`
### `get_user_id()`
* **说明**
获取事件主体 id 的方法,通常是用户 id 。
* **返回**
* `str`
### `get_session_id()`
* **说明**
获取会话 id 的方法,用于判断当前事件属于哪一个会话,通常是用户 id、群组 id 组合。
* **返回**
* `str`
### `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `PrivateMessageEvent`
基类:`nonebot.adapters.cqhttp.event.MessageEvent`
@ -337,6 +575,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
私聊消息
### `get_event_description()`
* **说明**
获取事件描述的方法,通常为事件具体内容。
* **返回**
* `str`
## _class_ `GroupMessageEvent`
基类:`nonebot.adapters.cqhttp.event.MessageEvent`
@ -344,6 +598,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
群消息
### `get_event_description()`
* **说明**
获取事件描述的方法,通常为事件具体内容。
* **返回**
* `str`
## _class_ `NoticeEvent`
基类:`nonebot.adapters.cqhttp.event.Event`
@ -351,6 +621,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
通知事件
### `get_event_name()`
* **说明**
获取事件名称的方法。
* **返回**
* `str`
## _class_ `GroupUploadNoticeEvent`
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
@ -365,6 +651,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
群管理员变动
### `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `GroupDecreaseNoticeEvent`
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
@ -372,6 +674,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
群成员减少事件
### `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `GroupIncreaseNoticeEvent`
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
@ -379,6 +697,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
群成员增加事件
### `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `GroupBanNoticeEvent`
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
@ -386,6 +720,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
群禁言事件
### `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `FriendAddNoticeEvent`
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
@ -400,6 +750,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
群消息撤回事件
### `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `FriendRecallNoticeEvent`
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
@ -421,6 +787,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
戳一戳提醒事件
### `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `LuckyKingNotifyEvent`
基类:`nonebot.adapters.cqhttp.event.NotifyEvent`
@ -428,6 +810,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
群红包运气王提醒事件
### `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `HonorNotifyEvent`
基类:`nonebot.adapters.cqhttp.event.NotifyEvent`
@ -435,6 +833,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
群荣誉变更提醒事件
### `is_tome()`
* **说明**
获取事件是否与机器人有关的方法。
* **返回**
* `bool`
## _class_ `RequestEvent`
基类:`nonebot.adapters.cqhttp.event.Event`
@ -442,6 +856,22 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
请求事件
### `get_event_name()`
* **说明**
获取事件名称的方法。
* **返回**
* `str`
## _class_ `FriendRequestEvent`
基类:`nonebot.adapters.cqhttp.event.RequestEvent`
@ -463,6 +893,45 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
元事件
### `get_event_name()`
* **说明**
获取事件名称的方法。
* **返回**
* `str`
### `get_log_string()`
* **说明**
获取事件日志信息的方法,通常你不需要修改这个方法,只有当希望 NoneBot 隐藏该事件日志时,可以抛出 `NoLogException` 异常。
* **返回**
* `str`
* **异常**
* `NoLogException`
## _class_ `LifecycleMetaEvent`
基类:`nonebot.adapters.cqhttp.event.MetaEvent`
@ -490,18 +959,3 @@ CQHTTP 协议事件。各事件字段未列出部分参考 [CQHTTP 文档](https
* `List[Type[Event]]`
## _class_ `MessageSegment`
基类:[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
## _class_ `Message`
基类:[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
CQHTTP 协议 Message 适配。

View File

@ -195,7 +195,7 @@ X-Signature: sha1=f9ddd4863ace61e64f462d41ca311e3d2c1176e2
### `superusers`
* **类型**: `Set[int]`
* **类型**: `Set[str]`
* **默认值**: `set()`
@ -211,7 +211,7 @@ X-Signature: sha1=f9ddd4863ace61e64f462d41ca311e3d2c1176e2
```default
SUPER_USERS=[12345789]
SUPER_USERS=["12345789"]
```

View File

@ -157,7 +157,7 @@ sidebarDepth: 0
* **类型**
`State`
`T_State`
@ -172,7 +172,7 @@ sidebarDepth: 0
* **类型**
`Optional[ArgsParser]`
`Optional[T_ArgsParser]`
@ -192,7 +192,7 @@ sidebarDepth: 0
* **类型**
`List[Handler]`
`List[T_Handler]`
@ -223,7 +223,7 @@ sidebarDepth: 0
* `permission: Optional[Permission]`: 权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器,即触发一次后删除
@ -238,7 +238,7 @@ sidebarDepth: 0
* `module: Optional[str]`: 事件响应器所在模块名称
* `default_state: Optional[State]`: 默认状态 `state`
* `default_state: Optional[T_State]`: 默认状态 `state`
* `expire_time: Optional[datetime]`: 事件响应器最终有效时间点,过时即被删除
@ -296,7 +296,7 @@ sidebarDepth: 0
* `event: Event`: 上报事件
* `state: State`: 当前状态
* `state: T_State`: 当前状态
@ -319,7 +319,7 @@ sidebarDepth: 0
* **参数**
* `func: ArgsParser`: 参数解析函数
* `func: T_ArgsParser`: 参数解析函数
@ -373,7 +373,7 @@ sidebarDepth: 0
* `prompt: Optional[Union[str, Message, MessageSegment]]`: 在参数不存在时向用户发送的消息
* `args_parser: Optional[ArgsParser]`: 可选参数解析函数,空则使用默认解析函数
* `args_parser: Optional[T_ArgsParser]`: 可选参数解析函数,空则使用默认解析函数

View File

@ -30,7 +30,7 @@ NoneBot 内部处理并按优先级分发事件给所有事件响应器,提供
* `event: Event`: Event 对象
* `state: State`: 当前 State
* `state: T_State`: 当前 State
@ -54,7 +54,7 @@ NoneBot 内部处理并按优先级分发事件给所有事件响应器,提供
* `event: Event`: Event 对象
* `state: State`: 当前事件运行前 State
* `state: T_State`: 当前事件运行前 State
@ -81,7 +81,7 @@ NoneBot 内部处理并按优先级分发事件给所有事件响应器,提供
* `event: Event`: Event 对象
* `state: State`: 当前 State
* `state: T_State`: 当前 State
@ -111,7 +111,7 @@ NoneBot 内部处理并按优先级分发事件给所有事件响应器,提供
* `event: Event`: Event 对象
* `state: State`: 当前 State
* `state: T_State`: 当前 State

View File

@ -115,13 +115,13 @@ def something_else():
* `type: str`: 事件响应器类型
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -133,7 +133,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -156,10 +156,10 @@ def something_else():
* **参数**
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -171,7 +171,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -194,13 +194,13 @@ def something_else():
* **参数**
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -212,7 +212,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -235,10 +235,10 @@ def something_else():
* **参数**
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -250,7 +250,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -273,10 +273,10 @@ def something_else():
* **参数**
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -288,7 +288,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -314,13 +314,13 @@ def something_else():
* `msg: str`: 指定消息开头内容
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -332,7 +332,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -358,13 +358,13 @@ def something_else():
* `msg: str`: 指定消息结尾内容
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -376,7 +376,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -402,13 +402,13 @@ def something_else():
* `keywords: Set[str]`: 关键词列表
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -420,7 +420,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -448,7 +448,7 @@ def something_else():
* `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名
@ -457,7 +457,7 @@ def something_else():
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -469,7 +469,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -500,13 +500,13 @@ def something_else():
* `flags: Union[int, re.RegexFlag]`: 正则匹配标志
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -518,7 +518,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -648,13 +648,13 @@ def something_else():
* `type: str`: 事件响应器类型
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -666,7 +666,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -689,10 +689,10 @@ def something_else():
* **参数**
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -704,7 +704,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -727,13 +727,13 @@ def something_else():
* **参数**
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -745,7 +745,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -768,10 +768,10 @@ def something_else():
* **参数**
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -783,7 +783,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -806,10 +806,10 @@ def something_else():
* **参数**
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -821,7 +821,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -847,13 +847,13 @@ def something_else():
* `msg: str`: 指定消息开头内容
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -865,7 +865,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -891,13 +891,13 @@ def something_else():
* `msg: str`: 指定消息结尾内容
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -909,7 +909,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -935,13 +935,13 @@ def something_else():
* `keywords: Set[str]`: 关键词列表
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -953,7 +953,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -981,7 +981,7 @@ def something_else():
* `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名
@ -990,7 +990,7 @@ def something_else():
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -1002,7 +1002,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state
@ -1033,13 +1033,13 @@ def something_else():
* `flags: Union[int, re.RegexFlag]`: 正则匹配标志
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
@ -1051,7 +1051,7 @@ def something_else():
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[State]`: 默认的 state
* `state: Optional[T_State]`: 默认的 state

View File

@ -42,7 +42,7 @@ Rule(async_function, run_sync(sync_function))
* **参数**
* `*checkers: Callable[[Bot, Event, State], Awaitable[bool]]`: **异步** RuleChecker
* `*checkers: Callable[[Bot, Event, T_State], Awaitable[bool]]`: **异步** RuleChecker
@ -58,7 +58,7 @@ Rule(async_function, run_sync(sync_function))
* **类型**
* `Set[Callable[[Bot, Event, State], Awaitable[bool]]]`
* `Set[Callable[[Bot, Event, T_State], Awaitable[bool]]]`
@ -80,7 +80,7 @@ Rule(async_function, run_sync(sync_function))
* `event: Event`: Event 对象
* `state: State`: 当前 State
* `state: T_State`: 当前 State

View File

@ -14,7 +14,7 @@ sidebarDepth: 0
以下类型均可从 nonebot.typing 模块导入。
## `State`
## `T_State`
* **类型**
@ -30,12 +30,12 @@ sidebarDepth: 0
## `EventPreProcessor`
## `T_EventPreProcessor`
* **类型**
`Callable[[Bot, Event, State], Awaitable[None]]`
`Callable[[Bot, Event, T_State], Awaitable[None]]`
@ -46,12 +46,12 @@ sidebarDepth: 0
## `EventPostProcessor`
## `T_EventPostProcessor`
* **类型**
`Callable[[Bot, Event, State], Awaitable[None]]`
`Callable[[Bot, Event, T_State], Awaitable[None]]`
@ -62,12 +62,12 @@ sidebarDepth: 0
## `RunPreProcessor`
## `T_RunPreProcessor`
* **类型**
`Callable[[Matcher, Bot, Event, State], Awaitable[None]]`
`Callable[[Matcher, Bot, Event, T_State], Awaitable[None]]`
@ -78,12 +78,12 @@ sidebarDepth: 0
## `RunPostProcessor`
## `T_RunPostProcessor`
* **类型**
`Callable[[Matcher, Optional[Exception], Bot, Event, State], Awaitable[None]]`
`Callable[[Matcher, Optional[Exception], Bot, Event, T_State], Awaitable[None]]`
@ -94,12 +94,12 @@ sidebarDepth: 0
## `RuleChecker`
## `T_RuleChecker`
* **类型**
`Callable[[Bot, Event, State], Union[bool, Awaitable[bool]]]`
`Callable[[Bot, Event, T_State], Union[bool, Awaitable[bool]]]`
@ -110,7 +110,7 @@ sidebarDepth: 0
## `PermissionChecker`
## `T_PermissionChecker`
* **类型**
@ -126,12 +126,22 @@ sidebarDepth: 0
## `Handler`
## `T_Handler`
* **类型**
`Callable[[Bot, Event, State], Union[Awaitable[None], Awaitable[NoReturn]]]`
* `Callable[[Bot, Event, T_State], Union[Awaitable[None], Awaitable[NoReturn]]]`
* `Callable[[Bot, Event], Union[Awaitable[None], Awaitable[NoReturn]]]`
* `Callable[[Bot, T_State], Union[Awaitable[None], Awaitable[NoReturn]]]`
* `Callable[[Bot], Union[Awaitable[None], Awaitable[NoReturn]]]`
@ -142,12 +152,12 @@ sidebarDepth: 0
## `ArgsParser`
## `T_ArgsParser`
* **类型**
`Callable[[Bot, Event, State], Union[Awaitable[None], Awaitable[NoReturn]]]`
`Callable[[Bot, Event, T_State], Union[Awaitable[None], Awaitable[NoReturn]]]`