refactor: 清理未使用的导入和更新文档结构

docs: 添加config_models.py到项目结构文档
docs: 调整数据目录位置到core/data下
docs: 更新权限管理器文档描述
This commit is contained in:
2026-01-09 04:44:52 +08:00
parent cbea484f38
commit 6e659c2d02
7 changed files with 6 additions and 9 deletions

View File

@@ -74,12 +74,12 @@
│ └── thpic.py │ └── thpic.py
├── core/ # NEO 框架核心代码,通常无需修改 ├── core/ # NEO 框架核心代码,通常无需修改
│ ├── api/ │ ├── api/
│ ├── data/ # 数据存储目录 (管理员列表, 权限配置)
│ │ ├── admin.json
│ │ └── permissions.json
│ ├── bot.py │ ├── bot.py
│ ├── ... │ ├── ...
│ └── ws.py │ └── ws.py
├── data/ # 数据存储目录 (管理员列表, 权限配置)
│ ├── admin.json
│ └── permissions.json
├── html/ # 静态网页文件 ├── html/ # 静态网页文件
├── plugins/ # 插件目录,所有机器人的功能模块都在这里 ├── plugins/ # 插件目录,所有机器人的功能模块都在这里
│ ├── admin.py │ ├── admin.py

View File

@@ -4,7 +4,6 @@
这个包集中了机器人核心的单例管理器。 这个包集中了机器人核心的单例管理器。
通过从这里导入,可以确保在整个应用中访问到的都是同一个实例。 通过从这里导入,可以确保在整个应用中访问到的都是同一个实例。
""" """
from ..config_loader import global_config
from .admin_manager import AdminManager from .admin_manager import AdminManager
from .command_manager import matcher as command_manager from .command_manager import matcher as command_manager
from .permission_manager import PermissionManager from .permission_manager import PermissionManager

View File

@@ -13,7 +13,7 @@
""" """
import json import json
import os import os
from typing import Dict, Optional from typing import Dict
from ..utils.logger import logger from ..utils.logger import logger
from ..utils.singleton import Singleton from ..utils.singleton import Singleton

View File

@@ -36,7 +36,7 @@
* **核心职责**: * **核心职责**:
* **权限定义与检查**: 定义了 `ADMIN`, `OP`, `USER` 等权限等级,并提供了 `check_permission` 方法来验证用户权限。 * **权限定义与检查**: 定义了 `ADMIN`, `OP`, `USER` 等权限等级,并提供了 `check_permission` 方法来验证用户权限。
* **数据持久化**: 负责从 `core/data/permissions.json` 文件中加载和保存用户权限设置。 * **数据持久化**: 负责从 `core/data/permissions.json` 文件中加载和保存用户权限设置。
* **与 `AdminManager` 联动**: 在检查权限时,会自动机器人管理员(来自 `AdminManager`)识别为最高权限 `ADMIN` * **与 `AdminManager` 联动**: 在检查权限和获取所有用户权限时,会自动合并机器人管理员(来自 `AdminManager`的数据,将其识别为最高权限 `ADMIN`
### 3. `AdminManager` (全局实例: `admin_manager`) ### 3. `AdminManager` (全局实例: `admin_manager`)

View File

@@ -40,6 +40,7 @@
* `utils/`: 提供被广泛使用的工具类,如 `logger` (日志)、`singleton` (单例模式基类)。 * `utils/`: 提供被广泛使用的工具类,如 `logger` (日志)、`singleton` (单例模式基类)。
* `bot.py`: 定义了 `Bot` 类,这是插件开发者最常与之交互的对象,用于调用所有 OneBot API。 * `bot.py`: 定义了 `Bot` 类,这是插件开发者最常与之交互的对象,用于调用所有 OneBot API。
* `config_loader.py`: 负责解析 `config.toml` 文件,并提供一个全局的 `global_config` 对象。 * `config_loader.py`: 负责解析 `config.toml` 文件,并提供一个全局的 `global_config` 对象。
* `config_models.py`: 使用 Pydantic 定义了配置文件的结构和类型验证。
* `ws.py`: 实现了与 OneBot v11 实现端的 WebSocket 连接、心跳、重连和消息收发。 * `ws.py`: 实现了与 OneBot v11 实现端的 WebSocket 连接、心跳、重连和消息收发。
### `docs/` ### `docs/`

View File

@@ -1,4 +1,3 @@
from core.handlers.event_handler import MessageHandler
from core.managers import command_manager, permission_manager from core.managers import command_manager, permission_manager
from core.permission import Permission from core.permission import Permission
from models.events.message import MessageEvent from models.events.message import MessageEvent

View File

@@ -1,6 +1,4 @@
import pytest
from unittest.mock import MagicMock
from core.managers.command_manager import CommandManager from core.managers.command_manager import CommandManager
class TestPluginReloadMeta: class TestPluginReloadMeta: