如何在Python中利用装饰器优雅地实现日志记录功能?

千晨君_6046

千晨君_6046

2026-07-29

569人浏览

原创

必须使用@functools.wraps(func)包裹装饰器内层函数,否则__name__、__doc__、inspect.signature()等元数据将指向wrapper而非原函数,导致help()、IDE提示、类型检查和单元测试失效。

如何在python中利用装饰器优雅地实现日志记录功能?

装饰器里怎么加日志输出而不破坏原函数签名

直接用 @functools.wraps 包裹内层函数,否则 help() 或 IDE 提示会显示装饰器的签名而非原函数。不加这句,inspect.signature(func) 拿到的是装饰器内部的 wrapper 签名,单元测试或类型检查容易出错。

常见错误现象:用 logging.debug("called") 打印后发现 func.__name__ 变成 wrapper,参数提示全丢。

  • 必须在装饰器内部函数前加 @functools.wraps(func)
  • 导入不能省:import functools
  • 日志内容建议包含 func.__name__ 和 args/kwargs(但注意不要直接打印敏感字段)

如何让日志记录支持不同级别和可配置开关

硬编码 logging.info 不灵活,应把日志级别、是否启用作为装饰器参数传入。否则每次改级别都要改装饰器源码,没法按函数粒度控制。

使用场景:调试时想看 DEBUG 级别入参,上线后只留 WARNING 以上;或者仅对数据库操作函数开启详细日志。

  • 装饰器本身要返回闭包,例如 def log_calls(level=logging.INFO, enabled=True):
  • 内部再定义真正的装饰器函数,用 getattr(logging, level.upper()) 动态调用
  • 加 if not enabled: return func 快速短路,避免日志模块初始化开销
@log_calls(level="DEBUG", enabled=os.getenv("LOG_ENABLED"))
def fetch_user(user_id):
    return db.get(user_id)

为什么不能在装饰器里直接用 logging.basicConfig

logging.basicConfig 只能调用一次,后续调用无效。如果每个装饰器都尝试配置,会导致日志输出重复、格式混乱,甚至丢失 handler。

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

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

下载

典型错误现象:同一行日志打印两遍;时间戳格式不统一;文件日志写入失败但控制台还在输出。

  • 日志配置必须在程序入口(如 if __name__ == "__main__")一次性完成
  • 装饰器里只负责调用 logging.getLogger(__name__).log(...) 或直接用 logging.info
  • 若需独立 logger,用 logging.getLogger("myapp.api") 显式获取,别依赖 root logger

带参数的函数如何安全记录入参和返回值

直接 str(args) 可能触发对象的 __str__ 副作用,或导致大对象(如 DataFrame、二进制流)序列化卡住。返回值同理,尤其涉及数据库连接、文件句柄时不能随便 print。

性能影响明显:对高频调用函数(如每秒千次的 API 校验),序列化参数可能吃掉 20%+ CPU 时间。

  • 默认只记录 len(args)、type(args[0]) 等轻量信息
  • 提供 log_args_repr=False 开关,关闭时只打 "args: (3, )"
  • 返回值记录加 try/except,防止 repr() 报错中断原逻辑
  • 敏感字段(如 password、token)需自动过滤,可用白名单键名匹配

复杂点在于,日志不是越详细越好——得在可观测性和性能、安全性之间做取舍。比如记录 SQL 查询时,参数化后的语句要脱敏,但又不能漏掉占位符数量这种关键线索。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1831

4

python能做什么
python能做什么

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

2023.07.25

4964

7

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

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

2023.07.31

1789

3

python教程
python教程

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

2023.08.03

29757

23

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

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

2023.08.04

3547

5

python eval
python eval

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

2023.08.04

3567

5

scratch和python区别
scratch和python区别

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

2023.08.11

1223

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2763

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习