讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

SoundView
SoundView

字幕擦除翻译、配音口型同步

Seko
Seko

AI短剧一键生成成片

剧云
剧云

中文短剧剧本制作平台

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

风伟姑娘_6116

风伟姑娘_6116

发布时间:2026-11-22 06:22:29

|

584人浏览过

|

来源于php中文网

原创

直接在 __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)

立即学习“Python免费学习笔记(深入)”;

  • 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)})
  • 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)

立即学习“Python免费学习笔记(深入)”;

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

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

热门AI工具

更多
小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

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

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

1971

2023.07.20

python能做什么
python能做什么

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

5664

2023.07.25

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

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

1929

2023.07.31

python教程
python教程

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

34757

2023.08.03

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

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

4047

2023.08.04

python eval
python eval

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

4047

2023.08.04

scratch和python区别
scratch和python区别

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

1303

2023.08.11

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

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

636

2023.08.10

Navicat创建数据库教程
Navicat创建数据库教程

本专题整理Navicat创建数据库相关教程,介绍新建前的准备、基础设置和创建后的检查方法。内容兼顾入门学习及实际使用需求,帮助用户了解不同数据库类型下的操作差异,为后续建表、保存数据和日常管理提供参考。

0

2026.11.20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn