Skip to main content
 首页 » 编程设计

python之如何使日志记录装饰器在使用它的地方而不是在它定义的地方记录文件名

2024年12月31日8飞鱼

我使用 logging 模块和 filename 格式来捕获我的代码的日志输出。这很好用,因为现在我总是知道消息是从哪个文件发送的。但是,我有一个缩进日志记录装饰器,我想在使用的地方记录文件名,而不是在定义装饰器的地方记录文件名。这可能吗?

这是它现在正在做的一个简短示例:

测试.py
import logging 
from log import logger 
from log import indented 
 
@indented('Here I start my method...', 'And here it ends') 
def my_func(): 
    logger.info('Look, a message!') 
 
 
if __name__ == '__main__': 
    logging.basicConfig( 
        filename='LOG', 
        level=logging.DEBUG, 
        format='%(asctime)s.%(msecs)03d [ %(levelname)-8s] %(filename)s: %(message)s', 
        datefmt="%Y-%m-%d %H:%M:%S") 
    my_func() 

日志输出

2018-07-27 13:27:15.541 [ INFO    ] log.py: Here I start my method... 
2018-07-27 13:27:15.541 [ INFO    ] test.py: ---- Look, a message! 
2018-07-27 13:27:15.541 [ INFO    ] log.py: And here it ends 

现在我希望所有三个消息都包含 test.py,如下所示:

期望的输出

2018-07-27 13:27:15.541 [ INFO    ] test.py: Here I start my method... 
2018-07-27 13:27:15.541 [ INFO    ] test.py: ---- Look, a message! 
2018-07-27 13:27:15.541 [ INFO    ] test.py: And here it ends 

日志.py
import logging 
from contextlib import contextmanager 
from functools import wraps 
 
 
class IndentationAdapter(logging.LoggerAdapter): 
    def __init__(self, logger, extra): 
        super().__init__(logger, extra) 
        self._indent = 0 
 
    def indent(self): 
        self._indent += 4 
 
    def dedent(self): 
        self._indent -= 4 
 
    def process(self, msg, kwargs): 
        if self._indent > 0: 
            return '{i} {m}'.format(i='-'*self._indent, m=msg), kwargs 
        else: 
            return msg, kwargs 
 
logger = IndentationAdapter(logging.getLogger(), {}) 
 
@contextmanager 
def indent_logging(): 
    logger.indent() 
    try: 
        yield 
    finally: 
        logger.dedent() 
 
 
def indented(begin_message, end_message): 
    def indent_decorator(func): 
        @wraps(func) 
        def func_wrapper(*args, **kwargs): 
            logger.info(begin_message) 
            with indent_logging(): 
                output = func(*args, **kwargs) 
            logger.info(end_message) 
 
            return output 
 
        return func_wrapper 
    return indent_decorator 

请您参考如下方法:

通过复制标准库的日志记录模块使用的一些代码检查,我能够自动生成文件名和开始/结束消息。我删除了手动开始和结束消息,认为这更符合您的意图。我还从日志格式中删除了文件名,并将其添加到 indent_decorator 记录的文本中。

    def indented(): 
        def indent_decorator(func): 
            @wraps(func) 
            def func_wrapper(*args, **kwargs): 
                filename = os.path.basename(func.__code__.co_filename) 
                logger.info(filename + ': begin ' + func.__name__) 
                with indent_logging(): 
                    output = func(*args, **kwargs) 
                logger.info(filename + ': end ' + func.__name__) 
 
                return output 
 
            return func_wrapper 
        return indent_decorator 

这是日志输出

2018-12-31 08:14:25.536 [ INFO    ] test.py: begin my_func 
2018-12-31 08:14:25.536 [ INFO    ] ---- Look, a message! 
2018-12-31 08:14:25.536 [ INFO    ] test.py: end my_func 

我不知道我们可以在多大程度上依赖代码在未来的 python 版本中保持不变,但这在 3.6.5 中对我有用

我怀疑它应该进一步简化,这样你就不必在装饰器上加上括号,所以这可能是以后的编辑。