mirror of
https://github.com/nonebot/nonebot2.git
synced 2025-01-31 15:41:34 +08:00
📝 update api docs
This commit is contained in:
parent
760ac693c0
commit
9a29966e2d
@ -62,21 +62,6 @@ Driver 基类。
|
||||
|
||||
|
||||
|
||||
### `dependency_overrides`
|
||||
|
||||
|
||||
* **类型**
|
||||
|
||||
`Dict[Callable[..., Any], Callable[..., Any]]`
|
||||
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
Depends 函数的替换表
|
||||
|
||||
|
||||
|
||||
### `__init__(env, config)`
|
||||
|
||||
|
||||
|
@ -17,7 +17,7 @@ sidebarDepth: 0
|
||||
事件处理器类。支持依赖注入。
|
||||
|
||||
|
||||
### `__init__(func, *, name=None, dependencies=None, allow_types=None, dependency_overrides_provider=None)`
|
||||
### `__init__(func, *, name=None, dependencies=None, allow_types=None)`
|
||||
|
||||
|
||||
* **说明**
|
||||
@ -41,9 +41,6 @@ sidebarDepth: 0
|
||||
* `allow_types: Optional[List[Type[Param]]]`: 允许的参数类型。
|
||||
|
||||
|
||||
* `dependency_overrides_provider: Optional[Any]`: 依赖注入覆盖提供者。
|
||||
|
||||
|
||||
|
||||
### `func`
|
||||
|
||||
|
@ -7,7 +7,7 @@ sidebarDepth: 0
|
||||
|
||||
## 权限
|
||||
|
||||
每个 `Matcher` 拥有一个 `Permission` ,其中是 **异步** `PermissionChecker` 的集合,只要有一个 `PermissionChecker` 检查结果为 `True` 时就会继续运行。
|
||||
每个 `Matcher` 拥有一个 `Permission` ,其中是 `PermissionChecker` 的集合,只要有一个 `PermissionChecker` 检查结果为 `True` 时就会继续运行。
|
||||
|
||||
:::tip 提示
|
||||
`PermissionChecker` 既可以是 async function 也可以是 sync function
|
||||
@ -36,7 +36,7 @@ Permission(async_function, run_sync(sync_function))
|
||||
```
|
||||
|
||||
|
||||
### `__init__(*checkers, dependency_overrides_provider=None)`
|
||||
### `__init__(*checkers)`
|
||||
|
||||
|
||||
* **参数**
|
||||
|
@ -7,10 +7,10 @@ sidebarDepth: 0
|
||||
|
||||
## 规则
|
||||
|
||||
每个事件响应器 `Matcher` 拥有一个匹配规则 `Rule` ,其中是 **异步** `RuleChecker` 的集合,只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行。
|
||||
每个事件响应器 `Matcher` 拥有一个匹配规则 `Rule` ,其中是 `RuleChecker` 的集合,只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行。
|
||||
|
||||
:::tip 提示
|
||||
`RuleChecker` 既可以是 async function 也可以是 sync function,但在最终会被 `nonebot.utils.run_sync` 转换为 async function
|
||||
`RuleChecker` 既可以是 async function 也可以是 sync function
|
||||
:::
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ Rule(async_function, run_sync(sync_function))
|
||||
```
|
||||
|
||||
|
||||
### `__init__(*checkers, dependency_overrides_provider=None)`
|
||||
### `__init__(*checkers)`
|
||||
|
||||
|
||||
* **参数**
|
||||
|
Loading…
x
Reference in New Issue
Block a user