95e98dea9c
* 滚木 * 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: 更新依赖项 * refactor(handler): 移除TYPE_CHECKING并直接导入Bot类 简化类型注解，直接导入Bot类而非使用TYPE_CHECKING条件导入，提高代码可读性和维护性 * fix(command_manager): 修复插件卸载时元信息移除不精确的问题 修复 CommandManager 中 unload_plugin 方法移除插件元信息时使用 startswith 导致可能误删其他插件的问题，改为精确匹配 同时调整相关测试用例验证精确匹配行为 * refactor: 清理未使用的导入和更新文档结构 docs: 添加config_models.py到项目结构文档 docs: 调整数据目录位置到core/data下 docs: 更新权限管理器文档描述 * 文档更新 * 更新thpic插件 支持一次返回多张图 * feat: 添加测试覆盖率并修复相关问题 refactor(redis_manager): 移除冗余的ConnectionError处理 refactor(event_handler): 优化Bot类型注解 refactor(factory): 移除未使用的GroupCardNoticeEvent test: 添加全面的单元测试覆盖 - 添加test_import.py测试模块导入 - 添加test_debug.py测试插件加载调试 - 添加test_plugin_error.py测试错误处理 - 添加test_config_loader.py测试配置加载 - 添加test_redis_manager.py测试Redis管理 - 添加test_bot.py测试Bot功能 - 扩展test_models.py测试消息模型 - 添加test_plugin_manager_coverage.py测试插件管理 - 添加test_executor.py测试代码执行器 - 添加test_ws.py测试WebSocket - 添加test_api.py测试API接口 - 添加test_core_managers.py测试核心管理模块 fix(plugin_manager): 修复插件加载日志变量问题 覆盖率已到达86%（忽略插件） * 更新/help指令，现在会发送图片 * feat(help): 重构帮助系统为图片渲染模式 添加浏览器管理器和图片管理器，用于通过 Playwright 渲染帮助菜单为图片 重构命令管理器以支持图片缓存和同步功能 添加 HTML 模板用于帮助菜单渲染 * build: 更新依赖文件 requirements.txt * build: 更新依赖文件 * feat: 添加性能优化和架构文档，更新依赖和核心模块 refactor(browser_manager): 实现页面池机制以提升性能 refactor(image_manager): 添加模板缓存并集成页面池 refactor(bili_parser): 迁移到异步HTTP请求并实现会话复用 docs: 新增性能优化、架构设计和最佳实践文档 chore: 更新requirements.txt添加新依赖 * docs: 更新文档内容并优化语言风格 重构所有文档内容，使用更简洁直接的语言风格 更新架构、插件开发、部署等核心文档 优化代码示例和图表说明 统一术语和格式规范 * docs: 更新文档内容，简化语言并修正格式 - 简化插件开发指南中的描述，移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档，删除不准确的数据 - 重构核心概念文档，使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档，简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档，添加参数注入示例 - 优化单例管理器文档的表述 --------- Co-authored-by: baby20162016 <2185823427@qq.com>
78 lines
2.8 KiB
Markdown
78 lines
2.8 KiB
Markdown
# Calglau BOT by NEO Bot Framework
|
||
|
||
> **[INTERNAL USE ONLY]**
|
||
>
|
||
> 本仓库为 Calglau BOT 的内部开发版本，请遵守相关保密协议。
|
||
|
||
**Powered by NEO Bot Framework**
|
||
|
||
## 项目概述
|
||
|
||
**Calglau BOT** 是一个基于 NEO Bot Framework 构建的高性能 QQ 机器人。
|
||
|
||
简单来说：扣一
|
||
|
||
### 核心特性
|
||
|
||
* **模块化插件架构**：所有功能都在 `plugins/` 目录
|
||
* **极致性能优化**：
|
||
* **Python 3.14 JIT**：pypy不支持那个浏览器扩展我只能用JIT了。。。
|
||
* **Mypyc 编译**：一些核心模块已经编译成机器码了
|
||
* **Playwright 页面池**：浏览器页面预热池
|
||
* **全局连接复用**：HTTP 和 Redis 连接池化管理
|
||
* **开发者友好**：完整的类型提示，清晰的 API 设计。
|
||
* **集成 Redis 缓存**：能缓存的都缓存了。群信息、用户信息、帮助图片
|
||
* **正向 WebSocket 连接**：我只会支持正向WS连接。。。不要提意见，我不会听的。。。
|
||
|
||
### 技术栈
|
||
|
||
* **核心框架**: Python 3.14 JIT & NEO Bot Framework
|
||
* **编译器**: Mypyc
|
||
* **异步核心**: `asyncio` + `uvloop` (Linux) / 原生 Loop (Windows)
|
||
* **网络通信**: `websockets` (OneBot v11), `aiohttp` (Shared Session)
|
||
* **浏览器引擎**: `Playwright` (Chromium) + Page Pool
|
||
* **数据序列化**: `orjson`
|
||
* **缓存**: `Redis`
|
||
* **日志**: `Loguru`
|
||
|
||
---
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
.
|
||
├── plugins/ # 插件目录，业务逻辑都在这
|
||
│ ├── admin.py # 管理员指令
|
||
│ ├── bili_parser.py # B站解析 (高性能版)
|
||
│ ├── code_py.py # 代码沙箱
|
||
│ ├── echo.py # 复读机
|
||
│ ├── forward_test.py # 合并转发测试
|
||
│ ├── jrcd.py # 今日运势
|
||
│ └── thpic.py # 东方图片
|
||
├── core/ # 框架核心，非请勿动
|
||
│ ├── api/ # OneBot API 封装
|
||
│ ├── managers/ # 各种管理器 (指令, 浏览器, 图片, 插件)
|
||
│ ├── utils/ # 工具函数
|
||
│ ├── ws.py # WebSocket 通信层 (已编译)
|
||
│ └── bot.py # Bot 实例
|
||
├── data/ # 数据存储
|
||
│ ├── admin.json # 管理员名单
|
||
│ └── permissions.json # 权限配置
|
||
├── templates/ # Jinja2 模板
|
||
├── setup_mypyc.py # 编译脚本
|
||
└── main.py # 启动入口
|
||
```
|
||
|
||
## 快速开始
|
||
|
||
1
|
||
|
||
|
||
1. **装环境**: Python 3.14，Redis， OneBot 客户端 (推荐 NapCat)。
|
||
2. **装依赖**: `pip install -r requirements.txt`
|
||
3. **装浏览器**: `playwright install chromium`
|
||
4. **编译核心 (可选)**: `python setup_mypyc.py build_ext --inplace`
|
||
5. **启动**: `python -X jit main.py`
|
||
|
||
详细文档去 `docs/` 目录看
|