Merge pull request #75 from MuRainBot/dev

合并Dev：实现会话等待功能，允许通过yield的方式等待自定义内容，发生后再恢复执行的功能，实现TimerManager，统一简单的定时任务，减少开销

Author: xiaosuyyds

.gitignore

@@ -1,16 +1,61 @@
-# 默认忽略的文件
-/shelf/
-/workspace.xml
-# 基于编辑器的 HTTP 客户端请求
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
 
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Environments
+.env
+.venv
+venv/
+ENV/
+env/
+env.bak/
+venv.bak/
+
+# IDE / Editor specific
+.idea/
+.vscode/
+*.swp
+*~
+
+# MuRainBot
 *.log
-/.idea
-*.pyc
 *.dump
-test.py
-*.zip
-/MURainBot2
+/test.py

main.py

@@ -1,7 +1,8 @@
 """
 MuRainBot2
 """
+import os
 
 from murainbot.main import start
 
-start()
+start(os.path.dirname(os.path.abspath(__file__)))

murainbot/__init__.py

@@ -1,12 +1,29 @@
 """
-MRB2 Lib 工具模块
+MRB2 Lib
 """
 from typing import TYPE_CHECKING
 import importlib
 
 if TYPE_CHECKING:
     from .utils import *
     from . import common
+else:
+    def __getattr__(name: str):
+        """当访问 murainbot.name 时，按需导入并返回。"""
+        if name in __all__:
+            module_name = f".utils.{name}"
+            if name == "common":
+                module_name = ".common"
+            module = importlib.import_module(module_name, __name__)
+            return module
+
+        raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
+
+
+    def __dir__():
+        """让 dir(murainbot) 和 tab 自动补全能正常工作。"""
+        return list(__all__)
+
 
 __all__ = [
     "Logger",
@@ -19,22 +36,6 @@
     "PluginConfig",
     "QQDataCacher",
     "StateManager",
+    "TimerManager",
     "common"
 ]
-
-
-def __getattr__(name: str):
-    """当访问 murainbot.name 时，按需导入并返回。"""
-    if name in __all__:
-        module_name = f".utils.{name}"
-        if name == "common":
-            module_name = ".common"
-        module = importlib.import_module(module_name, __name__)
-        return module
-
-    raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
-
-
-def __dir__():
-    """让 dir(murainbot) 和 tab 自动补全能正常工作。"""
-    return list(__all__)

murainbot/cli.py

@@ -25,10 +25,11 @@
 .Python
 env/
 venv/
+.venv/
 .env
 
 # MuRainBot
-/data/
+/data/cache/
 /logs/
 /exc_dumps/
 *.db

murainbot/core/EventManager.py

@@ -6,10 +6,10 @@
 from dataclasses import dataclass, field
 from typing import Any, TypeVar
 
-from murainbot.core.ThreadPool import async_task
+from murainbot.common import save_exc_dump
 from murainbot.core import ConfigManager
+from murainbot.core.ThreadPool import async_task
 from murainbot.utils import Logger
-from murainbot.common import save_exc_dump
 
 logger = Logger.get_logger()
 
@@ -26,7 +26,7 @@ class Hook(_Event):
     钩子事件，用于在事件处理过程中跳过某些监听器
     """
 
-    def __init__(self, event, listener):
+    def __init__(self, event: "Event", listener: "EventListener"):
         self.event = event
         self.listener = listener
 
@@ -136,7 +136,7 @@ class Event(_Event):
     基事件类，所有自定义事件均继承自此类，继承自此类以创建自定义事件
     """
 
-    def _call_hook(self, listener):
+    def _call_hook(self, listener: EventListener):
         return Hook(self, listener).call()
 
     def call(self):
@@ -167,7 +167,7 @@ def call_async(self):
         """
         无需等待的异步按优先级顺序触发所有监听器
         """
-        self.call()
+        return self.call()
 
 
 if __name__ == "__main__":

murainbot/main.py

@@ -41,12 +41,14 @@ def get_gradient(start_color: tuple[int, int, int], end_color: tuple[int, int, i
     )
 
 
-def start(work_path=os.path.dirname(os.path.dirname(os.path.abspath(__file__)))):
+def start(work_path=None):
     """
     启动MRB2
     Args:
-        work_path: MRB2实例的工作目录，默认为安装目录，谨慎填写
+        work_path: MRB2实例的工作目录，默认为os.getcwd()，谨慎填写
     """
+    if work_path is None:
+        work_path = os.getcwd()
     paths.init_paths(work_path)
     paths.paths.ensure_all_dirs_exist()
 
@@ -87,7 +89,7 @@ def start(work_path=os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
     from . import common
     atexit.register(common.finalize_and_cleanup)
 
-    from .utils import AutoRestartOnebot
+    from .utils import AutoRestartOnebot, TimerManager
 
     Logger.set_logger_level(logging.DEBUG if ConfigManager.GlobalConfig().debug.enable else logging.INFO)
     live.stop()
@@ -130,7 +132,8 @@ def start(work_path=os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
                     ]
                 )}")
 
-    threading.Thread(target=AutoRestartOnebot.check_heartbeat, daemon=True).start()
+    threading.Thread(target=TimerManager.run_timer, daemon=True).start()
+    TimerManager.delay(0, AutoRestartOnebot.check_heartbeat)
 
     logger.info(f"启动监听服务器: {ConfigManager.GlobalConfig().server.server}")
 

murainbot/paths.py

@@ -31,8 +31,80 @@ def ensure_all_dirs_exist(self):
         self.CACHE_PATH.mkdir(exist_ok=True)
 
 
-# 全局变量，在CLI启动时被赋值
-paths: PathManager = None
+class PathManagerProxy:
+    """
+    路径代理类，会在首次操作时把自己替换掉。
+    """
+
+    def __init__(self):
+        """
+        初始化代理对象，存储初始化 PathManager 所需的 work_path。
+        """
+        object.__setattr__(self, '_initialized', False)  # 标记是否已初始化真实对象
+
+    def _initialize_and_transform(self):
+        """
+        这个函数负责初始化真正的 PathManager 实例，并使代理对象“替换掉自己”。
+        它通过改变自身的 __class__ 和更新 __dict__ 来实现。
+        """
+        if object.__getattribute__(self, '_initialized'):
+            return  # 已经初始化过了，直接返回
+
+        work_path = os.getcwd()
+
+        print(f"由于Path在未被正常初始化的时候调用，临时初始化，工作目录: {work_path}")
+
+        init_paths(work_path)
+        real_instance = paths
+
+        self.__dict__.update(real_instance.__dict__)
+
+        self.__class__ = PathManager
+
+        object.__setattr__(self, '_initialized', True)
+
+    def __getattr__(self, name):
+        """
+        当访问代理对象上不存在的属性时（包括方法），此方法会被调用。
+        它会触发真实 PathManager 对象的初始化。
+        """
+        # 如果当前对象尚未初始化为 PathManager，则进行初始化和转换
+        if not object.__getattribute__(self, '_initialized'):
+            self._initialize_and_transform()
+
+        # 此时，self 已经变成了 PathManager 实例，其属性已在 __dict__ 或 PathManager 的方法中
+        # 再次尝试从自身获取属性，这次会成功（如果 PathManager 有该属性/方法）
+        return object.__getattribute__(self, name)
+
+    def __setattr__(self, name, value):
+        """
+        当设置代理对象的属性时，此方法会被调用。
+        它也会触发真实 PathManager 对象的初始化。
+        """
+        # 如果正在设置代理自身内部的延迟参数或初始化标记，直接通过基类设置，避免递归
+        if name in ['_initialized']:
+            object.__setattr__(self, name, value)
+        else:
+            # 否则，表示用户正在操作一个业务属性，触发初始化
+            if not object.__getattribute__(self, '_initialized'):
+                self._initialize_and_transform()
+            # 初始化完成后，通过基类设置属性，因为现在 self 已经是 PathManager
+            object.__setattr__(self, name, value)
+
+    def __delattr__(self, name):
+        """
+        当删除代理对象的属性时，此方法会被调用。
+        它也会触发真实 PathManager 对象的初始化。
+        """
+        if name in ['_initialized']:
+            object.__delattr__(self, name)
+        else:
+            if not object.__getattribute__(self, '_initialized'):
+                self._initialize_and_transform()
+            object.__delattr__(self, name)
+
+
+paths: PathManager = PathManagerProxy()
 
 
 def init_paths(work_path_str: str):
@@ -42,8 +114,10 @@ def init_paths(work_path_str: str):
         work_path_str: 工作目录
     """
     global paths
-    paths = PathManager(Path(work_path_str))
+    if isinstance(paths, PathManagerProxy):
+        paths = PathManager(Path(work_path_str))
 
 
-if os.path.isdir(os.path.join(os.getcwd(), "murainbot")):
+# 如果是 MRB2 开发环境，自动初始化
+if os.path.isdir(os.path.join(os.getcwd(), "murainbot")) and os.path.isdir(os.path.join(os.getcwd(), "plugins")):
     init_paths(os.getcwd())