From ffafd748814a55a2db9274744fdfdddd04b652b6 Mon Sep 17 00:00:00 2001 From: whatevertogo Date: Fri, 13 Mar 2026 03:31:00 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=A2=9E=E5=BC=BA=20api=20=E6=A8=A1?= =?UTF-8?q?=E5=9D=97=E5=85=BC=E5=AE=B9=E5=B1=82=E6=96=87=E6=A1=A3=EF=BC=8C?= =?UTF-8?q?=E6=8F=90=E7=A4=BA=E6=8F=92=E4=BB=B6=E4=BD=9C=E8=80=85=E8=BF=81?= =?UTF-8?q?=E7=A7=BB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 添加 warning 块明确标注为 v3 兼容层 - 提示插件制作者迁移至新版导入路径 - 添加迁移示例代码对比旧版/新版导入方式 - 说明兼容层将在未来版本移除 --- src-new/astrbot_sdk/api/__init__.py | 34 +++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/src-new/astrbot_sdk/api/__init__.py b/src-new/astrbot_sdk/api/__init__.py index 19657eca8..e3594bcb8 100644 --- a/src-new/astrbot_sdk/api/__init__.py +++ b/src-new/astrbot_sdk/api/__init__.py @@ -1,13 +1,33 @@ -"""旧版 ``astrbot_sdk.api`` 的兼容入口。 +"""**兼容层** - 旧版 ``astrbot_sdk.api`` 导入路径的向后兼容入口。 -新版 SDK 的推荐导入路径在顶层模块： +.. warning:: + 本目录是 ** 旧版本兼容层**，仅供旧版插件使用。 -- ``astrbot_sdk.context.Context`` -- ``astrbot_sdk.events.MessageEvent`` -- ``astrbot_sdk.decorators`` -- ``astrbot_sdk.star.Star`` + **请插件制作者尽快迁移至新版导入路径**，兼容层将在未来版本移除。 -这里保留 ``api`` 目录，目的是兼容旧版插件的导入路径，而不是复制一套独立的新运行时。 + 保留此目录路径是为了确保旧版插件无需修改代码即可运行。 + 路径名 ``api`` 是历史原因，新版 SDK 的核心 API 已迁移至顶层模块。 + +新版推荐导入路径： + +- ``astrbot_sdk.context.Context`` - 上下文管理 +- ``astrbot_sdk.events.MessageEvent`` - 消息事件 +- ``astrbot_sdk.decorators`` - 装饰器 (command, regex 等) +- ``astrbot_sdk.star.Star`` - 插件基类 + +迁移示例:: + + # 旧版 (将在未来版本废弃) + from astrbot_sdk.api.event import AstrMessageEvent + from astrbot_sdk.api.star.context import Context + + # 新版 (推荐) + from astrbot_sdk.events import MessageEvent + from astrbot_sdk.context import Context + +设计说明： +- 兼容层通过 thin re-export 方式暴露旧版 API +- 不复制独立运行时逻辑，保持架构清晰 """ from . import basic, components, event, message, platform, provider, star