ErisPulse 2.1.14.dev1__tar.gz → 2.1.14.dev2__tar.gz

{erispulse-2.1.14.dev1 → erispulse-2.1.14.dev2}/PKG-INFO

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

{erispulse-2.1.14.dev1 → erispulse-2.1.14.dev2}/docs/AIDocs/ErisPulse-AdapterDev.md

@@ -113,14 +113,34 @@ if module_config is None:
     config.setConfig("MyModule", {"MyKey": "MyValue"})  # 设置默认配置
 ```
 
+### 4. 异常处理模块(exceptions)
+```python
+# ErisPulse提供了统一的异常处理机制，可以自动捕获和格式化异常信息
+# 对于异步代码，可以为特定事件循环设置异常处理器
+
+import asyncio
+from ErisPulse.Core import exceptions
+
+# 为当前运行的事件循环设置异常处理器
+loop = asyncio.get_running_loop()
+exceptions.setup_async_loop(loop)
+
+# 或者不传参数，自动获取当前事件循环 || 但不建议这么做，因为运行主程序时可能使用了其他的异步库
+exceptions.setup_async_loop()
+
+# 这样设置后，异步代码中的未捕获异常会被统一处理并格式化输出
+```
+
 ### 建议
 1. 模块配置应使用`getConfig/setConfig`操作config.toml
 2. 持久信息存储使用`get/set`操作数据库
 3. 关键操作使用事务保证原子性
+4. 对于自定义事件循环，使用`exceptions.setup_async_loop()`方法确保异常被正确处理
 > 其中，1-2 步骤可以实现配合，比如硬配置让用户设置后，和数据库中的配置进行合并，实现配置的动态更新
 
 更多详细信息请参考[API文档](docs/api/)
 
+
 <!--- End of UseCore.md -->
 
 <!-- Adapter.md -->
@@ -894,7 +914,7 @@ def generate_message_id(platform: str, raw_id: str) -> str:
 
 # 📦 `ErisPulse.__init__` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -932,8 +952,7 @@ ErisPulse SDK 主模块
 <div class='admonition warning'><p class='admonition-title'>内部方法</p><p></p></div>
 准备运行环境
 
-1. 初始化项目环境文件
-2. 加载环境变量配置
+初始化项目环境文件
 
 :return: bool 环境准备是否成功
 
@@ -1204,13 +1223,13 @@ SDK初始化入口
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## ErisPulse\__main__.md
 
 # 📦 `ErisPulse.__main__` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -1519,13 +1538,13 @@ ErisPulse命令行接口
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## ErisPulse\Core\adapter.md
 
 # 📦 `ErisPulse.Core.adapter` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -1921,13 +1940,13 @@ OneBot12协议事件监听装饰器
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## ErisPulse\Core\config.md
 
 # 📦 `ErisPulse.Core.config` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -1941,57 +1960,13 @@ ErisPulse 配置中心
 
 ---
 
-## 🛠️ 函数
-
-### `_ensure_config_structure(config: Dict[str, Any])`
-
-确保配置结构完整，补全缺失的配置项
-
-:param config: 当前配置
-:return: 补全后的完整配置
-
----
-
-### `get_config()`
-
-获取当前配置，自动补全缺失的配置项并保存
-
-:return: 完整的配置字典
-
----
-
-### `update_config(new_config: Dict[str, Any])`
-
-更新配置，自动补全缺失的配置项
-
-:param new_config: 新的配置字典
-:return: 是否更新成功
-
----
-
-### `get_server_config()`
-
-获取服务器配置，确保结构完整
-
-:return: 服务器配置字典
-
----
-
-### `get_logger_config()`
-
-获取日志配置，确保结构完整
-
-:return: 日志配置字典
-
----
-
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## ErisPulse\Core\env.md
 
 # 📦 `ErisPulse.Core.env` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -2324,90 +2299,124 @@ ErisPulse 环境配置模块
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
-## ErisPulse\Core\exceptions.md
+## ErisPulse\Core\erispulse_config.md
 
-# 📦 `ErisPulse.Core.exceptions` 模块
+# 📦 `ErisPulse.Core.erispulse_config` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
 ## 模块概述
 
 
-ErisPulse 全局异常处理系统
+ErisPulse 框架配置管理
 
-提供统一的异常捕获和格式化功能，支持同步和异步代码的异常处理。
+专门管理 ErisPulse 框架自身的配置项。
 
 ---
 
 ## 🛠️ 函数
 
-### `global_exception_handler(exc_type: Type[Exception], exc_value: Exception, exc_traceback: Any)`
+### `_ensure_erispulse_config_structure(config_dict: Dict[str, Any])`
 
-全局异常处理器
+确保 ErisPulse 配置结构完整，补全缺失的配置项
 
-:param exc_type: 异常类型
-:param exc_value: 异常值
-:param exc_traceback: 追踪信息
+:param config_dict: 当前配置
+:return: 补全后的完整配置
 
 ---
 
-### `async_exception_handler(loop: asyncio.AbstractEventLoop, context: Dict[str, Any])`
+### `get_erispulse_config()`
 
-异步异常处理器
+获取 ErisPulse 框架配置，自动补全缺失的配置项并保存
 
-:param loop: 事件循环
-:param context: 上下文字典
+:return: 完整的 ErisPulse 配置字典
 
 ---
 
-### `setup_async_exception_handler(loop: asyncio.AbstractEventLoop = None)`
+### `update_erispulse_config(new_config: Dict[str, Any])`
 
-设置异步异常处理器
+更新 ErisPulse 配置，自动补全缺失的配置项
 
-:param loop: 事件循环，如果为None则使用当前事件循环
+:param new_config: 新的配置字典
+:return: 是否更新成功
 
 ---
 
-## 🏛️ 类
+### `get_server_config()`
+
+获取服务器配置，确保结构完整
 
-### `class ExceptionHandler`
+:return: 服务器配置字典
 
-异常处理器类
+---
 
+### `get_logger_config()`
 
-#### 🧰 方法
+获取日志配置，确保结构完整
+
+:return: 日志配置字典
+
+---
+
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
+
+## ErisPulse\Core\exceptions.md
+
+# 📦 `ErisPulse.Core.exceptions` 模块
+
+<sup>自动生成于 2025-08-02 01:50:12</sup>
+
+---
+
+## 模块概述
+
+
+ErisPulse 全局异常处理系统
+
+提供统一的异常捕获和格式化功能，支持同步和异步代码的异常处理。
+
+---
 
-##### `format_exception(exc_type: Type[Exception], exc_value: Exception, exc_traceback: Any)`
+## 🛠️ 函数
+
+### `global_exception_handler(exc_type: Type[Exception], exc_value: Exception, exc_traceback: Any)`
 
-格式化异常信息
+全局异常处理器
 
 :param exc_type: 异常类型
 :param exc_value: 异常值
 :param exc_traceback: 追踪信息
-:return: 格式化后的异常信息
 
 ---
 
-##### `format_async_exception(exception: Exception)`
+### `async_exception_handler(loop: asyncio.AbstractEventLoop, context: Dict[str, Any])`
+
+异步异常处理器
+
+:param loop: 事件循环
+:param context: 上下文字典
+
+---
+
+### `setup_async_loop(loop: asyncio.AbstractEventLoop = None)`
 
-格式化异步异常信息
+为指定的事件循环设置异常处理器
 
-:param exception: 异常对象
-:return: 格式化后的异常信息
+:param loop: 事件循环实例，如果为None则使用当前事件循环
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## ErisPulse\Core\logger.md
 
 # 📦 `ErisPulse.Core.logger` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -2494,13 +2503,13 @@ ErisPulse 日志系统
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## ErisPulse\Core\mods.md
 
 # 📦 `ErisPulse.Core.mods` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -2709,13 +2718,13 @@ ErisPulse 模块管理器
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## ErisPulse\Core\router.md
 
 # 📦 `ErisPulse.Core.router` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -2823,6 +2832,6 @@ ErisPulse 路由系统
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 <!--- End of API文档 -->

{erispulse-2.1.14.dev1 → erispulse-2.1.14.dev2}/docs/AIDocs/ErisPulse-Core.md

@@ -204,14 +204,34 @@ if module_config is None:
     config.setConfig("MyModule", {"MyKey": "MyValue"})  # 设置默认配置
 ```
 
+### 4. 异常处理模块(exceptions)
+```python
+# ErisPulse提供了统一的异常处理机制，可以自动捕获和格式化异常信息
+# 对于异步代码，可以为特定事件循环设置异常处理器
+
+import asyncio
+from ErisPulse.Core import exceptions
+
+# 为当前运行的事件循环设置异常处理器
+loop = asyncio.get_running_loop()
+exceptions.setup_async_loop(loop)
+
+# 或者不传参数，自动获取当前事件循环 || 但不建议这么做，因为运行主程序时可能使用了其他的异步库
+exceptions.setup_async_loop()
+
+# 这样设置后，异步代码中的未捕获异常会被统一处理并格式化输出
+```
+
 ### 建议
 1. 模块配置应使用`getConfig/setConfig`操作config.toml
 2. 持久信息存储使用`get/set`操作数据库
 3. 关键操作使用事务保证原子性
+4. 对于自定义事件循环，使用`exceptions.setup_async_loop()`方法确保异常被正确处理
 > 其中，1-2 步骤可以实现配合，比如硬配置让用户设置后，和数据库中的配置进行合并，实现配置的动态更新
 
 更多详细信息请参考[API文档](docs/api/)
 
+
 <!--- End of UseCore.md -->
 
 <!-- PlatformFeatures.md -->
@@ -795,7 +815,7 @@ ErisPulse 项目：
 
 # 📦 `ErisPulse.Core.adapter` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -1191,13 +1211,13 @@ OneBot12协议事件监听装饰器
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## config.md
 
 # 📦 `ErisPulse.Core.config` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -1211,57 +1231,13 @@ ErisPulse 配置中心
 
 ---
 
-## 🛠️ 函数
-
-### `_ensure_config_structure(config: Dict[str, Any])`
-
-确保配置结构完整，补全缺失的配置项
-
-:param config: 当前配置
-:return: 补全后的完整配置
-
----
-
-### `get_config()`
-
-获取当前配置，自动补全缺失的配置项并保存
-
-:return: 完整的配置字典
-
----
-
-### `update_config(new_config: Dict[str, Any])`
-
-更新配置，自动补全缺失的配置项
-
-:param new_config: 新的配置字典
-:return: 是否更新成功
-
----
-
-### `get_server_config()`
-
-获取服务器配置，确保结构完整
-
-:return: 服务器配置字典
-
----
-
-### `get_logger_config()`
-
-获取日志配置，确保结构完整
-
-:return: 日志配置字典
-
----
-
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## env.md
 
 # 📦 `ErisPulse.Core.env` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -1594,90 +1570,124 @@ ErisPulse 环境配置模块
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
-## exceptions.md
+## erispulse_config.md
 
-# 📦 `ErisPulse.Core.exceptions` 模块
+# 📦 `ErisPulse.Core.erispulse_config` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
 ## 模块概述
 
 
-ErisPulse 全局异常处理系统
+ErisPulse 框架配置管理
 
-提供统一的异常捕获和格式化功能，支持同步和异步代码的异常处理。
+专门管理 ErisPulse 框架自身的配置项。
 
 ---
 
 ## 🛠️ 函数
 
-### `global_exception_handler(exc_type: Type[Exception], exc_value: Exception, exc_traceback: Any)`
+### `_ensure_erispulse_config_structure(config_dict: Dict[str, Any])`
 
-全局异常处理器
+确保 ErisPulse 配置结构完整，补全缺失的配置项
 
-:param exc_type: 异常类型
-:param exc_value: 异常值
-:param exc_traceback: 追踪信息
+:param config_dict: 当前配置
+:return: 补全后的完整配置
 
 ---
 
-### `async_exception_handler(loop: asyncio.AbstractEventLoop, context: Dict[str, Any])`
+### `get_erispulse_config()`
 
-异步异常处理器
+获取 ErisPulse 框架配置，自动补全缺失的配置项并保存
 
-:param loop: 事件循环
-:param context: 上下文字典
+:return: 完整的 ErisPulse 配置字典
 
 ---
 
-### `setup_async_exception_handler(loop: asyncio.AbstractEventLoop = None)`
+### `update_erispulse_config(new_config: Dict[str, Any])`
 
-设置异步异常处理器
+更新 ErisPulse 配置，自动补全缺失的配置项
 
-:param loop: 事件循环，如果为None则使用当前事件循环
+:param new_config: 新的配置字典
+:return: 是否更新成功
 
 ---
 
-## 🏛️ 类
+### `get_server_config()`
+
+获取服务器配置，确保结构完整
+
+:return: 服务器配置字典
 
-### `class ExceptionHandler`
+---
 
-异常处理器类
+### `get_logger_config()`
 
+获取日志配置，确保结构完整
 
-#### 🧰 方法
+:return: 日志配置字典
 
-##### `format_exception(exc_type: Type[Exception], exc_value: Exception, exc_traceback: Any)`
+---
 
-格式化异常信息
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
+
+## exceptions.md
+
+# 📦 `ErisPulse.Core.exceptions` 模块
+
+<sup>自动生成于 2025-08-02 01:50:12</sup>
+
+---
+
+## 模块概述
+
+
+ErisPulse 全局异常处理系统
+
+提供统一的异常捕获和格式化功能，支持同步和异步代码的异常处理。
+
+---
+
+## 🛠️ 函数
+
+### `global_exception_handler(exc_type: Type[Exception], exc_value: Exception, exc_traceback: Any)`
+
+全局异常处理器
 
 :param exc_type: 异常类型
 :param exc_value: 异常值
 :param exc_traceback: 追踪信息
-:return: 格式化后的异常信息
 
 ---
 
-##### `format_async_exception(exception: Exception)`
+### `async_exception_handler(loop: asyncio.AbstractEventLoop, context: Dict[str, Any])`
+
+异步异常处理器
+
+:param loop: 事件循环
+:param context: 上下文字典
+
+---
+
+### `setup_async_loop(loop: asyncio.AbstractEventLoop = None)`
 
-格式化异步异常信息
+为指定的事件循环设置异常处理器
 
-:param exception: 异常对象
-:return: 格式化后的异常信息
+:param loop: 事件循环实例，如果为None则使用当前事件循环
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## logger.md
 
 # 📦 `ErisPulse.Core.logger` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -1764,13 +1774,13 @@ ErisPulse 日志系统
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## mods.md
 
 # 📦 `ErisPulse.Core.mods` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -1979,13 +1989,13 @@ ErisPulse 模块管理器
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 ## router.md
 
 # 📦 `ErisPulse.Core.router` 模块
 
-<sup>自动生成于 2025-08-01 14:55:50</sup>
+<sup>自动生成于 2025-08-02 01:50:12</sup>
 
 ---
 
@@ -2093,6 +2103,6 @@ ErisPulse 路由系统
 
 ---
 
-<sub>文档最后更新于 2025-08-01 14:55:50</sub>
+<sub>文档最后更新于 2025-08-02 01:50:12</sub>
 
 <!--- End of API文档 -->