ErisPulse 2.1.12__tar.gz → 2.1.13rc2__tar.gz

{erispulse-2.1.12 → erispulse-2.1.13rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ErisPulse
-Version: 2.1.12
+Version: 2.1.13rc2
 Summary: ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。
 Author-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>, runoneall <runoobsteve@gmail.com>
 License: MIT License

{erispulse-2.1.12 → erispulse-2.1.13rc2}/docs/AIDocs/ErisPulse-AdapterDev.md

@@ -919,7 +919,7 @@ def generate_message_id(platform: str, raw_id: str) -> str:
 
 # 📦 `ErisPulse.__init__` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -1250,67 +1250,98 @@ SDK初始化入口
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## ErisPulse\__main__.md
 
 # 📦 `ErisPulse.__main__` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
-## 🛠️ 函数
+## 模块概述
 
-### `start_reloader`
+ErisPulse SDK 命令行工具
 
-启动热重载监控
+提供ErisPulse生态系统的包管理、模块控制和开发工具功能。
+
+💡 **提示**：
 
-:param script_path: str 要监控的脚本路径
-:param reload_mode: bool 是否启用完整重载模式 (默认: False)
+1. 需要Python 3.8+环境
+2. Windows平台需要colorama支持ANSI颜色
 
 ---
 
-### `get_erispulse_version`
+## 🛠️ 函数
+
+### `main`
+
+CLI入口点
 
-获取当前安装的ErisPulse版本
+💡 **提示**：
 
-:return: str ErisPulse版本号或"unknown version"
+1. 创建CLI实例并运行
+2. 处理全局异常
 
 ---
 
-### `main`
+## 🏛️ 类
 
-CLI主入口
+### `CommandHighlighter`
 
-解析命令行参数并执行相应命令
+高亮CLI命令和参数
 
----
+💡 **提示**：
 
-## 🏛️ 类
+使用正则表达式匹配命令行参数和选项
+
+
+### `PackageManager`
 
-### `PyPIManager`
+ErisPulse包管理器
 
-PyPI包管理器
+提供包安装、卸载、升级和查询功能
 
-负责与PyPI交互，包括搜索、安装、卸载和升级ErisPulse模块/适配器
+💡 **提示**：
+
+1. 支持本地和远程包管理
+2. 包含1小时缓存机制
 
 
 #### 🧰 方法
 
+##### `__init__`
+
+初始化包管理器
+
+---
+
+##### 🔹 `async` `_fetch_remote_packages`
+
+从指定URL获取远程包数据
+
+:param url: 远程包数据URL
+:return: 解析后的JSON数据，失败返回None
+
+⚠️ **可能抛出**: `ClientError` - 网络请求失败时抛出
+⚠️ **可能抛出**: `JSONDecodeError` - JSON解析失败时抛出
+
+---
+
 ##### 🔹 `async` `get_remote_packages`
 
-获取远程包列表
+获取远程包列表，带缓存机制
 
-从配置的远程源获取所有可用的ErisPulse模块和适配器
+:param force_refresh: 是否强制刷新缓存
+:return: 包含模块和适配器的字典
 
-:return: 
-    Dict[str, Dict]: 包含模块和适配器的字典
-        - modules: 模块字典 {模块名: 模块信息}
-        - adapters: 适配器字典 {适配器名: 适配器信息}
-        
-⚠️ **可能抛出**: `ClientError` - 当网络请求失败时抛出
-:raises asyncio.TimeoutError: 当请求超时时抛出
+:return:
+    dict: {
+        "modules": {模块名: 模块信息},
+        "adapters": {适配器名: 适配器信息},
+        "cli_extensions": {扩展名: 扩展信息}
+    }
 
 ---
 
@@ -1318,30 +1349,45 @@ PyPI包管理器
 
 获取已安装的包信息
 
-:return: 
-    Dict[str, Dict[str, Dict[str, str]]]: 已安装包字典
-        - modules: 已安装模块 {模块名: 模块信息}
-        - adapters: 已安装适配器 {适配器名: 适配器信息}
+:return: 已安装包字典，包含模块、适配器和CLI扩展
+
+:return:
+    dict: {
+        "modules": {模块名: 模块信息},
+        "adapters": {适配器名: 适配器信息},
+        "cli_extensions": {扩展名: 扩展信息}
+    }
+
+---
+
+##### `_is_module_enabled`
+
+检查模块是否启用
+
+:param module_name: 模块名称
+:return: 模块是否启用
+
+⚠️ **可能抛出**: `ImportError` - 核心模块不可用时抛出
 
 ---
 
-##### `uv_install_package`
+##### `_run_pip_command`
 
-优先使用uv安装包
+执行pip命令
 
-:param package_name: str 要安装的包名
-:param upgrade: bool 是否升级已安装的包 (默认: False)
-:return: bool 安装是否成功
+:param args: pip命令参数列表
+:param description: 进度条描述
+:return: 命令是否成功执行
 
 ---
 
 ##### `install_package`
 
-安装指定包 (修改后优先尝试uv)
+安装指定包
 
-:param package_name: str 要安装的包名
-:param upgrade: bool 是否升级已安装的包 (默认: False)
-:return: bool 安装是否成功
+:param package_name: 要安装的包名
+:param upgrade: 是否升级已安装的包
+:return: 安装是否成功
 
 ---
 
@@ -1349,8 +1395,8 @@ PyPI包管理器
 
 卸载指定包
 
-:param package_name: str 要卸载的包名
-:return: bool 卸载是否成功
+:param package_name: 要卸载的包名
+:return: 卸载是否成功
 
 ---
 
@@ -1358,22 +1404,46 @@ PyPI包管理器
 
 升级所有已安装的ErisPulse包
 
-:return: bool 升级是否成功
+:return: 升级是否成功
+
+⚠️ **可能抛出**: `KeyboardInterrupt` - 用户取消操作时抛出
 
 ---
 
 ### `ReloadHandler`
 
-热重载处理器
+文件系统事件处理器
 
-监控文件变化并自动重启脚本
+实现热重载功能，监控文件变化并重启进程
+
+💡 **提示**：
+
+1. 支持.py文件修改重载
+2. 支持配置文件修改重载
 
 
 #### 🧰 方法
 
+##### `__init__`
+
+初始化处理器
+
+:param script_path: 要监控的脚本路径
+:param reload_mode: 是否启用重载模式
+
+---
+
 ##### `start_process`
 
-启动/重启被监控的进程
+启动监控进程
+
+---
+
+##### `_terminate_process`
+
+终止当前进程
+
+:raises subprocess.TimeoutExpired: 进程终止超时时抛出
 
 ---
 
@@ -1381,18 +1451,131 @@ PyPI包管理器
 
 文件修改事件处理
 
-:param event: FileSystemEvent 文件系统事件对象
+:param event: 文件系统事件
+
+---
+
+##### `_handle_reload`
+
+处理重载逻辑
+
+:param event: 文件系统事件
+:param reason: 重载原因描述
+
+---
+
+### `CLI`
+
+ErisPulse命令行接口
+
+提供完整的命令行交互功能
+
+💡 **提示**：
+
+1. 支持动态加载第三方命令
+2. 支持模块化子命令系统
+
+
+#### 🧰 方法
+
+##### `__init__`
+
+初始化CLI
+
+---
+
+##### `_create_parser`
+
+创建命令行参数解析器
+
+:return: 配置好的ArgumentParser实例
+
+---
+
+##### `_load_external_commands`
+
+加载第三方CLI命令
+
+:param subparsers: 子命令解析器
+
+⚠️ **可能抛出**: `ImportError` - 加载命令失败时抛出
+
+---
+
+##### `_print_version`
+
+打印版本信息
+
+---
+
+##### `_print_installed_packages`
+
+打印已安装包信息
+
+:param pkg_type: 包类型 (modules/adapters/cli/all)
+:param outdated_only: 是否只显示可升级的包
+
+---
+
+##### `_print_remote_packages`
+
+打印远程包信息
+
+:param pkg_type: 包类型 (modules/adapters/cli/all)
+
+---
+
+##### `_is_package_outdated`
+
+检查包是否过时
+
+:param package_name: 包名
+:param current_version: 当前版本
+:return: 是否有新版本可用
+
+---
+
+##### `_resolve_package_name`
+
+解析简称到完整包名
+
+:param short_name: 模块/适配器简称
+:return: 完整包名，未找到返回None
+
+---
+
+##### `_setup_watchdog`
+
+设置文件监控
+
+:param script_path: 要监控的脚本路径
+:param reload_mode: 是否启用重载模式
+
+---
+
+##### `_cleanup`
+
+清理资源
+
+---
+
+##### `run`
+
+运行CLI
+
+⚠️ **可能抛出**: `KeyboardInterrupt` - 用户中断时抛出
+⚠️ **可能抛出**: `Exception` - 命令执行失败时抛出
 
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## ErisPulse\Core\adapter.md
 
 # 📦 `ErisPulse.Core.adapter` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -1737,13 +1920,13 @@ OneBot12协议事件监听装饰器
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## ErisPulse\Core\config.md
 
 # 📦 `ErisPulse.Core.config` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -1801,13 +1984,13 @@ ErisPulse 配置中心
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## ErisPulse\Core\env.md
 
 # 📦 `ErisPulse.Core.env` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -2093,13 +2276,13 @@ ErisPulse 环境配置模块
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## ErisPulse\Core\logger.md
 
 # 📦 `ErisPulse.Core.logger` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -2190,13 +2373,13 @@ ErisPulse 日志系统
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## ErisPulse\Core\mods.md
 
 # 📦 `ErisPulse.Core.mods` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -2378,13 +2561,13 @@ ErisPulse 模块管理器
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## ErisPulse\Core\raiserr.md
 
 # 📦 `ErisPulse.Core.raiserr` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:32*
 
 ---
 
@@ -2477,13 +2660,13 @@ ErisPulse 错误管理系统
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:32*
 
 ## ErisPulse\Core\server.md
 
 # 📦 `ErisPulse.Core.server` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:32*
 
 ---
 
@@ -2604,13 +2787,13 @@ ErisPulse Adapter Server
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:32*
 
 ## ErisPulse\Core\util.md
 
 # 📦 `ErisPulse.Core.util` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:32*
 
 ---
 
@@ -2704,6 +2887,6 @@ ErisPulse 工具函数集合
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:32*
 
 <!--- End of API文档 -->

{erispulse-2.1.12 → erispulse-2.1.13rc2}/docs/AIDocs/ErisPulse-Core.md

@@ -811,7 +811,7 @@ ErisPulse 项目：
 
 # 📦 `ErisPulse.Core.adapter` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -1156,13 +1156,13 @@ OneBot12协议事件监听装饰器
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## config.md
 
 # 📦 `ErisPulse.Core.config` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -1220,13 +1220,13 @@ ErisPulse 配置中心
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## env.md
 
 # 📦 `ErisPulse.Core.env` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -1512,13 +1512,13 @@ ErisPulse 环境配置模块
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## logger.md
 
 # 📦 `ErisPulse.Core.logger` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -1609,13 +1609,13 @@ ErisPulse 日志系统
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## mods.md
 
 # 📦 `ErisPulse.Core.mods` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:31*
 
 ---
 
@@ -1797,13 +1797,13 @@ ErisPulse 模块管理器
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:31*
 
 ## raiserr.md
 
 # 📦 `ErisPulse.Core.raiserr` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:32*
 
 ---
 
@@ -1896,13 +1896,13 @@ ErisPulse 错误管理系统
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:32*
 
 ## server.md
 
 # 📦 `ErisPulse.Core.server` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:32*
 
 ---
 
@@ -2023,13 +2023,13 @@ ErisPulse Adapter Server
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:32*
 
 ## util.md
 
 # 📦 `ErisPulse.Core.util` 模块
 
-*自动生成于 2025-07-21 17:57:00*
+*自动生成于 2025-07-22 16:35:32*
 
 ---
 
@@ -2123,6 +2123,6 @@ ErisPulse 工具函数集合
 ---
 
 
-*文档最后更新于 2025-07-21 17:57:00*
+*文档最后更新于 2025-07-22 16:35:32*
 
 <!--- End of API文档 -->