Dev (#36)
* 滚木 * 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>
This commit is contained in:
镀铬酸钾
@@ -1,70 +1,48 @@
|
||||
# 项目结构解析
|
||||
# 项目结构
|
||||
|
||||
理解 NEO Bot Framework 的项目结构是高效开发的第一步。本节将详细介绍每个主要目录和文件的用途。
|
||||
了解项目里每个文件夹是干嘛的，能让你更快找到代码。
|
||||
|
||||
```
|
||||
.
|
||||
├── core/ # 框架核心代码
|
||||
│ ├── api/ # OneBot v11 API 的 Mixin 封装
|
||||
│ ├── data/ # 核心模块的数据存储 (admin, permissions)
|
||||
│ ├── handlers/ # 底层事件处理器 (message, notice, request)
|
||||
│ ├── managers/ # 核心单例管理器 (command, permission, etc.)
|
||||
│ ├── utils/ # 通用工具 (logger, singleton, etc.)
|
||||
│ ├── bot.py # Bot 核心类，提供 API 调用接口
|
||||
│ ├── config_loader.py # TOML 配置文件加载器
|
||||
│ └── ws.py # WebSocket 底层通信模块
|
||||
├── core/ # 核心代码，别乱动
|
||||
│ ├── handlers/ # 底层事件处理器
|
||||
│ ├── managers/ # 全局单例管理器
|
||||
│ ├── utils/ # 工具函数
|
||||
│ └── ws.py # WebSocket 连接实现
|
||||
├── data/ # 存放持久化数据
|
||||
│ ├── admin.json # 管理员列表
|
||||
│ └── permissions.json # 用户权限列表
|
||||
├── docs/ # 开发文档
|
||||
├── html/ # 静态网页文件 (用于 Web 仪表盘等)
|
||||
├── models/ # 数据模型 (事件, 消息段)
|
||||
│ ├── events/ # OneBot v11 事件的 Python 对象封装
|
||||
│ ├── message.py # 消息段 (MessageSegment) 的定义
|
||||
│ └── ...
|
||||
├── plugins/ # 功能插件目录
|
||||
├── venv/ # Python 虚拟环境 (推荐)
|
||||
├── .gitignore # Git 忽略文件配置
|
||||
├── config.toml # 主配置文件
|
||||
├── main.py # 项目启动入口
|
||||
└── requirements.txt # Python 依赖列表
|
||||
├── logs/ # 日志文件
|
||||
├── models/ # 数据模型
|
||||
│ └── events/ # OneBot 事件模型
|
||||
├── plugins/ # 你的插件都放这
|
||||
├── templates/ # 图片渲染用的网页模板
|
||||
├── venv/ # Python 虚拟环境
|
||||
├── .gitignore # Git 忽略配置
|
||||
├── main.py # 主入口文件
|
||||
├── requirements.txt # Python 依赖列表
|
||||
└── setup_mypyc.py # Mypyc 编译脚本
|
||||
```
|
||||
|
||||
## 顶层目录
|
||||
## 重点目录说明
|
||||
|
||||
### `core/`
|
||||
|
||||
这是框架的心脏，包含了所有核心逻辑。**通常情况下，您不需要修改此目录下的代码**，只需了解其工作原理即可。
|
||||
这是框架的心脏。除非你知道自己在干嘛，否则别碰这里面的东西。大部分功能都由 `managers` 里的管理器提供，你只需要 `import` 它们就行。
|
||||
|
||||
* `api/`: 将 OneBot v11 的 API 按功能（如 `message`, `group`）拆分为多个 `Mixin` 类，最终由 `bot.py` 继承，提供了清晰的 API 结构。
|
||||
* `data/`: 存放核心模块所需的数据文件，例如 `admin.json` 和 `permissions.json`。
|
||||
* `handlers/`: 定义了最底层的事件处理器，如 `MessageHandler`，负责从 `ws.py` 接收原始事件并进行初步处理和分发。
|
||||
* `managers/`: 包含一系列全局单例管理器，是框架功能的核心实现。例如，`CommandManager` 负责指令注册与匹配，`PermissionManager` 负责权限控制。
|
||||
* `utils/`: 提供被广泛使用的工具类，如 `logger` (日志)、`singleton` (单例模式基类)。
|
||||
* `bot.py`: 定义了 `Bot` 类，这是插件开发者最常与之交互的对象，用于调用所有 OneBot API。
|
||||
* `config_loader.py`: 负责解析 `config.toml` 文件，并提供一个全局的 `global_config` 对象。
|
||||
* `config_models.py`: 使用 Pydantic 定义了配置文件的结构和类型验证。
|
||||
* `ws.py`: 实现了与 OneBot v11 实现端的 WebSocket 连接、心跳、重连和消息收发。
|
||||
### `data/`
|
||||
|
||||
### `docs/`
|
||||
|
||||
存放项目的所有开发文档。
|
||||
|
||||
### `html/`
|
||||
|
||||
用于存放未来 Web 仪表盘或其他 Web 功能所需的静态资源（HTML, CSS, JavaScript）。
|
||||
|
||||
### `models/`
|
||||
|
||||
定义了将 OneBot v11 的 JSON 数据转换为易于使用的 Python 对象。
|
||||
|
||||
* `events/`: 将所有上报的事件（如 `MessageEvent`, `GroupIncreaseNoticeEvent`）封装为带有类型提示的类。
|
||||
* `message.py`: 提供了 `MessageSegment` 类，用于构建复杂的消息内容（如 @某人、发送图片）。
|
||||
存放一些 JSON 格式的数据。管理员和用户权限默认存在这里。如果你用 Redis，这些文件会作为备份。
|
||||
|
||||
### `plugins/`
|
||||
|
||||
这是**插件开发者最关心的目录**。所有机器人的功能都以独立的 `.py` 文件形式存放在这里。框架会自动加载此目录下的所有插件，并支持热重载。
|
||||
**这是你最常待的地方**。你写的所有插件（`.py` 文件）都扔在这个目录里。Bot 启动时会自动加载这里的所有插件。
|
||||
|
||||
## 顶层文件
|
||||
### `templates/`
|
||||
|
||||
* `.gitignore`: 配置 Git 应忽略的文件和目录，如 `__pycache__`、`venv` 等。
|
||||
* `config.toml`: 项目的主配置文件，用于设置机器人、数据库、API 等所有可变参数。
|
||||
* `main.py`: 项目的启动入口脚本。它负责初始化日志、加载插件、启动 WebSocket 连接和文件监控（用于热重载）。
|
||||
* `requirements.txt`: 列出了项目运行所需的所有 Python 第三方库及其版本。
|
||||
如果你要用 `ImageManager` 画图，就需要把 HTML 模板文件放在这里。
|
||||
|
||||
### `main.py`
|
||||
|
||||
程序的入口。负责加载配置、初始化管理器、启动 WebSocket 连接和 FastAPI 服务。
|
||||
|
||||
Reference in New Issue
Block a user