Merge pull request #78 from MuRainBot/dev

合并Dev: 重构QQRichText，CommandManager新增自定义异常处理，新增SessionManager，优化一些东西，修复一些bug

Author: xiaosuyyds

config.yml

@@ -26,7 +26,7 @@ qq_data_cache:  # QQ数据缓存设置
 
 debug:  # 调试模式，若启用框架的日志等级将被设置为debug，不建议在生产环境开启
   enable: false  # 是否启用调试模式
-  save_dump: true  # 是否在发生异常的同时保存一个dump错误文件（不受debug.enable约束，独立开关，若要使用请先安装coredumpy库，不使用可不安装）
+  save_dump: false  # 是否在发生异常的同时保存一个dump错误文件（不受debug.enable约束，独立开关，若要使用请先安装coredumpy库，不使用可不安装）
 
 auto_restart_onebot:  # 在Onebot实现端状态异常时自动重启Onebot实现端（需开启心跳包）
   enable: true  # 是否启用自动重启

murainbot/__init__.py

@@ -7,13 +7,17 @@
 if TYPE_CHECKING:
     from .utils import *
     from . import common
+    from . import core
 else:
     def __getattr__(name: str):
         """当访问 murainbot.name 时，按需导入并返回。"""
         if name in __all__:
             module_name = f".utils.{name}"
             if name == "common":
                 module_name = ".common"
+            elif name.startswith("core."):
+                module_name = f".{name}"
+            # print(module_name)
             module = importlib.import_module(module_name, __name__)
             return module
 
@@ -37,5 +41,7 @@ def __dir__():
     "QQDataCacher",
     "StateManager",
     "TimerManager",
-    "common"
+    "SessionManager",
+    "common",
+    "core"
 ]

murainbot/cli.py

@@ -1,7 +1,7 @@
 import shutil
 from pathlib import Path
 import typer
-from typing_extensions import Annotated
+from typing import Annotated
 from rich import print
 
 app = typer.Typer(

murainbot/common.py

@@ -16,6 +16,7 @@
 
 import requests
 
+from .core import ConfigManager
 from .paths import paths
 from .utils import Logger
 
@@ -333,6 +334,27 @@ def save_exc_dump(description: str = None, path: str = None):
     return kwargs["path"]
 
 
+def exc_logger(e: Exception, message: str = None):
+    """
+    记录异常日志并保存dump
+    Args:
+        e: 异常
+        message: 描述
+
+    Returns:
+        None
+    """
+    if ConfigManager.GlobalConfig().debug.save_dump:
+        dump_path = save_exc_dump(message)
+    else:
+        dump_path = None
+    logger.error(
+        f"{message}: {repr(e)}"
+        f"{f"\n已保存异常到 {dump_path}" if dump_path else ""}",
+        exc_info=True
+    )
+
+
 def bytes_io_to_file(
         io_bytes: BytesIO,
         file_name: str | None = None,

murainbot/core/ConfigManager.py

@@ -218,7 +218,7 @@ def init(self):
         )
         self.debug = self.Debug(
             enable=self.get("debug", {}).get("enable", False),
-            save_dump=self.get("debug", {}).get("save_dump", True)
+            save_dump=self.get("debug", {}).get("save_dump", False)
         )
         self.auto_restart_onebot = self.AutoRestartOnebot(
             enable=self.get("auto_restart_onebot", {}).get("enable", True)

murainbot/core/EventManager.py

@@ -2,17 +2,19 @@
 事件管理器，用于管理事件与事件监听器
 """
 import inspect
+import threading
 from collections.abc import Callable
 from dataclasses import dataclass, field
 from typing import Any, TypeVar
 
-from murainbot.common import save_exc_dump
-from murainbot.core import ConfigManager
+from murainbot.common import exc_logger
 from murainbot.core.ThreadPool import async_task
 from murainbot.utils import Logger
 
 logger = Logger.get_logger()
 
+_event_lock = threading.Lock()
+
 
 class _Event:
     """
@@ -34,30 +36,28 @@ def call(self):
         """
         按优先级顺序同步触发所有监听器
         """
-        if self.__class__ in event_listeners:
-            for listener in sorted(event_listeners[self.__class__], key=lambda i: i.priority, reverse=True):
-                try:
-                    res = listener.func(self, **listener.kwargs)
-                except Exception as e:
-                    if ConfigManager.GlobalConfig().debug.save_dump:
-                        dump_path = save_exc_dump(f"监听器中发生错误")
-                    else:
-                        dump_path = None
-                    logger.error(f"监听器中发生错误: {repr(e)}"
-                                 f"{f"\n已保存异常到 {dump_path}" if dump_path else ""}",
-                                 exc_info=True)
-                    continue
-                if res is True:
-                    return True
-            return False
-        return None
+        with _event_lock:
+            if self.__class__ not in event_listeners:
+                return None
+
+            listeners_list = sorted(event_listeners[self.__class__], key=lambda i: i.priority, reverse=True)
+
+        for listener in listeners_list:
+            try:
+                res = listener.func(self, **listener.kwargs)
+            except Exception as e:
+                exc_logger(e, "监听器中发生错误")
+                continue
+            if res is True:
+                return True
+        return False
 
 
 T = TypeVar('T', bound='_Event')
 
 
-# 定义事件监听器的数据类
-@dataclass(order=True)
+# 定义事件监听器的数据类，使用frozen是为了保证数据是只读的来避免可能的线程安全问题
+@dataclass(order=True, frozen=True)
 class EventListener:
     """
     事件监听器数据类
@@ -91,7 +91,8 @@ def event_listener(event_class: type[T], priority: int = 0, **kwargs):
     def wrapper(func: Callable[[T, ...], Any]):
         # 注册事件监听器
         listener = EventListener(priority=priority, func=func, kwargs=kwargs)
-        event_listeners.setdefault(event_class, []).append(listener)
+        with _event_lock:
+            event_listeners.setdefault(event_class, []).append(listener)
         return func
 
     return wrapper
@@ -109,26 +110,25 @@ def unregister_listener(event_class: type[T], func: Callable[[T, ...], Any]):
     if not issubclass(event_class, _Event):
         raise TypeError("event_class 类必须是 _Event 的子类")
 
-    listeners_list = event_listeners.get(event_class)
+    with _event_lock:
+        listeners_list = event_listeners.get(event_class)
 
-    if not listeners_list:
-        raise ValueError(f"事件类型 {event_class.__name__} 没有已注册的监听器。")
+        if not listeners_list:
+            raise ValueError(f"事件类型 {event_class.__name__} 没有已注册的监听器。")
 
-    # 查找所有与给定函数匹配的监听器对象
-    listeners_to_remove = [listener for listener in listeners_list if listener.func == func]
+        # 查找所有与给定函数匹配的监听器对象
+        listeners_to_remove = [listener for listener in listeners_list if listener.func == func]
 
-    if not listeners_to_remove:
-        # 如果没有找到匹配的函数
-        raise ValueError(f"未找到函数 {func.__name__} 对应的监听器，无法为事件 {event_class.__name__} 注销。")
+        if not listeners_to_remove:
+            # 如果没有找到匹配的函数
+            raise ValueError(f"未找到函数 {func.__name__} 对应的监听器，无法为事件 {event_class.__name__} 注销。")
 
-    # 移除所有找到的监听器
-    removed_count = 0
-    for listener_obj in listeners_to_remove:
-        listeners_list.remove(listener_obj)
-        removed_count += 1
+        # 移除所有找到的监听器
+        for listener_obj in listeners_to_remove:
+            listeners_list.remove(listener_obj)
 
-    if not listeners_list:
-        del event_listeners[event_class]
+        if not listeners_list:
+            del event_listeners[event_class]
 
 
 class Event(_Event):
@@ -139,28 +139,29 @@ class Event(_Event):
     def _call_hook(self, listener: EventListener):
         return Hook(self, listener).call()
 
-    def call(self):
+    def call(self) -> list[tuple[EventListener, Any]] | None:
         """
         按优先级顺序同步触发所有监听器
         """
-        if self.__class__ in event_listeners:
-            res_list = []
-            for listener in sorted(event_listeners[self.__class__], key=lambda i: i.priority, reverse=True):
-                if self._call_hook(listener):
-                    logger.debug(f"由 Hook 跳过监听器: {listener.func.__name__}")
-                    continue
-                try:
-                    res = listener.func(self, **listener.kwargs)
-                except Exception as e:
-                    if ConfigManager.GlobalConfig().debug.save_dump:
-                        dump_path = save_exc_dump(f"监听器中发生错误")
-                    else:
-                        dump_path = None
-                    logger.error(f"监听器中发生错误: {repr(e)}"
-                                 f"{f"\n已保存异常到 {dump_path}" if dump_path else ""}",
-                                 exc_info=True)
-                    continue
-                res_list.append(res)
+        with _event_lock:
+            if self.__class__ not in event_listeners:
+                return None
+
+            listeners_list = sorted(event_listeners[self.__class__], key=lambda i: i.priority, reverse=True)
+
+        results = []
+        for listener in listeners_list:
+            if self._call_hook(listener):
+                logger.debug(f"由 Hook 跳过监听器: {listener.func.__name__}")
+                continue
+            try:
+                res = listener.func(self, **listener.kwargs)
+            except Exception as e:
+                exc_logger(e, "监听器中发生错误")
+                continue
+            results.append((listener, res))
+
+        return results
 
     @async_task
     def call_async(self):

murainbot/core/OnebotAPI.py

@@ -12,10 +12,11 @@
 import json
 import traceback
 import urllib.parse
+
 import requests
 
 from . import EventManager, ConfigManager
-from ..common import save_exc_dump
+from ..common import exc_logger
 from ..utils import Logger
 
 logger = Logger.get_logger()
@@ -123,15 +124,7 @@ def get(self, node, data: dict = None, original: bool = None):
             else:
                 return response.json()['data']
         except Exception as e:
-            if ConfigManager.GlobalConfig().debug.save_dump and creat_dump:
-                dump_path = save_exc_dump(f"调用 API: {node} data: {data} 异常")
-            else:
-                dump_path = None
-            logger.error(
-                f"调用 API: {node} data: {data} 异常: {repr(e)}"
-                f"{f"\n已保存异常到 {dump_path}" if dump_path else ""}",
-                exc_info=True
-            )
+            exc_logger(e, f"调用 API: {node} data: {data} 异常")
             raise e
 
     def send_private_msg(self, user_id: int, message: str | list[dict]):

murainbot/core/PluginManager.py

@@ -10,7 +10,7 @@
 from types import ModuleType
 from typing import TypedDict
 
-from murainbot.common import save_exc_dump
+from murainbot.common import exc_logger
 from murainbot.paths import paths
 from murainbot.core import ConfigManager
 from murainbot.utils.Logger import get_logger
@@ -158,13 +158,7 @@ def load_plugins():
             logger.warning(f"插件 {name}({full_path}) 已被禁用，将不会被加载")
             continue
         except Exception as e:
-            if ConfigManager.GlobalConfig().debug.save_dump:
-                dump_path = save_exc_dump(f"尝试加载插件 {full_path} 时失败")
-            else:
-                dump_path = None
-            logger.error(f"尝试加载插件 {full_path} 时失败！ 原因:{repr(e)}"
-                         f"{f"\n已保存异常到 {dump_path}" if dump_path else ""}",
-                         exc_info=True)
+            exc_logger(e, f"尝试加载插件 {full_path} 时失败")
             continue
 
         logger.debug(f"插件 {name}({full_path}) 加载成功！")
@@ -188,17 +182,12 @@ def requirement_plugin(plugin_name: str):
                     plugin["info"] = plugin_info
                     plugin["plugin"] = module
                     plugins.append(plugin)
-                except NotEnabledPluginException:
-                    logger.error(f"被依赖的插件 {plugin_name} 已被禁用，无法加载依赖")
-                    raise Exception(f"被依赖的插件 {plugin_name} 已被禁用，无法加载依赖")
+                except NotEnabledPluginException as e:
+                    msg = f"被依赖的插件 {plugin_name} 已被禁用，无法加载依赖"
+                    logger.error(msg)
+                    raise Exception(msg) from e
                 except Exception as e:
-                    if ConfigManager.GlobalConfig().debug.save_dump:
-                        dump_path = save_exc_dump(f"尝试加载被依赖的插件 {plugin_name} 时失败！")
-                    else:
-                        dump_path = None
-                    logger.error(f"尝试加载被依赖的插件 {plugin_name} 时失败！ 原因:{repr(e)}"
-                                 f"{f"\n已保存异常到 {dump_path}" if dump_path else ""}",
-                                 exc_info=True)
+                    exc_logger(e, f"尝试加载被依赖的插件 {plugin_name} 时失败")
                     raise e
                 logger.debug(f"由于插件依赖，插件 {plugin_name} 加载成功！")
             else:

murainbot/core/ThreadPool.py

@@ -6,8 +6,7 @@
 import atexit
 from concurrent.futures import ThreadPoolExecutor
 
-from murainbot.common import save_exc_dump
-from murainbot.core import ConfigManager
+from murainbot.common import exc_logger
 from murainbot.core.ConfigManager import GlobalConfig
 from murainbot.utils.Logger import get_logger
 
@@ -41,16 +40,7 @@ def _wrapper(func, *args, **kwargs):
     try:
         return func(*args, **kwargs)
     except Exception as e:
-        if ConfigManager.GlobalConfig().debug.save_dump:
-            dump_path = save_exc_dump(f"Error in async task({func.__module__}.{func.__name__})")
-        else:
-            dump_path = None
-        # 打印到日志中
-        logger.error(
-            f"Error in async task({func.__module__}.{func.__name__}): {repr(e)}"
-            f"{f"\n已保存异常到 {dump_path}" if dump_path else ""}",
-            exc_info=True
-        )
+        exc_logger(e, f"Error in async task({func.__module__}.{func.__name__})")
         return None