python 日志打印不了栈信息

原创

mob649e815e6170 2023-10-05 17:29:52 ©著作权

文章标签 Python 打印日志文件名 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e815e6170的原创作品，请联系作者获取转载授权，否则将追究法律责任

Python日志-打印不了栈信息

引言

在Python开发中，日志是一个非常重要的组件。它可以帮助我们记录和追踪代码中的问题，以及跟踪代码的执行路径。然而，有时候我们可能会遇到一个问题：无法在日志中打印栈信息。本文将介绍这个问题的原因，并提供解决方案。

问题描述

当我们在Python代码中使用日志模块打印日志时，通常会使用一些常见的方法，比如logging.info()、logging.error()等等。例如：

import logging

logging.info("This is an info message")
logging.error("This is an error message")

这样的代码通常可以正常工作，并将日志信息打印到控制台或日志文件中。然而，有时候我们希望能够在日志中打印出当前代码的执行栈信息，以便更好地了解代码的执行路径和调用关系。

为什么无法打印栈信息

Python的日志模块默认是不会打印栈信息的。这是由于性能的原因，打印栈信息需要进行一定的计算和操作，会对程序的执行速度有一定的影响。因此，默认情况下，Python的日志模块只会打印日志信息本身，不包含栈信息。

如何打印栈信息

要在Python日志中打印栈信息，我们可以使用logging模块提供的Logger类的findCaller()方法。这个方法会返回当前代码的调用栈信息，包括文件名、行号和函数名等。

下面是一个示例代码，展示了如何使用findCaller()方法打印栈信息：

import logging

def log_with_stack_info(logger, level, msg):
    frame = logger.findCaller()
    filename = frame[0]
    lineno = frame[1]
    funcname = frame[2]
    stack_info = f"{filename}:{lineno} {funcname}"
    logger.log(level, f"{msg} - {stack_info}")

# 创建一个Logger对象
logger = logging.getLogger("my_logger")
logger.setLevel(logging.DEBUG)

# 创建一个StreamHandler对象，并设置日志级别为DEBUG
handler = logging.StreamHandler()
handler.setLevel(logging.DEBUG)

# 创建一个Formatter对象，并为handler设置格式化输出
formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
handler.setFormatter(formatter)

# 将handler添加到logger中
logger.addHandler(handler)

# 使用新的log_with_stack_info函数打印日志
log_with_stack_info(logger, logging.INFO, "This is an info message")

try:
    1 / 0
except Exception as e:
    log_with_stack_info(logger, logging.ERROR, f"An error occurred: {str(e)}")

在上面的代码中，我们创建了一个新的函数log_with_stack_info()，它接受一个logger对象、日志级别和消息作为参数。这个函数内部通过logger.findCaller()方法获取当前代码的调用栈信息，并将其添加到日志消息中。然后，我们使用这个新函数打印了一个包含栈信息的信息。

运行上面的代码，我们将会得到如下输出：

2022-01-01 00:00:00,000 - INFO - This is an info message - log_test.py:18 <module>
2022-01-01 00:00:00,000 - ERROR - An error occurred: division by zero - log_test.py:24 <module>

可以看到，日志中打印了包含文件名、行号和函数名的栈信息，这可以帮助我们更好地追踪日志的来源和代码执行路径。