mirror of
https://github.com/jxxghp/MoviePilot.git
synced 2026-02-09 13:36:55 +08:00
305 lines
9.6 KiB
Python
305 lines
9.6 KiB
Python
import logging
|
||
import sys
|
||
import threading
|
||
from logging.handlers import RotatingFileHandler
|
||
from pathlib import Path
|
||
from typing import Dict, Any, Optional
|
||
|
||
import click
|
||
from pydantic import BaseSettings, BaseModel
|
||
|
||
from app.utils.system import SystemUtils
|
||
|
||
|
||
class LogConfigModel(BaseModel):
|
||
"""
|
||
Pydantic 配置模型，描述所有配置项及其类型和默认值
|
||
"""
|
||
|
||
class Config:
|
||
extra = "ignore" # 忽略未定义的配置项
|
||
|
||
# 配置文件目录
|
||
CONFIG_DIR: Optional[str] = None
|
||
# 是否为调试模式
|
||
DEBUG: bool = False
|
||
# 日志级别（DEBUG、INFO、WARNING、ERROR等）
|
||
LOG_LEVEL: str = "INFO"
|
||
# 日志文件最大大小（单位：MB）
|
||
LOG_MAX_FILE_SIZE: int = 5
|
||
# 备份的日志文件数量
|
||
LOG_BACKUP_COUNT: int = 10
|
||
# 控制台日志格式
|
||
LOG_CONSOLE_FORMAT: str = "%(leveltext)s[%(name)s] %(asctime)s %(message)s"
|
||
# 文件日志格式
|
||
LOG_FILE_FORMAT: str = "【%(levelname)s】%(asctime)s - %(message)s"
|
||
|
||
|
||
class LogSettings(BaseSettings, LogConfigModel):
|
||
"""
|
||
日志设置类
|
||
"""
|
||
|
||
@property
|
||
def CONFIG_PATH(self):
|
||
return SystemUtils.get_config_path(self.CONFIG_DIR)
|
||
|
||
@property
|
||
def LOG_PATH(self):
|
||
"""
|
||
获取日志存储路径
|
||
"""
|
||
return self.CONFIG_PATH / "logs"
|
||
|
||
@property
|
||
def LOG_MAX_FILE_SIZE_BYTES(self):
|
||
"""
|
||
将日志文件大小转换为字节（MB -> Bytes）
|
||
"""
|
||
return self.LOG_MAX_FILE_SIZE * 1024 * 1024
|
||
|
||
class Config:
|
||
case_sensitive = True
|
||
env_file = SystemUtils.get_env_path()
|
||
env_file_encoding = "utf-8"
|
||
|
||
|
||
# 日志级别颜色映射
|
||
level_name_colors = {
|
||
logging.DEBUG: lambda level_name: click.style(str(level_name), fg="cyan"),
|
||
logging.INFO: lambda level_name: click.style(str(level_name), fg="green"),
|
||
logging.WARNING: lambda level_name: click.style(str(level_name), fg="yellow"),
|
||
logging.ERROR: lambda level_name: click.style(str(level_name), fg="red"),
|
||
logging.CRITICAL: lambda level_name: click.style(str(level_name), fg="bright_red"),
|
||
}
|
||
|
||
|
||
class CustomFormatter(logging.Formatter):
|
||
"""
|
||
自定义日志输出格式
|
||
"""
|
||
|
||
def __init__(self, fmt=None):
|
||
super().__init__(fmt)
|
||
|
||
def format(self, record):
|
||
separator = " " * (8 - len(record.levelname))
|
||
record.leveltext = level_name_colors[record.levelno](record.levelname + ":") + separator
|
||
return super().format(record)
|
||
|
||
|
||
class LoggerManager:
|
||
"""
|
||
日志管理
|
||
"""
|
||
# 管理所有的 Logger
|
||
_loggers: Dict[str, Any] = {}
|
||
# 默认日志文件名称
|
||
_default_log_file = "moviepilot.log"
|
||
# 线程锁
|
||
_lock = threading.Lock()
|
||
|
||
@staticmethod
|
||
def __get_caller():
|
||
"""
|
||
获取调用者的文件名称与插件名称
|
||
如果是插件调用内置的模块, 也能写入到插件日志文件中
|
||
"""
|
||
# 调用者文件名称
|
||
caller_name = None
|
||
# 调用者插件名称
|
||
plugin_name = None
|
||
|
||
try:
|
||
frame = sys._getframe(3) # noqa
|
||
except (AttributeError, ValueError):
|
||
# 如果无法获取帧，返回默认值
|
||
return "log.py", None
|
||
|
||
while frame:
|
||
filepath = Path(frame.f_code.co_filename)
|
||
parts = filepath.parts
|
||
# 设定调用者文件名称
|
||
if not caller_name:
|
||
if parts[-1] == "__init__.py" and len(parts) >= 2:
|
||
caller_name = parts[-2]
|
||
else:
|
||
caller_name = parts[-1]
|
||
# 设定调用者插件名称
|
||
if "app" in parts:
|
||
if not plugin_name and "plugins" in parts:
|
||
try:
|
||
plugins_index = parts.index("plugins")
|
||
if plugins_index + 1 < len(parts):
|
||
plugin_candidate = parts[plugins_index + 1]
|
||
if plugin_candidate == "__init__.py":
|
||
plugin_name = "plugin"
|
||
else:
|
||
plugin_name = plugin_candidate
|
||
break
|
||
except ValueError:
|
||
pass
|
||
if "main.py" in parts:
|
||
# 已经到达程序的入口，停止遍历
|
||
break
|
||
elif len(parts) != 1:
|
||
# 已经超出程序范围，停止遍历
|
||
break
|
||
# 获取上一个帧
|
||
try:
|
||
frame = frame.f_back
|
||
except AttributeError:
|
||
break
|
||
return caller_name or "log.py", plugin_name
|
||
|
||
@staticmethod
|
||
def __setup_logger(log_file: str):
|
||
"""
|
||
初始化日志实例
|
||
:param log_file：日志文件相对路径
|
||
"""
|
||
log_file_path = log_settings.LOG_PATH / log_file
|
||
log_file_path.parent.mkdir(parents=True, exist_ok=True)
|
||
|
||
# 创建新实例
|
||
_logger = logging.getLogger(log_file_path.stem)
|
||
|
||
# 设置日志级别
|
||
_logger.setLevel(LoggerManager.__get_log_level())
|
||
|
||
# 移除已有的 handler，避免重复添加
|
||
for handler in _logger.handlers:
|
||
_logger.removeHandler(handler)
|
||
|
||
# 终端日志
|
||
console_handler = logging.StreamHandler()
|
||
console_formatter = CustomFormatter(log_settings.LOG_CONSOLE_FORMAT)
|
||
console_handler.setFormatter(console_formatter)
|
||
_logger.addHandler(console_handler)
|
||
|
||
# 文件日志
|
||
file_handler = RotatingFileHandler(
|
||
filename=log_file_path,
|
||
mode="a",
|
||
maxBytes=log_settings.LOG_MAX_FILE_SIZE_BYTES,
|
||
backupCount=log_settings.LOG_BACKUP_COUNT,
|
||
encoding="utf-8"
|
||
)
|
||
file_formatter = CustomFormatter(log_settings.LOG_FILE_FORMAT)
|
||
file_handler.setFormatter(file_formatter)
|
||
_logger.addHandler(file_handler)
|
||
|
||
# 禁止向父级log传递
|
||
_logger.propagate = False
|
||
|
||
return _logger
|
||
|
||
def update_loggers(self):
|
||
"""
|
||
更新日志实例
|
||
"""
|
||
with LoggerManager._lock:
|
||
for _logger in self._loggers.values():
|
||
self.__update_logger_handlers(_logger)
|
||
|
||
@staticmethod
|
||
def __update_logger_handlers(_logger: logging.Logger):
|
||
"""
|
||
更新 Logger 的 handler 配置
|
||
:param _logger: 需要更新的 Logger 实例
|
||
"""
|
||
# 更新现有 handler
|
||
for handler in _logger.handlers:
|
||
try:
|
||
if isinstance(handler, RotatingFileHandler):
|
||
# 更新最大文件大小和备份数量
|
||
handler.maxBytes = log_settings.LOG_MAX_FILE_SIZE_BYTES
|
||
handler.backupCount = log_settings.LOG_BACKUP_COUNT
|
||
# 更新日志文件输出格式
|
||
file_formatter = CustomFormatter(log_settings.LOG_FILE_FORMAT)
|
||
handler.setFormatter(file_formatter)
|
||
elif isinstance(handler, logging.StreamHandler):
|
||
# 更新控制台输出格式
|
||
console_formatter = CustomFormatter(log_settings.LOG_CONSOLE_FORMAT)
|
||
handler.setFormatter(console_formatter)
|
||
except Exception as e:
|
||
logger.error(f"Failed to update handler: {handler}. Error: {e}")
|
||
# 更新日志级别
|
||
_logger.setLevel(LoggerManager.__get_log_level())
|
||
|
||
@staticmethod
|
||
def __get_log_level():
|
||
"""
|
||
获取当前日志级别
|
||
"""
|
||
return logging.DEBUG if log_settings.DEBUG else getattr(logging, log_settings.LOG_LEVEL.upper(), logging.INFO)
|
||
|
||
def logger(self, method: str, msg: str, *args, **kwargs):
|
||
"""
|
||
获取模块的logger
|
||
:param method: 日志方法
|
||
:param msg: 日志信息
|
||
"""
|
||
# 获取调用者文件名和插件名
|
||
caller_name, plugin_name = self.__get_caller()
|
||
# 区分插件日志
|
||
if plugin_name:
|
||
# 使用插件日志文件
|
||
logfile = Path("plugins") / f"{plugin_name}.log"
|
||
else:
|
||
# 使用默认日志文件
|
||
logfile = self._default_log_file
|
||
with LoggerManager._lock: # 添加锁
|
||
# 获取调用者的模块的logger
|
||
_logger = self._loggers.get(logfile)
|
||
if not _logger:
|
||
_logger = self.__setup_logger(log_file=logfile)
|
||
self._loggers[logfile] = _logger
|
||
# 调用logger的方法打印日志
|
||
if hasattr(_logger, method):
|
||
log_method = getattr(_logger, method)
|
||
log_method(f"{caller_name} - {msg}", *args, **kwargs)
|
||
|
||
def info(self, msg: str, *args, **kwargs):
|
||
"""
|
||
输出信息级别日志
|
||
"""
|
||
self.logger("info", msg, *args, **kwargs)
|
||
|
||
def debug(self, msg: str, *args, **kwargs):
|
||
"""
|
||
输出调试级别日志
|
||
"""
|
||
self.logger("debug", msg, *args, **kwargs)
|
||
|
||
def warning(self, msg: str, *args, **kwargs):
|
||
"""
|
||
输出警告级别日志
|
||
"""
|
||
self.logger("warning", msg, *args, **kwargs)
|
||
|
||
def warn(self, msg: str, *args, **kwargs):
|
||
"""
|
||
输出警告级别日志（兼容）
|
||
"""
|
||
self.warning(msg, *args, **kwargs)
|
||
|
||
def error(self, msg: str, *args, **kwargs):
|
||
"""
|
||
输出错误级别日志
|
||
"""
|
||
self.logger("error", msg, *args, **kwargs)
|
||
|
||
def critical(self, msg: str, *args, **kwargs):
|
||
"""
|
||
输出严重错误级别日志
|
||
"""
|
||
self.logger("critical", msg, *args, **kwargs)
|
||
|
||
|
||
# 实例化日志设置
|
||
log_settings = LogSettings()
|
||
|
||
# 初始化日志管理
|
||
logger = LoggerManager()
|