📝 update api docs

This commit is contained in:
nonebot 2021-11-21 04:37:46 +00:00
parent b4d12d905d
commit d22630e768
5 changed files with 126 additions and 84 deletions

View File

@ -348,7 +348,7 @@ sidebarDepth: 0
### _async classmethod_ `check_perm(bot, event)`
### _async classmethod_ `check_perm(bot, event, stack=None, dependency_cache=None)`
* **说明**
@ -374,7 +374,7 @@ sidebarDepth: 0
### _async classmethod_ `check_rule(bot, event, state)`
### _async classmethod_ `check_rule(bot, event, state, stack=None, dependency_cache=None)`
* **说明**

View File

@ -19,21 +19,6 @@ NoneBot 内部处理并按优先级分发事件给所有事件响应器,提供
* **参数**
事件预处理函数接收三个参数。
* `bot: Bot`: Bot 对象
* `event: Event`: Event 对象
* `state: T_State`: 当前 State
## `event_postprocessor(func)`
@ -43,21 +28,6 @@ NoneBot 内部处理并按优先级分发事件给所有事件响应器,提供
* **参数**
事件后处理函数接收三个参数。
* `bot: Bot`: Bot 对象
* `event: Event`: Event 对象
* `state: T_State`: 当前事件运行前 State
## `run_preprocessor(func)`
@ -67,24 +37,6 @@ NoneBot 内部处理并按优先级分发事件给所有事件响应器,提供
* **参数**
运行预处理函数接收四个参数。
* `matcher: Matcher`: 当前要运行的事件响应器
* `bot: Bot`: Bot 对象
* `event: Event`: Event 对象
* `state: T_State`: 当前 State
## `run_postprocessor(func)`
@ -94,27 +46,6 @@ NoneBot 内部处理并按优先级分发事件给所有事件响应器,提供
* **参数**
运行后处理函数接收五个参数。
* `matcher: Matcher`: 运行完毕的事件响应器
* `exception: Optional[Exception]`: 事件响应器运行错误(如果存在)
* `bot: Bot`: Bot 对象
* `event: Event`: Event 对象
* `state: T_State`: 当前 State
## _async_ `handle_event(bot, event)`

View File

@ -36,13 +36,13 @@ Permission(async_function, run_sync(sync_function))
```
### `__init__(*checkers)`
### `__init__(*checkers, dependency_overrides_provider=None)`
* **参数**
* `*checkers: Callable[[Bot, Event], Awaitable[bool]]`: **异步** PermissionChecker
* `*checkers: T_PermissionChecker`: PermissionChecker
@ -58,11 +58,11 @@ Permission(async_function, run_sync(sync_function))
* **类型**
* `Set[Callable[[Bot, Event], Awaitable[bool]]]`
* `Set[Handler]`
### _async_ `__call__(bot, event)`
### _async_ `__call__(bot, event, stack=None, dependency_cache=None)`
* **说明**
@ -80,6 +80,12 @@ Permission(async_function, run_sync(sync_function))
* `event: Event`: Event 对象
* `stack: Optional[AsyncExitStack]`: 异步上下文栈
* `dependency_cache: Optional[Dict[Callable[..., Any], Any]]`: 依赖缓存
* **返回**

View File

@ -36,7 +36,7 @@ Rule(async_function, run_sync(sync_function))
```
### `__init__(*checkers)`
### `__init__(*checkers, dependency_overrides_provider=None)`
* **参数**
@ -83,6 +83,12 @@ Rule(async_function, run_sync(sync_function))
* `state: T_State`: 当前 State
* `stack: Optional[AsyncExitStack]`: 异步上下文栈
* `dependency_cache: Optional[Dict[Callable[..., Any], Any]]`: 依赖缓存
* **返回**

View File

@ -115,7 +115,20 @@ sidebarDepth: 0
* **类型**
`Callable[[Bot, Event, T_State], Awaitable[None]]`
`Callable[..., Union[None, Awaitable[None]]]`
* **依赖参数**
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
@ -131,7 +144,20 @@ sidebarDepth: 0
* **类型**
`Callable[[Bot, Event, T_State], Awaitable[None]]`
`Callable[..., Union[None, Awaitable[None]]]`
* **依赖参数**
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
@ -147,7 +173,23 @@ sidebarDepth: 0
* **类型**
`Callable[[Matcher, Bot, Event, T_State], Awaitable[None]]`
`Callable[..., Union[None, Awaitable[None]]]`
* **依赖参数**
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
* `MatcherParam`: Matcher 对象
@ -163,7 +205,26 @@ sidebarDepth: 0
* **类型**
`Callable[[Matcher, Optional[Exception], Bot, Event, T_State], Awaitable[None]]`
`Callable[..., Union[None, Awaitable[None]]]`
* **依赖参数**
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
* `MatcherParam`: Matcher 对象
* `ExceptionParam`: 异常对象(可能为 None
@ -183,6 +244,19 @@ sidebarDepth: 0
* **依赖参数**
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
* `StateParam`: State 对象
* **说明**
RuleChecker 即判断是否响应事件的处理函数。
@ -195,7 +269,17 @@ sidebarDepth: 0
* **类型**
`Callable[[Bot, Event], Union[bool, Awaitable[bool]]]`
`Callable[..., Union[bool, Awaitable[bool]]]`
* **依赖参数**
* `BotParam`: Bot 对象
* `EventParam`: Event 对象
@ -211,14 +295,29 @@ sidebarDepth: 0
* **类型**
* `Callable[..., Union[Awaitable[None], Awaitable[NoReturn]]]`
`Callable[..., Any]`
* **说明**
Handler 即事件的处理函数。
Handler 处理函数。
## `T_DependencyCache`
* **类型**
`Dict[T_Handler, Any]`
* **说明**
依赖缓存, 用于存储依赖函数的返回值