怎样在Python中为自定义类添加上下文相关的日志记录功能

风伟姑娘_6116

风伟姑娘_6116

2026-11-22

564人浏览

原创

直接在 __enter__ 中用 logging.info 不够用,因为无法自动捕获实例ID、属性值、堆栈位置及嵌套层级等上下文信息,易导致日志泛滥、混淆并发实例、上下文错乱;必须为每个实例绑定独立logger并结合extra、contextvars与自定义Filter确保日志精准归属。

怎样在python中为自定义类添加上下文相关的日志记录功能

为什么直接在 __enter__ 里用 logging.info 不够用

因为日志需要反映“当前上下文”——比如类实例的 ID、关键属性值、进入/退出时的堆栈位置,甚至嵌套层级。单纯调用 logging.info("entered") 无法自动捕获这些信息,容易导致日志泛滥且难以关联到具体对象实例。

更常见的问题是:多个实例并发使用时,日志混在一起分不清谁是谁;或者上下文变更(如切换数据库连接)后,旧日志仍沿用前一个上下文。

  • 必须绑定日志记录器到实例本身,而非模块级全局 logger
  • 需在 __init__ 中初始化带唯一标识的 logger(例如用 id(self) 或自定义 name)
  • 避免复用根 logger,否则 propagate=True 会把日志重复发给父 handler

如何让每个实例拥有独立可识别的日志器

核心是用 logging.getLogger(f"{__name__}.{type(self).__name__}_{id(self)}") 创建隔离 logger,但更实用的是用有意义的业务标识替代 id(),比如传入的 resource_id 或 session_token。

import logging
<p>class DatabaseSession:
def <strong>init</strong>(self, db_url: str, session_id: str):
self.db_url = db_url
self.session_id = session_id</p><h1>创建专属 logger,名称含业务标识</h1><pre class="brush:php;toolbar:false;">    self.logger = logging.getLogger(f"db.session.{session_id}")
    self.logger.setLevel(logging.DEBUG)
    # 确保不向上冒泡
    self.logger.propagate = False
    # 添加 handler(仅首次添加,避免重复)
    if not self.logger.handlers:
        handler = logging.StreamHandler()
        formatter = logging.Formatter(
            "[%(asctime)s] %(name)s | %(levelname)s | %(message)s"
        )
        handler.setFormatter(formatter)
        self.logger.addHandler(handler)

  • logger 名称中包含 session_id,便于 grep 过滤特定会话日志
  • propagate=False 是关键,否则日志会同时出现在 root logger 输出里
  • if not self.logger.handlers: 防止多次实例化时重复添加 handler 导致日志打印多遍

在 __enter__ 和 __exit__ 中注入上下文变量

不能只写 “entered” / “exited”,要带入当前状态。Python 的 logging.Logger 支持 extra 参数传入临时字段,配合 Formatter 中的 %(extra_field)s 即可动态渲染。

Define repeatable Python automation sessions in code with nox
Define repeatable Python automation sessions in code with nox

将测试、lint、构建和文档流程编码为命名的Python会话,以便人类和代理每次运行相同的workflow。

下载
def __enter__(self):
    self.logger.info("Entering database session", 
                    extra={"state": "connecting", "url": self.db_url})
    # ... 实际连接逻辑
    return self
<p>def <strong>exit</strong>(self, exc_type, exc_val, exc_tb):
if exc_type is None:
self.logger.info("Session closed successfully",
extra={"state": "closed"})
else:
self.logger.error("Session failed with exception",
extra={"state": "error", "exc": str(exc_val)})
</p>
  • extra 字典内容会合并进 LogRecord,可在 formatter 中引用(如 %(exc)s)
  • 不要在 extra 里传大型对象或未序列化数据,可能引发 TypeError
  • 若需跨方法共享上下文(如中间执行了 query),可用 threading.local() 或 contextvars.ContextVar(推荐后者,支持异步)缓存当前 session 日志上下文

异步上下文管理器(async with)怎么加日志

标准 logging 是线程安全但非协程安全的——同一 logger 被多个协程并发调用时,extra 可能被覆盖。必须用 contextvars 绑定当前上下文。

import contextvars
import logging
<p>_session_context = contextvars.ContextVar("session_context", default={})</p><p>class AsyncDatabaseSession:
def <strong>init</strong>(self, session_id: str):
self.session_id = session_id
self.logger = logging.getLogger(f"async.db.{session_id}")</p><pre class="brush:php;toolbar:false;">async def __aenter__(self):
    # 将上下文注入当前协程
    _session_context.set({"session_id": self.session_id, "step": "connect"})
    self.logger.info("Async session entering")
    return self

async def __aexit__(self, *args):
    ctx = _session_context.get()
    self.logger.info("Async session exiting", extra=ctx)

  • 不用 extra 直接传参,而是靠 contextvars 在协程生命周期内维持上下文
  • formatter 中无法直接渲染 contextvar,需自定义 Filter 把 context 注入 record:
  • 漏掉 Filter 就会导致日志里看不到 session_id ——这是最容易忽略的一环

真正麻烦的不是加日志,是让每条日志都明确归属哪个实例、哪个协程、哪个执行阶段。没做 contextvars + Filter 的异步日志,看着像有上下文,实际查问题时根本对不上号。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1971

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5664

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1929

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

34757

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

4047

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

4047

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1303

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

636

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

3163

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程