From faf7a3b500b873e26296f4939cbd17398684c38b Mon Sep 17 00:00:00 2001 From: yanyongyu Date: Mon, 10 May 2021 18:42:32 +0800 Subject: [PATCH] :memo: update doc --- docs/api/adapters/README.md | 2 +- docs/api/adapters/cqhttp.md | 2 +- docs/api/adapters/ding.md | 2 +- docs/api/adapters/mirai.md | 2 +- docs/api/matcher.md | 4 ++-- nonebot/matcher.py | 12 ++++++++++++ pages/changelog.md | 2 ++ 7 files changed, 20 insertions(+), 6 deletions(-) diff --git a/docs/api/adapters/README.md b/docs/api/adapters/README.md index fa3f597e..f0b8b86a 100644 --- a/docs/api/adapters/README.md +++ b/docs/api/adapters/README.md @@ -256,7 +256,7 @@ await bot.send_msg(message="hello world") ## _class_ `Message` -基类：`list`, `abc.ABC` +基类：`List`[`nonebot.adapters._base.T_MessageSegment`], `abc.ABC` 消息数组 diff --git a/docs/api/adapters/cqhttp.md b/docs/api/adapters/cqhttp.md index 6e6e938b..64a71ca1 100644 --- a/docs/api/adapters/cqhttp.md +++ b/docs/api/adapters/cqhttp.md @@ -314,7 +314,7 @@ CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或 ## _class_ `Message` -基类：[`nonebot.adapters._base.Message`](README.md#nonebot.adapters._base.Message) +基类：[`nonebot.adapters._base.Message`](README.md#nonebot.adapters._base.Message)[`nonebot.adapters.cqhttp.message.MessageSegment`] CQHTTP 协议 Message 适配。 diff --git a/docs/api/adapters/ding.md b/docs/api/adapters/ding.md index 2c531a7b..12057886 100644 --- a/docs/api/adapters/ding.md +++ b/docs/api/adapters/ding.md @@ -292,7 +292,7 @@ message += MessageSegment.atDingtalkIds(event.senderId) ## _class_ `Message` -基类：[`nonebot.adapters._base.Message`](README.md#nonebot.adapters._base.Message) +基类：[`nonebot.adapters._base.Message`](README.md#nonebot.adapters._base.Message)[`nonebot.adapters.ding.message.MessageSegment`] 钉钉 协议 Message 适配。 diff --git a/docs/api/adapters/mirai.md b/docs/api/adapters/mirai.md index 1851ed91..c7f72f26 100644 --- a/docs/api/adapters/mirai.md +++ b/docs/api/adapters/mirai.md @@ -963,7 +963,7 @@ Mirai-API-HTTP 协议 MessageSegment 适配。具体方法参考 [mirai-api-http ## _class_ `MessageChain` -基类：[`nonebot.adapters._base.Message`](README.md#nonebot.adapters._base.Message) +基类：[`nonebot.adapters._base.Message`](README.md#nonebot.adapters._base.Message)[`nonebot.adapters.mirai.message.MessageSegment`] Mirai 协议 Message 适配 diff --git a/docs/api/matcher.md b/docs/api/matcher.md index 0683c8f9..67a08d3f 100644 --- a/docs/api/matcher.md +++ b/docs/api/matcher.md @@ -37,13 +37,13 @@ sidebarDepth: 0 * **类型** - `Optional[str]` + `Optional[ModuleType]` * **说明** - 事件响应器所在模块名称 + 事件响应器所在模块 diff --git a/nonebot/matcher.py b/nonebot/matcher.py index ba6ca7b8..d849361d 100644 --- a/nonebot/matcher.py +++ b/nonebot/matcher.py @@ -67,10 +67,22 @@ class Matcher(metaclass=MatcherMeta): """ plugin_name: Optional[str] = module and getattr(module, "__plugin_name__", None) + """ + :类型: ``Optional[str]`` + :说明: 事件响应器所在插件名 + """ module_name: Optional[str] = module and getattr(module, "__module_name__", None) + """ + :类型: ``Optional[str]`` + :说明: 事件响应器所在模块名 + """ module_prefix: Optional[str] = module and getattr(module, "__module_prefix__", None) + """ + :类型: ``Optional[str]`` + :说明: 事件响应器所在模块前缀 + """ type: str = "" """ diff --git a/pages/changelog.md b/pages/changelog.md index 925ba585..e6f5c91e 100644 --- a/pages/changelog.md +++ b/pages/changelog.md @@ -8,6 +8,8 @@ sidebar: auto - 修改日志等级，支持输出等级自定义 - 修复日志输出模块名错误 +- 修改 `Matcher` 属性 `module` 类型 +- 新增 `Matcher` 属性 `plugin_name` `module_name` `module_prefix` ## v2.0.0a13.post1