⚡ 优化日志记录器，简化日志文件命名和模板解析逻辑

zhenxun/services/log.py

@@ -1,4 +1,4 @@
-from datetime import datetime, timedelta
+from datetime import timedelta
 from typing import Any, overload
 
 import nonebot
@@ -17,7 +17,7 @@ driver = nonebot.get_driver()
 log_level = driver.config.log_level or "INFO"
 
 logger_.add(
-    LOG_PATH / f"{datetime.now().date()}.log",
+    LOG_PATH / "{time:YYYY-MM-DD}.log",
     level=log_level,
     rotation="00:00",
     format=default_format,
@@ -26,7 +26,7 @@ logger_.add(
 )
 
 logger_.add(
-    LOG_PATH / f"error_{datetime.now().date()}.log",
+    LOG_PATH / "error_{time:YYYY-MM-DD}.log",
     level="ERROR",
     rotation="00:00",
     format=default_format,
@@ -36,26 +36,92 @@ logger_.add(
 
 
 class logger:
-    TEMPLATE_A = "Adapter[{}] {}"
+    """
-    TEMPLATE_B = "Adapter[{}] [<u><c>{}</c></u>]: {}"
+    一个经过优化的、支持多种上下文和格式的日志记录器。
-    TEMPLATE_C = "Adapter[{}] 用户[<u><e>{}</e></u>] 触发 [<u><c>{}</c></u>]: {}"
+    """
-    TEMPLATE_D = "Adapter[{}] 群聊[<u><e>{}</e></u>] 用户[<u><e>{}</e></u>] 触发"
-    " [<u><c>{}</c></u>]: {}"
-    TEMPLATE_E = "Adapter[{}] 群聊[<u><e>{}</e></u>] 用户[<u><e>{}</e></u>] 触发"
-    " [<u><c>{}</c></u>] [Target](<u><e>{}</e></u>): {}"
-
-    TEMPLATE_ADAPTER = "Adapter[<m>{}</m>] "
-    TEMPLATE_USER = "用户[<u><e>{}</e></u>] "
-    TEMPLATE_GROUP = "群聊[<u><e>{}</e></u>] "
-    TEMPLATE_COMMAND = "CMD[<u><c>{}</c></u>] "
-    TEMPLATE_PLATFORM = "平台[<u><m>{}</m></u>] "
-    TEMPLATE_TARGET = "[Target]([<u><e>{}</e></u>]) "
 
+    TEMPLATE_ADAPTER = "Adapter[<m>{}</m>]"
+    TEMPLATE_USER = "用户[<u><e>{}</e></u>]"
+    TEMPLATE_GROUP = "群聊[<u><e>{}</e></u>]"
+    TEMPLATE_COMMAND = "CMD[<u><c>{}</c></u>]"
+    TEMPLATE_PLATFORM = "平台[<u><m>{}</m></u>]"
+    TEMPLATE_TARGET = "[Target]([<u><e>{}</e></u>])"
     SUCCESS_TEMPLATE = "[<u><c>{}</c></u>]: {} | 参数[{}] 返回: [<y>{}</y>]"
 
-    WARNING_TEMPLATE = "[<u><y>{}</y></u>]: {}"
+    @classmethod
+    def __parser_template(
+        cls,
+        info: str,
+        command: str | None = None,
+        user_id: int | str | None = None,
+        group_id: int | str | None = None,
+        adapter: str | None = None,
+        target: Any = None,
+        platform: str | None = None,
+    ) -> str:
+        """
+        优化后的模板解析器，构建并连接日志信息片段。
+        """
+        parts = []
+        if adapter:
+            parts.append(cls.TEMPLATE_ADAPTER.format(adapter))
+        if platform:
+            parts.append(cls.TEMPLATE_PLATFORM.format(platform))
+        if group_id:
+            parts.append(cls.TEMPLATE_GROUP.format(group_id))
+        if user_id:
+            parts.append(cls.TEMPLATE_USER.format(user_id))
+        if command:
+            parts.append(cls.TEMPLATE_COMMAND.format(command))
+        if target:
+            parts.append(cls.TEMPLATE_TARGET.format(target))
 
-    ERROR_TEMPLATE = "[<u><r>{}</r></u>]: {}"
+        parts.append(info)
+        return " ".join(parts)
+
+    @classmethod
+    def _log(
+        cls,
+        level: str,
+        info: str,
+        command: str | None = None,
+        session: int | str | Session | uninfoSession | None = None,
+        group_id: int | str | None = None,
+        adapter: str | None = None,
+        target: Any = None,
+        platform: str | None = None,
+        e: Exception | None = None,
+    ):
+        """
+        核心日志处理方法，处理所有日志级别的通用逻辑。
+        """
+        user_id: str | None = str(session) if isinstance(session, int | str) else None
+
+        if isinstance(session, Session):
+            user_id = session.id1
+            adapter = session.bot_type
+            group_id = f"{session.id3}:{session.id2}" if session.id3 else session.id2
+            platform = platform or session.platform
+        elif isinstance(session, uninfoSession):
+            user_id = session.user.id
+            adapter = session.adapter
+            if session.group:
+                group_id = session.group.id
+            platform = session.basic.get("scope")
+
+        template = cls.__parser_template(
+            info, command, user_id, group_id, adapter, target, platform
+        )
+
+        if e:
+            template += f" || 错误 <r>{type(e).__name__}: {e}</r>"
+
+        try:
+            log_func = getattr(logger_.opt(colors=True), level)
+            log_func(template)
+        except Exception:
+            log_func_fallback = getattr(logger_, level)
+            log_func_fallback(template)
 
     @overload
     @classmethod
@@ -70,7 +136,6 @@ class logger:
         target: Any = None,
         platform: str | None = None,
     ): ...
-
     @overload
     @classmethod
     def info(
@@ -82,7 +147,6 @@ class logger:
         target: Any = None,
         platform: str | None = None,
     ): ...
-
     @overload
     @classmethod
     def info(
@@ -107,28 +171,16 @@ class logger:
         target: Any = None,
         platform: str | None = None,
     ):
-        user_id: str | None = session  # type: ignore
+        cls._log(
-        if isinstance(session, Session):
+            "info",
-            user_id = session.id1
+            info=info,
-            adapter = session.bot_type
+            command=command,
-            if session.id3:
+            session=session,
-                group_id = f"{session.id3}:{session.id2}"
+            group_id=group_id,
-            elif session.id2:
+            adapter=adapter,
-                group_id = f"{session.id2}"
+            target=target,
-            platform = platform or session.platform
+            platform=platform,
-        elif isinstance(session, uninfoSession):
-            user_id = session.user.id
-            adapter = session.adapter
-            if session.group:
-                group_id = session.group.id
-            platform = session.basic["scope"]
-        template = cls.__parser_template(
-            info, command, user_id, group_id, adapter, target, platform
         )
-        try:
-            logger_.opt(colors=True).info(template)
-        except Exception:
-            logger_.info(template)
 
     @classmethod
     def success(
@@ -138,9 +190,11 @@ class logger:
         param: dict[str, Any] | None = None,
         result: str = "",
     ):
-        param_str = ""
+        param_str = (
-        if param:
+            ",".join([f"<m>{k}</m>:<g>{v}</g>" for k, v in param.items()])
-            param_str = ",".join([f"<m>{k}</m>:<g>{v}</g>" for k, v in param.items()])
+            if param
+            else ""
+        )
         logger_.opt(colors=True).success(
             cls.SUCCESS_TEMPLATE.format(command, info, param_str, result)
         )
@@ -159,7 +213,6 @@ class logger:
         platform: str | None = None,
         e: Exception | None = None,
     ): ...
-
     @overload
     @classmethod
     def warning(
@@ -168,12 +221,10 @@ class logger:
         command: str | None = None,
         *,
         session: Session | None = None,
-        adapter: str | None = None,
         target: Any = None,
         platform: str | None = None,
         e: Exception | None = None,
     ): ...
-
     @overload
     @classmethod
     def warning(
@@ -182,7 +233,6 @@ class logger:
         command: str | None = None,
         *,
         session: uninfoSession | None = None,
-        adapter: str | None = None,
         target: Any = None,
         platform: str | None = None,
         e: Exception | None = None,
@@ -201,30 +251,17 @@ class logger:
         platform: str | None = None,
         e: Exception | None = None,
     ):
-        user_id: str | None = session  # type: ignore
+        cls._log(
-        if isinstance(session, Session):
+            "warning",
-            user_id = session.id1
+            info=info,
-            adapter = session.bot_type
+            command=command,
-            if session.id3:
+            session=session,
-                group_id = f"{session.id3}:{session.id2}"
+            group_id=group_id,
-            elif session.id2:
+            adapter=adapter,
-                group_id = f"{session.id2}"
+            target=target,
-            platform = platform or session.platform
+            platform=platform,
-        elif isinstance(session, uninfoSession):
+            e=e,
-            user_id = session.user.id
-            adapter = session.adapter
-            if session.group:
-                group_id = session.group.id
-            platform = session.basic["scope"]
-        template = cls.__parser_template(
-            info, command, user_id, group_id, adapter, target, platform
         )
-        if e:
-            template += f" || 错误<r>{type(e)}: {e}</r>"
-        try:
-            logger_.opt(colors=True).warning(template)
-        except Exception as e:
-            logger_.warning(template)
 
     @overload
     @classmethod
@@ -240,7 +277,6 @@ class logger:
         platform: str | None = None,
         e: Exception | None = None,
     ): ...
-
     @overload
     @classmethod
     def error(
@@ -253,7 +289,6 @@ class logger:
         platform: str | None = None,
         e: Exception | None = None,
     ): ...
-
     @overload
     @classmethod
     def error(
@@ -280,30 +315,17 @@ class logger:
         platform: str | None = None,
         e: Exception | None = None,
     ):
-        user_id: str | None = session  # type: ignore
+        cls._log(
-        if isinstance(session, Session):
+            "error",
-            user_id = session.id1
+            info=info,
-            adapter = session.bot_type
+            command=command,
-            if session.id3:
+            session=session,
-                group_id = f"{session.id3}:{session.id2}"
+            group_id=group_id,
-            elif session.id2:
+            adapter=adapter,
-                group_id = f"{session.id2}"
+            target=target,
-            platform = platform or session.platform
+            platform=platform,
-        elif isinstance(session, uninfoSession):
+            e=e,
-            user_id = session.user.id
-            adapter = session.adapter
-            if session.group:
-                group_id = session.group.id
-            platform = session.basic["scope"]
-        template = cls.__parser_template(
-            info, command, user_id, group_id, adapter, target, platform
         )
-        if e:
-            template += f" || 错误 <r>{type(e)}: {e}</r>"
-        try:
-            logger_.opt(colors=True).error(template)
-        except Exception as e:
-            logger_.error(template)
 
     @overload
     @classmethod
@@ -319,7 +341,6 @@ class logger:
         platform: str | None = None,
         e: Exception | None = None,
     ): ...
-
     @overload
     @classmethod
     def debug(
@@ -332,7 +353,6 @@ class logger:
         platform: str | None = None,
         e: Exception | None = None,
     ): ...
-
     @overload
     @classmethod
     def debug(
@@ -359,62 +379,78 @@ class logger:
         platform: str | None = None,
         e: Exception | None = None,
     ):
-        user_id: str | None = session  # type: ignore
+        cls._log(
-        if isinstance(session, Session):
+            "debug",
-            user_id = session.id1
+            info=info,
-            adapter = session.bot_type
+            command=command,
-            if session.id3:
+            session=session,
-                group_id = f"{session.id3}:{session.id2}"
+            group_id=group_id,
-            elif session.id2:
+            adapter=adapter,
-                group_id = f"{session.id2}"
+            target=target,
-            platform = platform or session.platform
+            platform=platform,
-        elif isinstance(session, uninfoSession):
+            e=e,
-            user_id = session.user.id
-            adapter = session.adapter
-            if session.group:
-                group_id = session.group.id
-            platform = session.basic["scope"]
-        template = cls.__parser_template(
-            info, command, user_id, group_id, adapter, target, platform
         )
-        if e:
-            template += f" || 错误 <r>{type(e)}: {e}</r>"
-        try:
-            logger_.opt(colors=True).debug(template)
-        except Exception as e:
-            logger_.debug(template)
 
+    @overload
     @classmethod
-    def __parser_template(
+    def trace(
         cls,
         info: str,
         command: str | None = None,
-        user_id: int | str | None = None,
+        *,
+        session: int | str | None = None,
         group_id: int | str | None = None,
         adapter: str | None = None,
         target: Any = None,
         platform: str | None = None,
-    ) -> str:
+        e: Exception | None = None,
-        arg_list = []
+    ): ...
-        template = ""
+    @overload
-        if adapter is not None:
+    @classmethod
-            template += cls.TEMPLATE_ADAPTER
+    def trace(
-            arg_list.append(adapter)
+        cls,
-        if platform is not None:
+        info: str,
-            template += cls.TEMPLATE_PLATFORM
+        command: str | None = None,
-            arg_list.append(platform)
+        *,
-        if group_id is not None:
+        session: Session | None = None,
-            template += cls.TEMPLATE_GROUP
+        target: Any = None,
-            arg_list.append(group_id)
+        platform: str | None = None,
-        if user_id is not None:
+        e: Exception | None = None,
-            template += cls.TEMPLATE_USER
+    ): ...
-            arg_list.append(user_id)
+    @overload
-        if command is not None:
+    @classmethod
-            template += cls.TEMPLATE_COMMAND
+    def trace(
-            arg_list.append(command)
+        cls,
-        if target is not None:
+        info: str,
-            template += cls.TEMPLATE_TARGET
+        command: str | None = None,
-            arg_list.append(target)
+        *,
-        arg_list.append(info)
+        session: uninfoSession | None = None,
-        template += "{}"
+        target: Any = None,
-        return template.format(*arg_list)
+        platform: str | None = None,
+        e: Exception | None = None,
+    ): ...
+
+    @classmethod
+    def trace(
+        cls,
+        info: str,
+        command: str | None = None,
+        *,
+        session: int | str | Session | uninfoSession | None = None,
+        group_id: int | str | None = None,
+        adapter: str | None = None,
+        target: Any = None,
+        platform: str | None = None,
+        e: Exception | None = None,
+    ):
+        cls._log(
+            "trace",
+            info=info,
+            command=command,
+            session=session,
+            group_id=group_id,
+            adapter=adapter,
+            target=target,
+            platform=platform,
+            e=e,
+        )