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,113 +1,95 @@
|
||||
# 快速上手
|
||||
|
||||
本指南将引导您完成 NEO Bot Framework 的本地开发环境搭建、配置和首次运行。
|
||||
runit
|
||||
|
||||
## 1. 环境准备
|
||||
## 1. 你需要准备
|
||||
|
||||
在开始之前，请确保您的开发环境中已安装以下软件：
|
||||
* **Python 3.14**: 必须是这个版本别问我为什么。。。
|
||||
* **Git**: 拉取代码
|
||||
* **Redis**: 装一个
|
||||
* **脑子和手**: 这个最重要，或者你去问问镀铬酸钾，会给你一对一教学的。。。
|
||||
* **OneBot v11 客户端**: 机器人本体，推荐用 [NapCatQQ](https://github.com/NapNeko/NapCatQQ)
|
||||
|
||||
* **Python**: 版本要求 `3.12` 或更高。
|
||||
* 我们推荐使用官方的 CPython 解释器。
|
||||
* 您可以通过在终端运行 `python --version` 来检查您的 Python 版本。
|
||||
## 2. 搭起来
|
||||
|
||||
* **Git**: 用于克隆项目仓库。
|
||||
### a. 克隆代码
|
||||
|
||||
* **Redis**: 一个键值对数据库，用于缓存和数据共享。
|
||||
* 对于 Windows 用户，可以考虑使用 `memurai` 或通过 WSL2 安装 Redis。
|
||||
* 对于 macOS 用户，可以使用 `brew install redis`。
|
||||
* 安装后，请确保 Redis 服务正在运行。
|
||||
|
||||
* **OneBot v11 实现端**: 机器人框架需要连接到一个实现了 OneBot v11 协议的客户端。
|
||||
* **推荐**: [NapCatQQ](https://github.com/NapNeko/NapCatQQ)
|
||||
|
||||
## 2. 克隆与安装
|
||||
|
||||
### 克隆项目
|
||||
|
||||
打开您的终端，并克隆项目仓库到本地：
|
||||
找个你喜欢的地方，把代码从 GitHub 上clone下来
|
||||
|
||||
```bash
|
||||
git clone [项目仓库地址]
|
||||
cd [项目目录]
|
||||
```
|
||||
|
||||
### 创建虚拟环境 (推荐)
|
||||
### b. 创建虚拟环境
|
||||
|
||||
为了保持项目依赖的隔离，强烈建议您创建一个 Python 虚拟环境。
|
||||
别把你的系统环境搞得乱七八糟
|
||||
|
||||
```bash
|
||||
# 创建虚拟环境
|
||||
python -m venv venv
|
||||
|
||||
# 激活虚拟环境
|
||||
# Windows
|
||||
python -m venv venv
|
||||
.\venv\Scripts\activate
|
||||
# macOS / Linux
|
||||
|
||||
# Linux / macOS
|
||||
python3.14 -m venv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
|
||||
### 安装依赖
|
||||
看到命令行前面多了个 `(venv)`，就说明你进来了。
|
||||
|
||||
### c. 安装依赖
|
||||
|
||||
激活虚拟环境后，使用 `pip` 安装所有必需的第三方库：
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## 3. 配置
|
||||
### d. 安装 Playwright 依赖
|
||||
|
||||
项目的核心配置位于根目录下的 `config.toml` 文件中。
|
||||
我们用 Playwright 来截图画画，它需要一个浏览器核心。
|
||||
|
||||
对于内部开发，该文件通常已预先配置好，可以直接连接到测试服务器。如果您需要连接到自己的环境，请修改以下关键部分：
|
||||
```bash
|
||||
playwright install chromium
|
||||
```
|
||||
|
||||
### e. 编译核心 (可选，但强烈建议)
|
||||
|
||||
想让你的代码更快？把它的核心代码编译成 C。
|
||||
|
||||
```bash
|
||||
python setup_mypyc.py build_ext --inplace
|
||||
```
|
||||
*注：Windows 上可能需要装个 Visual Studio Build Tools，Linux 上需要 GCC。编译失败也别慌，跳过就行，JIT 也能保证不错的速度*
|
||||
|
||||
## 3. 第一次
|
||||
|
||||
### a. 修改配置
|
||||
|
||||
去根目录找 `config.toml`。
|
||||
|
||||
```toml
|
||||
# config.toml
|
||||
|
||||
[napcat_ws]
|
||||
# 您的 OneBot v11 实现端的 WebSocket 地址
|
||||
# 格式通常为 ws://<IP地址>:<端口号>
|
||||
# 你的 OneBot 地址
|
||||
# 我们用的是正向连接，也就是 Bot 主动去连 OneBot
|
||||
uri = "ws://127.0.0.1:3001"
|
||||
|
||||
# Access Token (访问令牌)，如果您的 OneBot 端设置了
|
||||
token = ""
|
||||
|
||||
[redis]
|
||||
# Redis 服务的连接信息
|
||||
host = "127.0.0.1"
|
||||
port = 6379
|
||||
db = 0
|
||||
password = "" # 如果您的 Redis 设置了密码
|
||||
```
|
||||
把 `uri` 改成你自己的 OneBot 地址。
|
||||
|
||||
## 4. 首次运行
|
||||
### b. 启动！
|
||||
|
||||
完成以上所有步骤后，您就可以启动机器人了。在项目根目录运行：
|
||||
一切就绪
|
||||
|
||||
```bash
|
||||
python main.py
|
||||
# 推荐开启 JIT 模式启动
|
||||
python -X jit main.py
|
||||
```
|
||||
|
||||
如果一切顺利，您将在控制台看到类似以下的输出：
|
||||
如果你看到日志刷出来，最后显示 “连接成功！”，恭喜，你成功了！
|
||||
|
||||
```
|
||||
2026-01-07 22:42:41.718 | INFO | ... - 管理员管理器初始化完成
|
||||
2026-01-07 22:42:41.826 | INFO | ... - 正在从 plugins 加载插件...
|
||||
2026-01-07 22:42:41.994 | SUCCESS | ... - Redis 连接成功！
|
||||
...
|
||||
2026-01-07 22:42:42.618 | SUCCESS | ... - 连接成功！
|
||||
```
|
||||
|
||||
看到 `连接成功！` 的日志，即表示您的机器人已成功连接到 OneBot 客户端并准备好接收消息。
|
||||
|
||||
## 5. 常见问题排查 (FAQ)
|
||||
|
||||
* **Q: 启动时报错 `redis.exceptions.ConnectionError`**
|
||||
* **A**: 请检查您的 Redis 服务是否已启动，以及 `config.toml` 中的 `host` 和 `port` 是否正确。
|
||||
|
||||
* **Q: 无法连接到 WebSocket，提示 `ConnectionRefusedError`**
|
||||
* **A**: 请确认您的 OneBot v11 客户端（如 NapCatQQ）是否正在运行，并检查 `config.toml` 中的 `uri` 地址和端口是否匹配。
|
||||
|
||||
* **Q: 修改了插件代码但没有生效**
|
||||
* **A**: 框架默认开启了热重载功能。请检查控制台是否有 `[HotReload]` 相关的日志输出。如果没有，请确认 `watchdog` 库已正确安装。
|
||||
|
||||
现在，您的开发环境已经准备就绪。接下来，您可以尝试修改一个现有插件或[创建您的第一个插件](./plugin-development/index.md)！
|
||||
现在，试着给你的机器人发个 `/help`看看会返回什么东西
|
||||
|
||||
Reference in New Issue
Block a user