himile-python-log 0.3.0__tar.gz → 0.4.0__tar.gz

{himile_python_log-0.3.0 → himile_python_log-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: himile_python_log
-Version: 0.3.0
+Version: 0.4.0
 Summary: A HIMILE utils package
 Author-email: qhw <20244111@himile.net>
 Requires-Python: >=3.10

{himile_python_log-0.3.0 → himile_python_log-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "himile_python_log"
-version = "0.3.0"
+version = "0.4.0"
 authors = [{ name = "qhw", email = "20244111@himile.net" }]
 description = "A HIMILE utils package"
 readme = "README.md"

himile_python_log-0.4.0/src/himile_python_log/himile_log.py

@@ -0,0 +1,159 @@
+import sys
+import uuid
+from contextvars import ContextVar
+from pathlib import Path
+
+from loguru import logger
+from loguru._logger import Logger as _LoguruLogger
+
+_trace_id_var: ContextVar[str] = ContextVar("trace_id", default="")
+
+
+def set_trace_id(trace_id: str = "") -> str:
+    """设置当前上下文的 trace_id。为空时自动生成。"""
+    if not trace_id:
+        trace_id = str(uuid.uuid4())[:8]
+    _trace_id_var.set(trace_id)
+    return trace_id
+
+
+def get_trace_id() -> str:
+    """获取当前上下文的 trace_id。"""
+    return _trace_id_var.get()
+
+
+def _patch_record(record):
+    """patcher: 自动将上下文中的 trace_id 注入 extra。"""
+    record["extra"]["trace_id"] = _trace_id_var.get()
+
+
+class LogWrapper:
+    def __init__(self, logs_dir: str = "logs", log_level: str = "DEBUG", appid: str = ""):
+        self.logger = logger
+        self.logger.remove()
+
+        appid_segment = f"{appid} | " if appid else ""
+        appid_file_segment = f"{appid} | " if appid else ""
+
+        Path(logs_dir).mkdir(parents=True, exist_ok=True)
+
+        # 打包成 exe 后（尤其 --noconsole / windowed 模式）sys.stdout 可能是 None，
+        # 直接 add(sys.stdout, ...) 会报错，这里判断存在才添加控制台输出。
+        if sys.stdout is not None:
+            self.logger.add(
+                sys.stdout,
+                format=(
+                    "<green>{time:YYYYMMDD HH:mm:ss.SSS}</green> | "
+                    + appid_segment +
+                    "{process.name} | "
+                    "{thread.name} | "
+                    "<cyan>{module}</cyan>.<cyan>{function}</cyan>:"
+                    "<cyan>{line}</cyan> | "
+                    "<level>{level}</level>: "
+                    "<level>{message}</level> | "
+                    "{extra[trace_id]}"
+                ),
+                level=log_level
+            )
+
+        log_file_path = Path(logs_dir) / "{time:YYYY-MM-DD}.log"
+        self.logger.add(
+            log_file_path,
+            level=log_level,
+            format=(
+                "{time:YYYYMMDD HH:mm:ss.SSS} | "
+                + appid_file_segment +
+                "{process.name} | "
+                "{thread.name} | "
+                "{module}.{function}:{line} | {level} | {message} | "
+                "{extra[trace_id]}"
+            ),
+            rotation="500 MB",
+            encoding="utf-8"
+        )
+
+        self.logger.configure(patcher=_patch_record)
+
+    def get_logger(self):
+        return PrintfLoggerProxy(self.logger)
+
+
+# ---------------------------------------------------------------------------
+# printf-style 兼容层
+#
+# 历史代码大量使用 Python logging 风格：logger.info("%s xxx", arg, ...)，
+# 以及 exc_info=True 参数。但 loguru 只认 {} 占位符，%s 会原样打印、
+# 参数被丢弃。这里做一层薄代理，统一把 printf 风格 / exc_info 转换成 loguru
+# 原生调用，避免逐个改造几十处调用点。
+# ---------------------------------------------------------------------------
+_PRINTF_LEVELS = ("trace", "debug", "info", "success", "warning", "error", "critical")
+
+
+def _copy_printf_kwargs(kwargs):
+    """取出 logging 风格参数并拷贝，避免污染调用点传入的原始 kwargs。"""
+    out = dict(kwargs)
+
+    # logging 风格 exc_info：True / Exception / (type, value, tb)。
+    # 为 False 或 None 时移除（loguru 会把任何非空值当作 traceback 打印）。
+    exc_info = out.pop("exc_info", None)
+    if exc_info is False or exc_info is None:
+        pass
+    elif exc_info is True:
+        out["exc_info"] = None          # loguru 的 "自动捕获当前异常"
+    else:
+        out["exc_info"] = exc_info      # 直接传异常/traceback 三元组给 loguru
+    return out
+
+
+class PrintfLoggerProxy:
+    """兼容 printf 风格（%s/%d/%r + 位置参数）与 exc_info 的 loguru 代理。
+
+    优先包装原生 loguru 方法，仅针对默认/带 extra 的日志方法做参数转换，
+    其它 loguru 特性（bind / with / catch / opt / level 等）透传到原生 logger。
+    """
+
+    def __init__(self, loguru_logger: _LoguruLogger):
+        object.__setattr__(self, "_loguru", loguru_logger)
+        self._set_level_methods()
+
+    def _set_level_methods(self):
+        # opt(depth=1)：让 loguru 记录"业务调用点"的 module/function/line，
+        # 而不是本代理里 _log 这一帧，否则所有日志都会显示成 himile_log._log。
+        opt_logger = self._loguru.opt(depth=1)
+        for level in _PRINTF_LEVELS:
+            native = getattr(opt_logger, level)
+            setattr(self, level, self._wrap_level(native))
+
+    def _wrap_level(self, native):
+        def _log(message, *args, **kwargs):
+            # 优先兼容 logging 风格：格式串含 %s/%d 占位符且有位置参数
+            if args and isinstance(message, str) and "%" in message:
+                message = message % args
+                args = ()
+            return native(message, *args, **_copy_printf_kwargs(kwargs))
+
+        return _log
+
+    def __getattr__(self, name):
+        # 未显式包装的属性（bind / with / catch / opt ...）透传到原生 logger
+        return getattr(self._loguru, name)
+
+    def __setattr__(self, name, value):
+        try:
+            object.__setattr__(self, name, value)
+        except AttributeError:
+            setattr(self._loguru, name, value)
+
+
+default_logger = LogWrapper()
+logger = default_logger.get_logger()
+
+
+def setup_logger(**kwargs) -> LogWrapper:
+    """Create a new logger instance with custom configuration."""
+    return LogWrapper(**kwargs)
+
+
+def get_default_logger():
+    """Get the default logger instance."""
+    return logger

{himile_python_log-0.3.0 → himile_python_log-0.4.0}/src/himile_python_log.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: himile_python_log
-Version: 0.3.0
+Version: 0.4.0
 Summary: A HIMILE utils package
 Author-email: qhw <20244111@himile.net>
 Requires-Python: >=3.10