logging 自动添加函数名 文件名和行号的方法

Python 的 logging 模块原生支持通过格式化占位符 `%(funcName)s`、`%(filename)s` 和 `%(lineno)d` 自动注入函数名、文件名和行号，让日志具备精准的上下文定位能力；若对日志方法进行封装，只需在调用时添加 `stacklevel=2` 即可跳过封装层、真实反映调用位置；而借助 `basicConfig()` 一次性全局配置，更可轻松实现项目级统一日志格式——无需手动传参、不依赖第三方库，几行代码就能获得专业级可追溯日志体验。

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

使用标准格式化占位符

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

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

示例配置：

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

输出类似：
[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
<p>logging.basicConfig(
level=logging.DEBUG,
format='%(asctime)s | %(levelname)-8s | %(filename)s:%(lineno)d | %(funcName)s | %(message)s',
datefmt='%H:%M:%S'
)</p><h1>此后所有 getLogger() 获取的 logger 都会自动携带这些字段</h1>

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

自定义 LogRecord 增强（进阶，少用）

极少数场景需动态注入额外上下文（如协程 ID、请求 ID），可继承 logging.Filter 或重写 Logger.makeRecord()。但对函数名/文件名/行号这类基础信息，原生占位符已完全满足，无需复杂定制。

今天关于《logging 自动添加函数名 文件名和行号的方法》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！