logging 如何自动添加当前函数名、文件名和行号

Python logging模块可通过Formatter内置占位符%(funcName)s、%(filename)s、%(lineno)d自动插入函数名、文件名和行号；封装日志时需用stacklevel=2跳过封装层；推荐用basicConfig全局配置。

logging 如何自动添加当前函数名、文件名和行号第1张

Python 的 logging 模块可以通过配置格式化器（Formatter），自动在日志中插入函数名、文件名和行号，无需手动传参。关键在于使用内置的格式化占位符，并确保日志调用发生在实际执行的函数内（而非封装层）。

使用标准格式化占位符

在 Formatter 的格式字符串中，直接使用以下占位符：

%(funcName)s：当前日志调用所在的函数名（不是调用栈顶层，而是实际执行 logger.info() 等语句的函数）
%(filename)s：日志调用所在源文件的 basename（如 main.py）
%(lineno)d：日志调用所在行号

示例配置：

import logging
formatter = logging.Formatter(
'[%(asctime)s] %(levelname)-8s %(filename)s:%(lineno)d %(funcName)s - %(message)s',
datefmt='%Y-%m-%d %H:%M:%S'
)
handler = logging.StreamHandler()
handler.setFormatter(formatter)
logger = logging.getLogger(name)
logger.addHandler(handler)
logger.setLevel(logging.DEBUG)
def example():
logger.debug("这行日志会显示函数名、文件名和行号")
example()

输出类似：
[2024-05-20 10:30:15] DEBUG main.py:12 example - 这行日志会显示函数名、文件名和行号

注意调用位置影响 funcName 和 lineno

%(funcName)s 和 %(lineno)d 取的是 实际执行 logger.xxx() 的那一行 所在的函数与行号。如果封装了日志方法（如写了个 log_debug(msg)），默认会显示封装函数的信息，而非调用者。

解决方法：启用 stacklevel 参数（Python 3.8+ 支持）：

在 logger.debug(..., stacklevel=2) 中设为 2，表示向上跳 1 层调用栈，获取调用该封装函数的位置
常见封装示例：

def log_debug(msg):
    logger.debug(msg, stacklevel=2)  # ← 关键：跳过本层，定位到调用 log_debug() 的地方

全局配置方式（推荐用于项目初始化）

避免重复设置 handler 和 formatter，可在程序启动时统一配置：

import logging
logging.basicConfig(
level=logging.DEBUG,
format='%(asctime)s | %(levelname)-8s | %(filename)s:%(lineno)d | %(funcName)s | %(message)s',
datefmt='%H:%M:%S'
)
此后所有 getLogger() 获取的 logger 都会自动携带这些字段

注意：basicConfig() 必须在任何 logger.xxx() 调用前执行，且只生效一次。