主页 / coding / 问题 / 78992244
Accepted
OmniZ
Asked: 2024-09-17 09:08:05 +0800 CST

如何才能在不破坏日志记录 %(filename) 的情况下将日志记录子类化。Formatter 的插值语法

  • 772

我正在尝试编写一个logging.Logger基本可以正常工作的自定义子类，但是在尝试使用logging.Formatter包含自定义格式的插值值的子类时遇到问题%(filename)，它会打印我的自定义子类所在的文件名，而不是调用日志记录函数的代码的文件名。

我找到了很多关于 Logger 子类化的教程，但是没有一个能解决它对文件名插值的影响。有没有一种无需重写大量代码的直接解决方案logging.Logger？

定义我的自定义记录器的示例代码：

#-------------------------------------
# custom_logger.py
#-------------------------------------
import logging
import io
class CustomLogger(logging.Logger):
    
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.setLevel(logging.DEBUG)
        
        # create the record format
        formatter = logging.Formatter(fmt = "%(filename)s - %(message)s")
        
        # create the handler
        self.stream = io.StringIO()
        handler = logging.StreamHandler(self.stream)
        handler.setFormatter(formatter)
        self.addHandler(handler)
    
    def debug(self, msg, *args, **kwargs):
        super().debug(msg, *args, **kwargs)
        
        # do some other stuff
        ...        

#-------------------------------------
# test.py
#-------------------------------------
from custom_logger import CustomLogger
import logging

logging.setLoggerClass(CustomLogger)
myLog = logging.getLogger("myLog")
myLog.debug("hello world")
print(myLog.stream.getvalue())

预期输出： >>> test.py - hello world

实际产量： >>> custom_logger.py - hello world

python

1 个回答

  1. Best Answer

    这个问题已经在https://stackoverflow.com/a/59492341/2138700中得到解答

    解决方案是在 custom_logger 代码中调用时使用 stacklevel 关键字参数。以下是文档super().debug中的相关部分

    第三个可选关键字参数是 stacklevel，默认值为 1。如果大于 1，则在计算为日志记录事件创建的 LogRecord 中设置的行号和函数名称时会跳过相应数量的堆栈帧。这可用于日志记录助手，这样记录的函数名称、文件名和行号就不是助手函数/方法的信息，而是其调用者的信息。

    所以修改后的代码应该是

    import logging
import io
class CustomLogger(logging.Logger):
    
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.setLevel(logging.DEBUG)
        
        # create the record format
        formatter = logging.Formatter(fmt = "%(filename)s - %(message)s")
        
        # create the handler
        self.stream = io.StringIO()
        handler = logging.StreamHandler(self.stream)
        handler.setFormatter(formatter)
        self.addHandler(handler)
    
    def debug(self, msg, *args, **kwargs):
        super().debug(msg, *args, stacklevel=2, **kwargs)

    现在输出将是test.py - hello world

    • 1

相关问题