refactor: 合并 error_logger.py + debug_logger.py 到 internal_loggers.py

这两个模块只被 douyin_logging_wrapper 内部使用,外部完全不引用。
合并为单文件 internal_loggers.py 减少模块数量。

douyin/logging/ 模块数:11 -> 10

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
CodexandClaude Opus 4.5 committed 2026-05-21 08:53:48 +08:00
1 parent b137aead48
commit a065c12d0c
5 files changed
+231 -167

No files matched your search

+2 -5
View File
@@ -25,11 +25,8 @@ from .log_formatter import (
# 性能追踪模块
from .performance_tracker import PerformanceTracker
# 错误日志模块
from .error_logger import ErrorLogger
# 调试日志模块
from .debug_logger import DebugLogger, _get_debug_logger
# 错误与调试日志(合并到 internal_loggers)
from .internal_loggers import ErrorLogger, DebugLogger, _get_debug_logger
# 行为日志模块
from .action_logger import ActionLogger
-98
View File
@@ -1,98 +0,0 @@
"""调试日志记录器:在运行时输出详细信息,遇到错误时调用错误日志记录器。"""
from __future__ import annotations
import time
import traceback
import logging
import os
from typing import Any, Dict, Optional
import threading
from .log_formatter import format_debug_log
from .performance_tracker import PerformanceTracker
from .error_logger import ErrorLogger
_perf = PerformanceTracker()
_err = ErrorLogger()
# 初始化文件日志记录器
_debug_logger = logging.getLogger("debug_logger")
if not _debug_logger.handlers:
_debug_logger.setLevel(logging.DEBUG)
# 添加控制台处理器
_console_handler = logging.StreamHandler()
_debug_logger.addHandler(_console_handler)
# 添加文件处理器,写入到 debug.log
try:
# 获取日志目录
log_dir = os.path.join(os.path.dirname(os.path.dirname(os.path.dirname(__file__))), "logs")
os.makedirs(log_dir, exist_ok=True)
debug_log_path = os.path.join(log_dir, "debug.log")
# 创建轮转文件处理器
from logging.handlers import RotatingFileHandler
_file_handler = RotatingFileHandler(
debug_log_path,
maxBytes=10*1024*1024, # 10MB
backupCount=5,
encoding='utf-8'
)
_file_handler.setFormatter(logging.Formatter('%(asctime)s - %(message)s'))
_debug_logger.addHandler(_file_handler)
except Exception:
# 如果文件处理器创建失败,至少保留控制台输出
pass
class DebugLogger:
def __init__(self, enabled: bool = True) -> None:
self.enabled = enabled
def log_function_entry(self, func_name: str, *args: Any, **kwargs: Any) -> None:
if not self.enabled:
return
params = {"args": args, "kwargs": kwargs}
line = format_debug_log(f"FunctionEntry: {func_name}", level="DEBUG", **params)
_debug_logger.debug(line)
def log_function_exit(self, func_name: str, retval: Any, elapsed: float) -> None:
if not self.enabled:
return
line = format_debug_log(f"FunctionExit: {func_name}", level="DEBUG", elapsed_seconds=elapsed, return_value=retval)
_debug_logger.debug(line)
def log_variable(self, name: str, value: Any) -> None:
if not self.enabled:
return
line = format_debug_log(f"VariableSnapshot: {name}=", level="DEBUG", value=value)
_debug_logger.debug(line)
def log_call_stack(self) -> None:
if not self.enabled:
return
stack = traceback.format_stack()
line = format_debug_log("CallStack", level="DEBUG", stack="".join(stack))
_debug_logger.debug(line)
def log_exception(self, exc: BaseException, context: Optional[Dict[str, Any]] = None) -> None:
if not self.enabled:
return
tb = traceback.format_exc()
line = format_debug_log("Exception", level="ERROR", exception=type(exc).__name__, traceback=tb, context=context or {})
_debug_logger.error(line)
_err.log_exception(exc, context=context)
def log_step(self, name: str, start_time: float, end_time: Optional[float] = None) -> None:
if not self.enabled:
return
t = (end_time if end_time is not None else time.time()) - start_time
line = format_debug_log("StepTiming", level="DEBUG", step=name, elapsed_seconds=t)
_debug_logger.debug(line)
_perf.get_elapsed(name) # update internal stats if used
def _get_debug_logger() -> DebugLogger:
return DebugLogger(True)
__all__ = ["DebugLogger", "_get_debug_logger"]
+1 -2
View File
@@ -51,8 +51,7 @@ except ImportError:
# 导入所有日志模块
try:
from .error_logger import ErrorLogger # type: ignore[assignment]
from .debug_logger import DebugLogger # type: ignore[assignment]
from .internal_loggers import ErrorLogger, DebugLogger # type: ignore[assignment]
from .action_logger import ActionLogger # type: ignore[assignment]
from .performance_tracker import PerformanceTracker # type: ignore[assignment]
-62
View File
@@ -1,62 +0,0 @@
"""错误日志记录模块:记录详细错误、上下文与推荐恢复建议"""
from __future__ import annotations
import logging
import traceback
import os
from typing import Any, Dict, Optional
from douyin.core import path_config
logger = None
def _init_logger():
global logger
if logger is not None:
return
log_path = path_config.get_error_log_path() if hasattr(path_config, "get_error_log_path") else os.path.join(path_config.get_logs_dir(), "error.log")
os.makedirs(os.path.dirname(log_path), exist_ok=True)
import logging.handlers
logger = logging.getLogger("error_logger")
if not logger.handlers:
handler = logging.handlers.RotatingFileHandler(log_path, maxBytes=5*1024*1024, backupCount=5, encoding="utf-8")
formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
handler.setFormatter(formatter)
logger.addHandler(handler)
logger.setLevel(logging.INFO)
class ErrorLogger:
def __init__(self) -> None:
_init_logger()
def log_exception(self, exc: BaseException, context: Optional[Dict[str, Any]] = None, level: str = "ERROR") -> None:
if not logger:
_init_logger()
if logger is None:
# 如果仍然无法初始化 logger,则退回到标准输出,避免抛出异常
print(f"[ErrorLogger] {type(exc).__name__}: {exc}")
return
tb = traceback.format_exc()
ctx = ", ".join(f"{k}={v}" for k, v in (context or {}).items()) if context else ""
msg = f"Exception: {type(exc).__name__}: {exc}"
if ctx:
msg += f" | context: {ctx}"
if tb:
msg += f"\nTraceback:\n{tb}"
logger.log(getattr(logging, level, logging.ERROR), msg)
def log_error(self, msg: str, context: Optional[Dict[str, Any]] = None, level: str = "ERROR") -> None:
if not logger:
_init_logger()
if logger is None:
print(f"[ErrorLogger] {msg}")
return
full = msg
if context:
full += " | " + ", ".join(f"{k}={v}" for k, v in context.items())
logger.log(getattr(logging, level, logging.ERROR), full)
def log_warning(self, msg: str, context: Optional[Dict[str, Any]] = None) -> None:
self.log_error(msg, context=context, level="WARNING")
def capture_error_context(self, **ctx) -> Dict[str, Any]:
return dict(ctx)
def log_error_with_context(self, exc: BaseException, context: Optional[Dict[str, Any]] = None, level: str = "ERROR") -> None:
self.log_exception(exc, context=context, level=level)
__all__ = ["ErrorLogger"]
+228
View File
@@ -0,0 +1,228 @@
"""内部日志器:DebugLogger 和 ErrorLogger 合并到同一个文件。
这两个类只被 douyin_logging_wrapper 内部使用,外部不应直接引用。
为减少模块数量,合并为单文件。
"""
from __future__ import annotations
import logging
import logging.handlers
import os
import time
import traceback
from typing import Any, Dict, Optional
from douyin.core import path_config
from .log_formatter import format_debug_log
from .performance_tracker import PerformanceTracker
# ============================================================
# ErrorLogger
# ============================================================
_error_module_logger: Optional[logging.Logger] = None
def _init_error_logger() -> None:
"""惰性初始化错误日志器,写入 logs/error.log"""
global _error_module_logger
if _error_module_logger is not None:
return
log_path = (
path_config.get_error_log_path()
if hasattr(path_config, "get_error_log_path")
else os.path.join(path_config.get_logs_dir(), "error.log")
)
os.makedirs(os.path.dirname(log_path), exist_ok=True)
_error_module_logger = logging.getLogger("error_logger")
if not _error_module_logger.handlers:
handler = logging.handlers.RotatingFileHandler(
log_path, maxBytes=5 * 1024 * 1024, backupCount=5, encoding="utf-8"
)
formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
handler.setFormatter(formatter)
_error_module_logger.addHandler(handler)
_error_module_logger.setLevel(logging.INFO)
class ErrorLogger:
def __init__(self) -> None:
_init_error_logger()
def log_exception(
self,
exc: BaseException,
context: Optional[Dict[str, Any]] = None,
level: str = "ERROR",
) -> None:
if not _error_module_logger:
_init_error_logger()
if _error_module_logger is None:
print(f"[ErrorLogger] {type(exc).__name__}: {exc}")
return
tb = traceback.format_exc()
ctx = (
", ".join(f"{k}={v}" for k, v in (context or {}).items())
if context
else ""
)
msg = f"Exception: {type(exc).__name__}: {exc}"
if ctx:
msg += f" | context: {ctx}"
if tb:
msg += f"\nTraceback:\n{tb}"
_error_module_logger.log(getattr(logging, level, logging.ERROR), msg)
def log_error(
self,
msg: str,
context: Optional[Dict[str, Any]] = None,
level: str = "ERROR",
) -> None:
if not _error_module_logger:
_init_error_logger()
if _error_module_logger is None:
print(f"[ErrorLogger] {msg}")
return
full = msg
if context:
full += " | " + ", ".join(f"{k}={v}" for k, v in context.items())
_error_module_logger.log(getattr(logging, level, logging.ERROR), full)
def log_warning(
self, msg: str, context: Optional[Dict[str, Any]] = None
) -> None:
self.log_error(msg, context=context, level="WARNING")
def capture_error_context(self, **ctx) -> Dict[str, Any]:
return dict(ctx)
def log_error_with_context(
self,
exc: BaseException,
context: Optional[Dict[str, Any]] = None,
level: str = "ERROR",
) -> None:
self.log_exception(exc, context=context, level=level)
# ============================================================
# DebugLogger
# ============================================================
_debug_module_logger = logging.getLogger("debug_logger")
if not _debug_module_logger.handlers:
_debug_module_logger.setLevel(logging.DEBUG)
_debug_module_logger.addHandler(logging.StreamHandler())
try:
log_dir = os.path.join(
os.path.dirname(
os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
),
"logs",
)
os.makedirs(log_dir, exist_ok=True)
_debug_log_path = os.path.join(log_dir, "debug.log")
_file_handler = logging.handlers.RotatingFileHandler(
_debug_log_path,
maxBytes=10 * 1024 * 1024,
backupCount=5,
encoding="utf-8",
)
_file_handler.setFormatter(logging.Formatter("%(asctime)s - %(message)s"))
_debug_module_logger.addHandler(_file_handler)
except Exception:
# 文件处理器创建失败时退回到控制台输出
pass
_perf = PerformanceTracker()
_err = ErrorLogger()
class DebugLogger:
def __init__(self, enabled: bool = True) -> None:
self.enabled = enabled
def log_function_entry(
self, func_name: str, *args: Any, **kwargs: Any
) -> None:
if not self.enabled:
return
line = format_debug_log(
f"FunctionEntry: {func_name}",
level="DEBUG",
args=args,
kwargs=kwargs,
)
_debug_module_logger.debug(line)
def log_function_exit(
self, func_name: str, retval: Any, elapsed: float
) -> None:
if not self.enabled:
return
line = format_debug_log(
f"FunctionExit: {func_name}",
level="DEBUG",
elapsed_seconds=elapsed,
return_value=retval,
)
_debug_module_logger.debug(line)
def log_variable(self, name: str, value: Any) -> None:
if not self.enabled:
return
line = format_debug_log(
f"VariableSnapshot: {name}=", level="DEBUG", value=value
)
_debug_module_logger.debug(line)
def log_call_stack(self) -> None:
if not self.enabled:
return
stack = traceback.format_stack()
line = format_debug_log(
"CallStack", level="DEBUG", stack="".join(stack)
)
_debug_module_logger.debug(line)
def log_exception(
self, exc: BaseException, context: Optional[Dict[str, Any]] = None
) -> None:
if not self.enabled:
return
tb = traceback.format_exc()
line = format_debug_log(
"Exception",
level="ERROR",
exception=type(exc).__name__,
traceback=tb,
context=context or {},
)
_debug_module_logger.error(line)
_err.log_exception(exc, context=context)
def log_step(
self,
name: str,
start_time: float,
end_time: Optional[float] = None,
) -> None:
if not self.enabled:
return
t = (end_time if end_time is not None else time.time()) - start_time
line = format_debug_log(
"StepTiming", level="DEBUG", step=name, elapsed_seconds=t
)
_debug_module_logger.debug(line)
_perf.get_elapsed(name)
def _get_debug_logger() -> DebugLogger:
return DebugLogger(True)
__all__ = ["ErrorLogger", "DebugLogger", "_get_debug_logger"]