mirror of
https://github.com/nonebot/nonebot2.git
synced 2026-07-28 11:12:46 +00:00
📝 replace deprecated caution/important admonitions
This commit is contained in:
@@ -534,7 +534,7 @@ async def message_provider(
|
||||
|
||||
该方法可能会调用多次,即对于多个 Extension,选择优先级靠前且实现了该方法的 Extension,若调用的返回值不为 `None` 则作为结果。
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
该方法的默认实现对结果 (UniMessage) 会进行缓存。`Extension` 的实现也应尽量实现缓存机制。
|
||||
|
||||
|
||||
@@ -161,7 +161,7 @@ async def on_startup():
|
||||
await UniMessage("Hello!").send(target=target)
|
||||
```
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
在响应器以外的地方,除非启用了 `alconna_apply_fetch_targets` 配置项,否则 `bot` 参数必须手动传入。
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ asycn def _(bot: Bot, event: Event):
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
该方法获取的消息事件 ID 不推荐直接用于各适配器的 API 调用中,可能会操作失败。
|
||||
|
||||
@@ -231,7 +231,7 @@ async def message_edit(
|
||||
|
||||
## 表态消息
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
该方法属于实验性功能。其接口可能会在未来的版本中发生变化。
|
||||
|
||||
|
||||
@@ -178,7 +178,7 @@ op.drop_table("weather_weather") # DROP TABLE weather_weather;
|
||||
对了,不要忘记还有一段注释:`commands auto generated by Alembic - please adjust!`。
|
||||
它在提醒我们,这些代码是由 Alembic 自动生成的,我们应该检查它们,并且根据需要进行调整。
|
||||
|
||||
:::caution 注意
|
||||
:::warning 注意
|
||||
迁移脚本冗长且繁琐,我们一般不会手写它们,而是由 Alembic 自动生成。
|
||||
一般情况下,Alembic 足够智能,可以正确地生成迁移脚本。
|
||||
但是,在复杂或有歧义的情况下,我们可能需要手动调整迁移脚本。
|
||||
@@ -235,7 +235,7 @@ async def _(session: async_scoped_session, args: Message = CommandArg()):
|
||||
`async_scoped_session` 是一个有作用域限制的会话,作用域为当前事件、当前事件响应器。
|
||||
会话产生的模型实例(例如此处的 `wea := await session.get(Weather, location)`)作用域与会话相同。
|
||||
|
||||
:::caution 注意
|
||||
:::warning 注意
|
||||
此处提到的“会话”指的是 ORM 会话,而非 [NoneBot 会话](../../../appendices/session-control),两者的生命周期也是不同的(NoneBot 会话的生命周期中可能包含多个事件,不同的事件也会有不同的事件响应器)。
|
||||
具体而言,就是不要将 ORM 会话和模型实例存储在 NoneBot 会话状态中:
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ description: 用户指南
|
||||
`nonebot-plugin-orm` 功能强大且复杂,使用上有一定难度。
|
||||
不过,对于用户而言,只需要掌握部分功能即可。
|
||||
|
||||
:::caution 注意
|
||||
:::warning 注意
|
||||
请注意区分插件的项目名(如:`nonebot-plugin-wordcloud`)和模块名(如:`nonebot_plugin_wordcloud`)。`nonebot-plugin-orm` 中统一使用插件模块名。参见 [插件命名规范](../../developer/plugin-publishing#插件命名规范)。
|
||||
:::
|
||||
|
||||
@@ -152,7 +152,7 @@ SQLALCHEMY_ENGINE_OPTIONS='{
|
||||
SQLALCHEMY_ECHO=true
|
||||
```
|
||||
|
||||
:::caution 注意
|
||||
:::warning 注意
|
||||
以上配置之间有覆盖关系,遵循特殊优先于一般的原则,具体为 [`sqlalchemy_database_url`](#sqlalchemy_database_url) > [`sqlalchemy_bind`](#sqlalchemy_bind) > [`sqlalchemy_echo`](#sqlalchemy_echo) > [`sqlalchemy_engine_options`](#sqlalchemy_engine_options)。
|
||||
但覆盖顺序并非显而易见,出于清晰考虑,请只配置必要的选项。
|
||||
:::
|
||||
|
||||
@@ -27,7 +27,7 @@ nb plugin install nonebot-plugin-sentry
|
||||
|
||||
### 配置插件
|
||||
|
||||
:::caution 注意
|
||||
:::warning 注意
|
||||
错误跟踪通常在生产环境中使用,因此开发环境中 `sentry_dsn` 留空即会停用插件。
|
||||
:::
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ nb plugin install nonebot-plugin-htmlkit
|
||||
- Linux x64 (非 Alpine 等 musl 系发行版)
|
||||
- Linux arm64 (非 Alpine 等 musl 系发行版)
|
||||
|
||||
:::caution 访问网络内容
|
||||
:::warning 访问网络内容
|
||||
|
||||
如果需要访问网络资源(如 http(s) 网页内容),NoneBot 需要客户端型驱动器(Forward)。内置的驱动器有 `~httpx` 与 `~aiohttp`。
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ scheduler.add_job(
|
||||
)
|
||||
```
|
||||
|
||||
:::caution 注意
|
||||
:::warning 注意
|
||||
由于 APScheduler 的定时任务并不是**由事件响应器所触发的事件**,因此其任务函数无法同[事件处理函数](../tutorial/handler.mdx#事件处理函数)一样通过[依赖注入](../tutorial/event-data.mdx#认识依赖注入)获取上下文信息,也无法通过事件响应器对象的方法进行任何操作,因此我们需要使用[调用平台 API](../appendices/api-calling.mdx#调用平台-api)的方式来获取信息或收发消息。
|
||||
|
||||
相对于事件处理依赖而言,编写定时任务更像是编写普通的函数,需要我们自行获取信息以及发送信息,请**不要**将事件处理依赖的特殊语法用于定时任务!
|
||||
|
||||
Reference in New Issue
Block a user