Dev (#40)
* 滚木 * 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中的项目描述和技术栈说明 - 更新快速上手文档，简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档，添加参数注入示例 - 优化单例管理器文档的表述 * refactor(core): 优化权限管理和事件模型 - 重构 AdminManager 和 PermissionManager 以 Redis 为主要数据源 - 为所有事件模型添加 slots=True 提升性能 - 更新文档说明 Mypyc 编译注意事项 - 清理测试和调试文件 - 移动静态资源到 web_static 目录 * feat: 添加模块编译脚本和导出依赖功能 refactor(events): 移除数据类的slots参数以提升兼容性 build: 更新requirements.txt依赖列表 * docs: 更新性能优化文档并修复命令管理器帮助输出 更新性能优化相关文档，详细说明 Python 3.14 JIT 编译器的使用方法和原理，补充与 Mypyc 的互补策略。同时修复命令管理器中帮助信息的输出方式，移除图片发送仅保留文本输出。 调整部署文档结构，明确两种性能优化方案（AOT 和 JIT）的配置方法和适用场景。完善架构文档中关于 JIT 的原理和启用方式说明。 * feat(help): 重构帮助菜单界面并优化样式 refactor(bili_parser): 修复 API 响应 content-type 问题 fix(command_manager): 添加帮助图片获取的错误处理 docs(deployment): 简化部署文档并移除 JIT 相关内容 * feat: 新增自动同意请求插件和API文档 docs: 更新文档结构和内容 * refactor(scripts): 重构并优化脚本文件结构 feat(scripts): 添加Python环境检查脚本 feat(scripts): 增强依赖导出脚本功能 perf(plugins/bili_parser): 优化B站解析器性能和代码结构 style(plugins/bili_parser): 统一代码风格和常量命名 --------- Co-authored-by: baby20162016 <2185823427@qq.com>
This commit is contained in:
镀铬酸钾
398
docs/api/account.md
Normal file
398
docs/api/account.md
Normal file
@@ -0,0 +1,398 @@
|
||||
# 账号 API
|
||||
|
||||
这一页讲的是怎么管理机器人自己的账号：查看登录信息、设置在线状态、修改资料、退出登录等等。这些都是跟机器人自身相关的操作。
|
||||
|
||||
## 账号信息
|
||||
|
||||
### `get_login_info` - 获取登录信息
|
||||
|
||||
```python
|
||||
async def get_login_info(self, no_cache: bool = False) -> LoginInfo
|
||||
```
|
||||
|
||||
获取当前登录的机器人账号信息。默认会缓存 1 小时。
|
||||
|
||||
**参数：**
|
||||
- `no_cache`: 是否跳过缓存，直接从服务器获取
|
||||
|
||||
**返回值：**
|
||||
- `LoginInfo`: 登录信息对象
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
info = await bot.get_login_info()
|
||||
print(f"机器人QQ号: {info.user_id}")
|
||||
print(f"机器人昵称: {info.nickname}")
|
||||
```
|
||||
|
||||
`LoginInfo` 对象包含：
|
||||
- `user_id`: 机器人 QQ 号
|
||||
- `nickname`: 机器人昵称
|
||||
|
||||
### `get_version_info` - 获取版本信息
|
||||
|
||||
```python
|
||||
async def get_version_info(self) -> VersionInfo
|
||||
```
|
||||
|
||||
获取 OneBot v11 实现的版本信息（比如 NapCatQQ 的版本）。
|
||||
|
||||
**返回值：**
|
||||
- `VersionInfo`: 版本信息对象
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
version = await bot.get_version_info()
|
||||
print(f"客户端: {version.app_name}")
|
||||
print(f"版本: {version.app_version}")
|
||||
print(f"OneBot 协议版本: {version.protocol_version}")
|
||||
```
|
||||
|
||||
`VersionInfo` 对象包含：
|
||||
- `app_name`: 客户端名称（如 "NapCatQQ"）
|
||||
- `app_version`: 客户端版本
|
||||
- `protocol_version`: 支持的 OneBot 协议版本
|
||||
|
||||
### `get_status` - 获取运行状态
|
||||
|
||||
```python
|
||||
async def get_status(self) -> Status
|
||||
```
|
||||
|
||||
获取 OneBot 实现的运行状态信息。
|
||||
|
||||
**返回值：**
|
||||
- `Status`: 状态信息对象
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
status = await bot.get_status()
|
||||
print(f"在线: {status.online}")
|
||||
print(f"状态: {status.status}")
|
||||
print(f"正常: {status.good}")
|
||||
```
|
||||
|
||||
`Status` 对象包含：
|
||||
- `online`: 是否在线
|
||||
- `status`: 状态描述
|
||||
- `good`: 运行是否正常
|
||||
|
||||
## 状态设置
|
||||
|
||||
### `set_self_longnick` - 设置个性签名
|
||||
|
||||
```python
|
||||
async def set_self_longnick(self, long_nick: str) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
设置机器人账号的个性签名（QQ 资料里的那个长签名）。
|
||||
|
||||
**参数：**
|
||||
- `long_nick`: 要设置的个性签名内容
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
@matcher.command("setsign")
|
||||
async def handle_setsign(event: MessageEvent, args: str):
|
||||
if not args:
|
||||
await event.reply("需要签名内容")
|
||||
return
|
||||
|
||||
await event.bot.set_self_longnick(args)
|
||||
await event.reply("个性签名已更新")
|
||||
```
|
||||
|
||||
### `set_online_status` - 设置在线状态
|
||||
|
||||
```python
|
||||
async def set_online_status(self, status_code: int) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
设置机器人的在线状态（在线、离开、忙碌等）。
|
||||
|
||||
**参数：**
|
||||
- `status_code`: 状态码
|
||||
- `1`: 在线
|
||||
- `2`: 离开
|
||||
- `3`: 忙碌
|
||||
- `4`: 请勿打扰
|
||||
- `5`: 隐身
|
||||
- 其他值取决于客户端支持
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
# 设置为隐身
|
||||
await bot.set_online_status(5)
|
||||
```
|
||||
|
||||
### `set_diy_online_status` - 设置自定义在线状态
|
||||
|
||||
```python
|
||||
async def set_diy_online_status(
|
||||
self,
|
||||
face_id: int,
|
||||
face_type: int,
|
||||
wording: str
|
||||
) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
设置自定义的在线状态（需要客户端支持）。
|
||||
|
||||
**参数：**
|
||||
- `face_id`: 状态表情 ID
|
||||
- `face_type`: 状态表情类型
|
||||
- `wording`: 状态描述文本
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
# 设置为"摸鱼中"
|
||||
await bot.set_diy_online_status(
|
||||
face_id=100,
|
||||
face_type=1,
|
||||
wording="摸鱼中"
|
||||
)
|
||||
```
|
||||
|
||||
### `set_input_status` - 设置"正在输入"状态
|
||||
|
||||
```python
|
||||
async def set_input_status(
|
||||
self,
|
||||
user_id: int,
|
||||
event_type: int
|
||||
) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
向指定用户显示"对方正在输入..."的状态提示。
|
||||
|
||||
**参数：**
|
||||
- `user_id`: 目标用户的 QQ 号
|
||||
- `event_type`: 事件类型（具体含义取决于客户端）
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
# 向某个用户显示"正在输入"
|
||||
await bot.set_input_status(123456, 1)
|
||||
```
|
||||
|
||||
## 资料修改
|
||||
|
||||
### `set_qq_profile` - 设置个人资料
|
||||
|
||||
```python
|
||||
async def set_qq_profile(self, **kwargs) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
设置机器人账号的个人资料。
|
||||
|
||||
**参数：**
|
||||
- `**kwargs`: 个人资料的相关参数，具体字段请参考 OneBot v11 规范
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
# 修改昵称
|
||||
await bot.set_qq_profile(nickname="新的昵称")
|
||||
|
||||
# 修改多个字段
|
||||
await bot.set_qq_profile(
|
||||
nickname="新昵称",
|
||||
sex="female",
|
||||
age=18,
|
||||
level=50
|
||||
)
|
||||
```
|
||||
|
||||
### `set_qq_avatar` - 设置头像
|
||||
|
||||
```python
|
||||
async def set_qq_avatar(self, **kwargs) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
设置机器人账号的头像。
|
||||
|
||||
**参数：**
|
||||
- `**kwargs`: 头像的相关参数，具体字段请参考 OneBot v11 规范
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
# 设置头像（具体参数格式取决于客户端）
|
||||
await bot.set_qq_avatar(file="path/to/avatar.jpg")
|
||||
```
|
||||
|
||||
## 系统操作
|
||||
|
||||
### `bot_exit` - 退出登录
|
||||
|
||||
```python
|
||||
async def bot_exit(self) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
让机器人进程退出（需要客户端支持）。谨慎使用！
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
@matcher.command("shutdown", permission="admin")
|
||||
async def handle_shutdown(event: MessageEvent):
|
||||
await event.reply("机器人正在退出...")
|
||||
await event.bot.bot_exit()
|
||||
```
|
||||
|
||||
### `clean_cache` - 清理缓存
|
||||
|
||||
```python
|
||||
async def clean_cache(self) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
清理 OneBot 客户端的缓存。
|
||||
|
||||
**示例：**
|
||||
```python
|
||||
@matcher.command("clearcache", permission="admin")
|
||||
async def handle_clearcache(event: MessageEvent):
|
||||
await event.bot.clean_cache()
|
||||
await event.reply("缓存已清理")
|
||||
```
|
||||
|
||||
### `get_clientkey` - 获取客户端密钥
|
||||
|
||||
```python
|
||||
async def get_clientkey(self) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
获取客户端密钥（通常用于 QQ 登录相关操作）。
|
||||
|
||||
**返回值：**
|
||||
- 包含客户端密钥的字典
|
||||
|
||||
## 实用示例
|
||||
|
||||
### 机器人状态查询插件
|
||||
|
||||
```python
|
||||
@matcher.command("status")
|
||||
async def handle_status(event: MessageEvent):
|
||||
# 获取各种信息
|
||||
login_info = await event.bot.get_login_info()
|
||||
version_info = await event.bot.get_version_info()
|
||||
status_info = await event.bot.get_status()
|
||||
|
||||
# 构建状态消息
|
||||
msg = "🤖 机器人状态\n"
|
||||
msg += f"QQ号: {login_info.user_id}\n"
|
||||
msg += f"昵称: {login_info.nickname}\n"
|
||||
msg += f"客户端: {version_info.app_name} v{version_info.app_version}\n"
|
||||
msg += f"协议: OneBot v{version_info.protocol_version}\n"
|
||||
msg += f"状态: {'在线' if status_info.online else '离线'}\n"
|
||||
msg += f"运行: {'正常' if status_info.good else '异常'}"
|
||||
|
||||
await event.reply(msg)
|
||||
```
|
||||
|
||||
### 自动切换状态
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
from datetime import datetime
|
||||
|
||||
async def auto_status_scheduler(bot):
|
||||
"""
|
||||
定时自动切换状态
|
||||
"""
|
||||
while True:
|
||||
now = datetime.now().hour
|
||||
|
||||
if 9 <= now < 18:
|
||||
# 工作时间：在线
|
||||
await bot.set_online_status(1)
|
||||
status_text = "工作中"
|
||||
elif 18 <= now < 22:
|
||||
# 晚上：离开
|
||||
await bot.set_online_status(2)
|
||||
status_text = "休息中"
|
||||
else:
|
||||
# 深夜：隐身
|
||||
await bot.set_online_status(5)
|
||||
status_text = "睡眠模式"
|
||||
|
||||
# 设置个性签名
|
||||
await bot.set_self_longnick(f"当前状态: {status_text} | 最后更新: {datetime.now():%H:%M}")
|
||||
|
||||
# 每小时更新一次
|
||||
await asyncio.sleep(3600)
|
||||
|
||||
# 在初始化插件时启动
|
||||
# （注意：这只是一个示例，实际使用需要考虑插件生命周期）
|
||||
```
|
||||
|
||||
### 资料备份与恢复
|
||||
|
||||
```python
|
||||
import json
|
||||
|
||||
@matcher.command("backupprofile", permission="admin")
|
||||
async def handle_backup_profile(event: MessageEvent):
|
||||
"""
|
||||
备份当前资料到文件
|
||||
"""
|
||||
# 获取当前登录信息
|
||||
login_info = await event.bot.get_login_info()
|
||||
|
||||
# 构建备份数据
|
||||
backup_data = {
|
||||
"user_id": login_info.user_id,
|
||||
"nickname": login_info.nickname,
|
||||
"backup_time": datetime.now().isoformat()
|
||||
}
|
||||
|
||||
# 保存到文件
|
||||
filename = f"profile_backup_{login_info.user_id}.json"
|
||||
with open(filename, "w", encoding="utf-8") as f:
|
||||
json.dump(backup_data, f, ensure_ascii=False, indent=2)
|
||||
|
||||
await event.reply(f"资料已备份到 {filename}")
|
||||
|
||||
@matcher.command("restoreprofile", permission="admin")
|
||||
async def handle_restore_profile(event: MessageEvent, args: str):
|
||||
"""
|
||||
从备份恢复资料
|
||||
"""
|
||||
if not args:
|
||||
await event.reply("需要备份文件名")
|
||||
return
|
||||
|
||||
try:
|
||||
with open(args, "r", encoding="utf-8") as f:
|
||||
backup_data = json.load(f)
|
||||
|
||||
# 恢复资料（这里只是示例，实际可能需要更多字段）
|
||||
await event.bot.set_qq_profile(
|
||||
nickname=backup_data.get("nickname", "")
|
||||
)
|
||||
|
||||
await event.reply("资料已恢复")
|
||||
except Exception as e:
|
||||
await event.reply(f"恢复失败: {e}")
|
||||
```
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **权限**: 修改资料、退出登录等操作通常需要机器人有相应权限。
|
||||
2. **频率限制**: 不要频繁修改资料或状态，可能被限制。
|
||||
3. **客户端支持**: 不是所有 OneBot 客户端都支持全部 API，使用前最好测试一下。
|
||||
4. **谨慎操作**: `bot_exit` 会让机器人下线，谨慎使用。
|
||||
|
||||
## 重复的方法
|
||||
|
||||
`AccountAPI` 中还包含了一些与好友、群组相关的方法，这些方法在其他模块中也有定义：
|
||||
|
||||
- `get_stranger_info()`: 同 [好友 API](./friend.md#get_stranger_info---获取陌生人信息)
|
||||
- `get_friend_list()`: 同 [好友 API](./friend.md#get_friend_list---获取好友列表)
|
||||
- `get_group_list()`: 同 [群组 API](./group.md#get_group_list---获取群列表)
|
||||
|
||||
这些方法在 `AccountAPI` 中的实现可能略有不同（比如缓存逻辑），但功能相同。建议使用对应模块中的版本，因为那些是专门为该功能设计的。
|
||||
|
||||
## 下一步
|
||||
|
||||
- [好友 API](./friend.md): 管理好友相关功能
|
||||
- [群组 API](./group.md): 管理群聊相关功能
|
||||
- [消息 API](./message.md): 怎么发消息、撤回消息
|
||||
Reference in New Issue
Block a user