ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-07-16 02:50:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

令参数列表符合 autodoc 格式

Browse Source
This commit is contained in:
hemengyang
2022-01-12 18:25:25 +08:00
parent 4ba1a09fb7
commit a5f32febbd
19 changed files with 361 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
nonebot/typing.py
View File

@ -73,11 +73,11 @@ T_EventPreProcessor = Callable[..., Union[None, Awaitable[None]]]
"""
:依赖参数:
* `DependParam`: 子依赖参数
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
* `DefaultParam`: 带有默认值的参数
DependParam: 子依赖参数
BotParam: Bot 对象
EventParam: Event 对象
StateParam: State 对象
DefaultParam: 带有默认值的参数
事件预处理函数 EventPreProcessor 类型
"""
@ -85,11 +85,11 @@ T_EventPostProcessor = Callable[..., Union[None, Awaitable[None]]]
"""
:依赖参数:
* `DependParam`: 子依赖参数
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
* `DefaultParam`: 带有默认值的参数
DependParam: 子依赖参数
BotParam: Bot 对象
EventParam: Event 对象
StateParam: State 对象
DefaultParam: 带有默认值的参数
事件预处理函数 EventPostProcessor 类型
"""
@ -97,12 +97,12 @@ T_RunPreProcessor = Callable[..., Union[None, Awaitable[None]]]
"""
:依赖参数:
* `DependParam`: 子依赖参数
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
* `MatcherParam`: Matcher 对象
* `DefaultParam`: 带有默认值的参数
DependParam: 子依赖参数
BotParam: Bot 对象
EventParam: Event 对象
StateParam: State 对象
MatcherParam: Matcher 对象
DefaultParam: 带有默认值的参数
事件响应器运行前预处理函数 RunPreProcessor 类型
"""
@ -110,13 +110,13 @@ T_RunPostProcessor = Callable[..., Union[None, Awaitable[None]]]
"""
:依赖参数:
* `DependParam`: 子依赖参数
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
* `MatcherParam`: Matcher 对象
* `ExceptionParam`: 异常对象（可能为 None）
* `DefaultParam`: 带有默认值的参数
DependParam: 子依赖参数
BotParam: Bot 对象
EventParam: Event 对象
StateParam: State 对象
MatcherParam: Matcher 对象
ExceptionParam: 异常对象（可能为 None）
DefaultParam: 带有默认值的参数
事件响应器运行前预处理函数 RunPostProcessor 类型，第二个参数为运行时产生的错误（如果存在）
"""
@ -125,11 +125,11 @@ T_RuleChecker = Callable[..., Union[bool, Awaitable[bool]]]
"""
:依赖参数:
* `DependParam`: 子依赖参数
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
* `DefaultParam`: 带有默认值的参数
DependParam: 子依赖参数
BotParam: Bot 对象
EventParam: Event 对象
StateParam: State 对象
DefaultParam: 带有默认值的参数
RuleChecker 即判断是否响应事件的处理函数。
"""
@ -137,10 +137,10 @@ T_PermissionChecker = Callable[..., Union[bool, Awaitable[bool]]]
"""
:依赖参数:
* `DependParam`: 子依赖参数
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `DefaultParam`: 带有默认值的参数
DependParam: 子依赖参数
BotParam: Bot 对象
EventParam: Event 对象
DefaultParam: 带有默认值的参数
RuleChecker 即判断是否响应消息的处理函数。
"""
@ -153,12 +153,12 @@ T_TypeUpdater = Callable[..., Union[str, Awaitable[str]]]
"""
:依赖参数:
* `DependParam`: 子依赖参数
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
* `MatcherParam`: Matcher 对象
* `DefaultParam`: 带有默认值的参数
DependParam: 子依赖参数
BotParam: Bot 对象
EventParam: Event 对象
StateParam: State 对象
MatcherParam: Matcher 对象
DefaultParam: 带有默认值的参数
TypeUpdater 在 Matcher.pause, Matcher.reject 时被运行，用于更新响应的事件类型。默认会更新为 `message`。
"""
@ -166,12 +166,12 @@ T_PermissionUpdater = Callable[..., Union["Permission", Awaitable["Permission"]]
"""
:依赖参数:
* `DependParam`: 子依赖参数
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
* `MatcherParam`: Matcher 对象
* `DefaultParam`: 带有默认值的参数
DependParam: 子依赖参数
BotParam: Bot 对象
EventParam: Event 对象
StateParam: State 对象
MatcherParam: Matcher 对象
DefaultParam: 带有默认值的参数
PermissionUpdater 在 Matcher.pause, Matcher.reject 时被运行，用于更新会话对象权限。默认会更新为当前事件的触发对象。
"""