讲师中心 微信公众号
AI工具推荐 视频效率加速

如何实现在Python类中自动记录日志_通过类装饰器切面编程

阿枫君_8872

阿枫君_8872

发布时间:2026-05-09 07:38:19

|

635人浏览过

|

来源于php中文网

原创

直接在方法内写 logging.info() 导致日志逻辑分散、易遗漏、难维护;手动传类名方法名易错;统一开关、格式、耗时统计需逐个修改;切面式装饰器可解耦日志逻辑,需精准识别实例方法、保留元信息、支持异步与白名单控制。

如何实现在python类中自动记录日志_通过类装饰器切面编程

为什么直接在方法里写 logging.info() 不够用

类方法分散在不同位置,重复加日志逻辑容易漏、难维护;手动传 self.<strong>class</strong>.<strong>name</strong> 和方法名易出错;想统一开关日志、改格式、加耗时统计时,得挨个改。切面方式把日志逻辑从业务代码里抽出来,才是可持续的。

  • 日志内容至少应含:类名、方法名、入参(可选)、返回值(可选)、异常(如有)
  • 装饰器必须能识别被装饰的是实例方法(带 self),不能误处理静态/类方法
  • Python 3.10+ 的 inspect.signature() 比 inspect.getargspec() 更可靠,尤其对带类型注解或 functools.wraps 包裹的函数

用 @wraps + inspect 实现带上下文的类装饰器

核心是让装饰器作用于整个类,遍历其所有实例方法并重新绑定带日志逻辑的新函数。注意:不能直接装饰类本身(那会替换类对象),而是“改造类的 dict 中的方法”。

import functools
import inspect
import logging
import time
<p>def log_method_calls(logger_name="root"):
logger = logging.getLogger(logger_name)</p><pre class='brush:python;toolbar:false;'>def decorator(cls):
    for attr_name, attr_value in cls.__dict__.items():
        if callable(attr_value) and not attr_name.startswith('_'):
            # 排除 __init__、私有方法、类/静态方法
            sig = inspect.signature(attr_value)
            if len(sig.parameters) > 0 and list(sig.parameters.keys())[0] == "self":
                setattr(cls, attr_name, _log_wrapper(attr_value, logger))
    return cls
return decorator

def _log_wrapper(func, logger): @functools.wraps(func) def wrapper(self, *args, **kwargs): method_name = func.name class_name = self.class.name logger.info(f"[{class_name}.{method_name}] → args={args}, kwargs={kwargs}")

    start = time.time()
    try:
        result = func(self, *args, **kwargs)
        elapsed = time.time() - start
        logger.info(f"[{class_name}.{method_name}] ← result={result} (took {elapsed:.3f}s)")
        return result
    except Exception as e:
        elapsed = time.time() - start
        logger.error(f"[{class_name}.{method_name}] ✗ raised {type(e).__name__}: {e} (took {elapsed:.3f}s)")
        raise
return wrapper
  • 必须用 functools.wraps(func) 保留原函数的 <strong>name</strong>、<strong>doc</strong> 等元信息,否则调试、IDE 跳转会失效
  • list(sig.parameters.keys())[0] == "self" 是粗筛,更严谨可用 inspect.isfunction(attr_value) + 检查第一个参数名,但多数场景已够用
  • 不建议在装饰器里自动配置 logging.basicConfig() —— 容易和主程序冲突,由调用方控制 logger 更安全

常见踩坑:__init__ 被记录、继承方法没生效、异步方法报错
  • <strong>init</strong> 默认会被匹配(它是实例方法且首参是 self),但初始化日志价值低、还可能因参数未 fully 构建导致 repr 报错。解决方案:在遍历 cls.<strong>dict</strong> 时显式跳过 if attr_name == "<strong>init</strong>": continue
  • 子类未重写的方法不会出现在子类的 <strong>dict</strong> 中,所以装饰器只影响被装饰类自身定义的方法。若需覆盖继承链,得用元类或在类定义后手动扫描 inspect.getmembers(cls, predicate=inspect.isfunction),但会增加复杂度
  • 如果类里混用了 async def 方法,callable(attr_value) 仍为 True,但 _log_wrapper 返回的是同步 wrapper,调用时会报 RuntimeWarning: coroutine 'xxx' was never awaited。应对方式:先用 inspect.iscoroutinefunction(attr_value) 分流,用 async def wrapper(...) 重写异步分支

性能与粒度控制:不是所有方法都值得日志化

全量打日志会拖慢高频调用路径(比如数据结构的 <strong>getitem</strong>、<strong>len</strong>)。更实用的做法是支持白名单:

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
@log_method_calls(only_methods=["process", "validate", "save"])
class DataHandler:
    ...

实现上只需在装饰器闭包中加 only_methods 参数,并在遍历时判断 attr_name in only_methods。也可以反过来支持 exclude_methods。关键是把控制权交出去,而不是默认全开。

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

真正难的不是写这个装饰器,而是决定哪些方法该进日志、哪些参数要脱敏(比如密码字段)、错误日志要不要带完整 traceback —— 这些没法靠自动化解决,得结合业务语义人工判断。

相关文章

编程速学教程(入门课程)
编程速学教程(入门课程)

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

下载

相关标签:

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

热门AI工具

更多
WorkBuddy

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

SkildArt
SkildArt Hot

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

豆包大模型

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

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

DeepSeek

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

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

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

1851

2023.07.20

python能做什么
python能做什么

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

5044

2023.07.25

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

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

1809

2023.07.31

python教程
python教程

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

30297

2023.08.03

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

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

3607

2023.08.04

python eval
python eval

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

3607

2023.08.04

scratch和python区别
scratch和python区别

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

1243

2023.08.11

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

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

616

2023.08.10

Tailwind CSS 如何制作导航栏和卡片
Tailwind CSS 如何制作导航栏和卡片

用 Tailwind CSS 制作导航栏和卡片,可先搭建语义化结构,再组合 Flex、Grid、间距、圆角与阴影类。这里整理横向导航、移动端菜单、卡片网格及悬停效果的相关文章,帮助你把常见页面组件做得清晰且适配不同屏幕。

0

2026.11.03

热门下载

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

精品课程

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

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