0

0

Python函数怎样用装饰器记录函数调用日志 Python函数日志装饰器的使用技巧​

爱谁谁

爱谁谁

发布时间:2025-08-17 22:54:02

|

380人浏览过

|

来源于php中文网

原创

使用装饰器可自动记录函数调用时间、参数、返回值及异常,通过@log_function_call装饰目标函数,在不修改原函数代码的前提下,利用*args、**kwargs捕获参数,try...except捕获执行结果与异常,并结合functools.wraps保留函数元信息,实现高效、可复用的日志记录。

python函数怎样用装饰器记录函数调用日志 python函数日志装饰器的使用技巧​

想在Python函数被调用时自动留下痕迹,比如记录下来它什么时候被调了,带了哪些参数,甚至跑完后返回了什么,装饰器无疑是个优雅又高效的选择。它就像给函数套了个“外壳”,在不改动函数本身代码的前提下,轻松实现这些额外的日志记录功能。

解决方案: 说白了,用装饰器记录日志,就是写一个高阶函数,它接收一个函数作为参数,然后返回一个新的函数。这个新函数在执行原始函数的前后,加入我们想要的日志逻辑。

一个基础的日志装饰器大概是这样:

import functools
import logging
import time

# 配置一个基本的日志器,方便演示
# 实际项目中,日志配置会更复杂,通常会写入文件,并设置滚动策略等
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)

def log_function_call(func):
    @functools.wraps(func) # 这一行很重要,它保留了原始函数的元信息,比如函数名和文档字符串
    def wrapper(*args, **kwargs):
        func_name = func.__name__
        # 记录函数调用前的日志,包含参数
        arg_str = ', '.join([repr(arg) for arg in args])
        kwarg_str = ', '.join([f"{k}={repr(v)}" for k, v in kwargs.items()])
        full_args_str = f"({arg_str}{', ' if arg_str and kwarg_str else ''}{kwarg_str})"
        logger.info(f"进入函数: {func_name}{full_args_str}")

        start_time = time.time()
        try:
            result = func(*args, **kwargs) # 执行原始函数
            # 记录函数成功执行后的日志,包括返回值和执行时间
            logger.info(f"函数 {func_name} 成功返回, 返回值: {repr(result)}, 耗时: {(time.time() - start_time)*1000:.2f}ms")
            return result
        except Exception as e:
            # 捕获异常,记录错误日志,并重新抛出
            logger.error(f"函数 {func_name} 发生异常: {type(e).__name__}: {e}, 耗时: {(time.time() - start_time)*1000:.2f}ms")
            raise # 重新抛出异常,不改变原始函数的行为
    return wrapper

# 怎么用呢?很简单,在函数定义前加上@log_function_call
@log_function_call
def calculate_sum(a, b):
    """计算两个数的和"""
    time.sleep(0.1) # 模拟一些耗时操作
    return a + b

@log_function_call
def greet_user(name, greeting="Hello"):
    """向用户问好"""
    return f"{greeting}, {name}!"

@log_function_call
def divide(a, b):
    """尝试除法操作"""
    time.sleep(0.05)
    return a / b

# 调用试试看
calculate_sum(10, 20)
greet_user("Alice", greeting="Hi")
try:
    divide(10, 0) # 尝试触发异常
except ZeroDivisionError:
    logger.info("捕获到ZeroDivisionError,这是预期行为。")

这个例子里,

log_function_call
就是我们的装饰器。它内部定义了一个
wrapper
函数,这个
wrapper
就是最终会被调用的那个。在
wrapper
里,我们先记录了调用前的状态,然后调用原始函数
func
,接着记录调用后的结果。
*args
**kwargs
确保了装饰器能处理任何数量和类型的参数。而
functools.wraps
则是为了让被装饰的函数看起来还像它自己,比如它的名字、文档字符串都不会变,这在调试和反射时特别有用。我还加了个
try...except
块,这样即使函数执行出错,日志也能捕获到异常信息,这在实际应用中非常重要。

为什么推荐使用装饰器来记录函数调用日志?

我个人觉得,在Python里,日志记录这种“横切关注点”(cross-cutting concerns)的问题,装饰器简直是量身定制的解决方案。你设想一下,如果每个函数都需要手动写上日志记录的代码,那会是多么灾难性的重复劳动!

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

聚好用AI
聚好用AI

可免费AI绘图、AI音乐、AI视频创作,聚集全球顶级AI,一站式创意平台

下载

它实现了代码的解耦和复用。日志记录逻辑和业务逻辑彻底分离开来,业务函数只专注于它自己的核心功能,而日志记录则由装饰器统一处理。这样一来,如果未来日志记录的方式需要调整(比如从打印到控制台改成写入文件,或者增加更多上下文信息),我们只需要修改装饰器这一个地方,所有被装饰的函数都会自动应用这些改变,而不需要触碰成百上千行的业务代码。这大大降低了维护成本和引入bug的风险。

此外,它让代码更干净、更可读。函数体内部不再充斥着与核心业务无关的日志语句,一眼望去,就是纯粹的业务逻辑。这对于团队协作和新成员理解项目代码都非常有益。当你看到一个函数上面挂着

@log_function_call
,你立刻就知道这个函数的调用会被记录,而不需要深入其内部去寻找那些散落的
print
logger.info
。这是一种非常优雅的“声明式”编程风格。

最后,也是我特别欣赏的一点,它提供了一种非侵入式的增强。你不需要修改原始函数的任何一行代码,就能赋予它新的能力。这对于一些你可能没有权限修改的第三方库函数,或者不想修改但又想监控的函数来说,简直是神来之笔。这种灵活性是直接在函数内部写日志无法比拟的。

如何为日志装饰器添加更多上下文信息,例如函数参数和返回值?

给日志添加更多上下文信息是日志记录的核心价值所在,毕竟,光知道函数被调用了,但不知道它带着什么数据跑的,那信息量可就大打折扣了

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
python中print函数的用法
python中print函数的用法

python中print函数的语法是“print(value1, value2, ..., sep=' ', end=' ', file=sys.stdout, flush=False)”。本专题为大家提供print相关的文章、下载、课程内容,供大家免费下载体验。

193

2023.09.27

python print用法与作用
python print用法与作用

本专题整合了python print的用法、作用、函数功能相关内容,阅读专题下面的文章了解更多详细教程。

19

2026.02.03

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1570

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

651

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1228

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

1205

2024.04.29

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号