* 滚木 * feat: 重构核心架构,增强类型安全与插件管理 本次提交对核心模块进行了深度重构,引入 Pydantic 增强配置管理的类型安全性,并全面优化了插件管理系统。 主要变更详情: 1. 核心架构与配置 - 重构配置加载模块:引入 Pydantic 模型 (`core/config_models.py`),提供严格的配置项类型检查、验证及默认值管理。 - 统一模块结构:规范化模块导入路径,移除冗余的 `__init__.py` 文件,提升项目结构的清晰度。 - 性能优化:集成 Redis 缓存支持 (`RedisManager`),有效降低高频 API 调用开销,提升响应速度。 2. 插件系统升级 - 实现热重载机制:新增插件文件变更监听功能,支持开发过程中自动重载插件,提升开发效率。 - 优化生命周期管理:改进插件加载与卸载逻辑,支持精确卸载指定插件及其关联的命令、事件处理器和定时任务。 3. 功能特性增强 - 新增媒体 API:引入 `MediaAPI` 模块,封装图片、语音等富媒体资源的获取与处理接口。 - 完善权限体系:重构权限管理系统,实现管理员与操作员的分级控制,支持更细粒度的命令权限校验。 4. 代码质量与稳定性 - 全面类型修复:解决 `mypy` 静态类型检查发现的大量类型错误(包括 `CommandManager`、`EventFactory` 及 `Bot` API 签名不匹配问题)。 - 增强错误处理:优化消息处理管道的异常捕获机制,完善关键路径的日志记录,提升系统运行稳定性。 * feat: 添加测试用例并优化代码结构 refactor(permission_manager): 调整初始化顺序和逻辑 fix(admin_manager): 修复初始化逻辑和目录创建问题 feat(ws): 优化Bot实例初始化条件 feat(message): 增强MessageSegment功能并添加测试 feat(events): 支持字符串格式的消息解析 test: 添加核心功能测试用例 refactor(plugin_manager): 改进插件路径处理 style: 清理无用导入和代码 chore: 更新依赖项
116 lines
4.5 KiB
Python
116 lines
4.5 KiB
Python
"""
|
|
Bot 核心抽象模块
|
|
|
|
该模块定义了 `Bot` 类,它是与 OneBot v11 API 进行交互的主要接口。
|
|
`Bot` 类通过继承 `api` 目录下的各个 Mixin 类,将不同类别的 API 调用
|
|
整合在一起,提供了一个统一、便捷的调用入口。
|
|
|
|
主要职责包括:
|
|
- 封装 WebSocket 通信,提供 `call_api` 方法。
|
|
- 提供高级消息发送功能,如 `send_forwarded_messages`。
|
|
- 整合所有细分的 API 调用(消息、群组、好友等)。
|
|
"""
|
|
from typing import TYPE_CHECKING, Dict, Any, List, Union
|
|
from models.events.base import OneBotEvent
|
|
from models.message import MessageSegment
|
|
from models.objects import GroupInfo, StrangerInfo
|
|
|
|
if TYPE_CHECKING:
|
|
from .ws import WS
|
|
|
|
from .api import MessageAPI, GroupAPI, FriendAPI, AccountAPI, MediaAPI
|
|
|
|
|
|
class Bot(MessageAPI, GroupAPI, FriendAPI, AccountAPI, MediaAPI):
|
|
"""
|
|
机器人核心类,封装了所有与 OneBot API 的交互。
|
|
|
|
通过 Mixin 模式继承了所有 API 功能,使得结构清晰且易于扩展。
|
|
实例由 `WS` 客户端在连接成功后创建,并传递给所有事件处理器和插件。
|
|
"""
|
|
|
|
def __init__(self, ws_client: "WS"):
|
|
"""
|
|
初始化 Bot 实例。
|
|
|
|
Args:
|
|
ws_client (WS): WebSocket 客户端实例,负责底层的 API 请求和响应处理。
|
|
"""
|
|
super().__init__(ws_client, ws_client.self_id or 0)
|
|
self.code_executor = None
|
|
|
|
async def get_group_list(self, no_cache: bool = False) -> List[GroupInfo]:
|
|
# GroupAPI.get_group_list 不支持 no_cache 参数,这里忽略它
|
|
result = await super().get_group_list()
|
|
# 确保结果是 GroupInfo 对象列表
|
|
return [GroupInfo(**group) if isinstance(group, dict) else group for group in result]
|
|
|
|
async def get_stranger_info(self, user_id: int, no_cache: bool = False) -> StrangerInfo:
|
|
result = await super().get_stranger_info(user_id=user_id, no_cache=no_cache)
|
|
# 确保结果是 StrangerInfo 对象
|
|
if isinstance(result, dict):
|
|
return StrangerInfo(**result)
|
|
return result
|
|
|
|
|
|
def build_forward_node(self, user_id: int, nickname: str, message: Union[str, "MessageSegment", List["MessageSegment"]]) -> Dict[str, Any]:
|
|
"""
|
|
构建一个用于合并转发的消息节点 (Node)。
|
|
|
|
这是一个辅助方法,用于方便地创建符合 OneBot v11 规范的消息节点,
|
|
以便在 `send_forwarded_messages` 中使用。
|
|
|
|
Args:
|
|
user_id (int): 发送者的 QQ 号。
|
|
nickname (str): 发送者在消息中显示的昵称。
|
|
message (Union[str, MessageSegment, List[MessageSegment]]): 该节点的消息内容,
|
|
可以是纯文本、单个消息段或消息段列表。
|
|
|
|
Returns:
|
|
Dict[str, Any]: 构造好的消息节点字典。
|
|
"""
|
|
return {
|
|
"type": "node",
|
|
"data": {
|
|
"uin": user_id,
|
|
"name": nickname,
|
|
"content": self._process_message(message)
|
|
}
|
|
}
|
|
|
|
async def send_forwarded_messages(self, target: Union[int, "OneBotEvent"], nodes: List[Dict[str, Any]]):
|
|
"""
|
|
发送合并转发消息。
|
|
|
|
该方法实现了智能判断,可以根据 `target` 的类型自动发送群聊合并转发
|
|
或私聊合并转发消息。
|
|
|
|
Args:
|
|
target (Union[int, OneBotEvent]): 发送目标。
|
|
- 如果是 `OneBotEvent` 对象,则自动判断是群聊还是私聊。
|
|
- 如果是 `int`,则默认为群号,发送群聊合并转发。
|
|
nodes (List[Dict[str, Any]]): 消息节点列表。
|
|
推荐使用 `build_forward_node` 方法来构建列表中的每个节点。
|
|
|
|
Raises:
|
|
ValueError: 如果事件对象中既没有 `group_id` 也没有 `user_id`。
|
|
"""
|
|
if isinstance(target, OneBotEvent):
|
|
group_id = getattr(target, "group_id", None)
|
|
user_id = getattr(target, "user_id", None)
|
|
|
|
if group_id:
|
|
# 直接发送群聊合并转发
|
|
await self.send_group_forward_msg(group_id, nodes)
|
|
elif user_id:
|
|
# 发送私聊合并转发
|
|
await self.send_private_forward_msg(user_id, nodes)
|
|
else:
|
|
raise ValueError("Event has neither group_id nor user_id")
|
|
|
|
else:
|
|
# 默认行为是发送到群聊
|
|
group_id = target
|
|
await self.send_group_forward_msg(group_id, nodes)
|
|
|