讲师中心 微信公众号

工具推荐

视频效率加速
SoundView
SoundView

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

剧云
剧云

中文短剧剧本制作平台

Seko
Seko

AI短剧一键生成成片

立刻MV
立刻MV

低成本歌曲 MV、视频生成

使用装饰器优雅地记录方法调用:Python 进阶指南

老磊大大_2095

老磊大大_2095

发布时间:2025-08-14 19:12:01

|

890人浏览过

|

来源于php中文网

原创

使用装饰器优雅地记录方法调用:python 进阶指南

本文将探讨如何使用装饰器在 Python 中记录方法调用,并提供一个通用的装饰器实现方案。虽然 Python 标准库的 logging 模块本身不提供内置的装饰器来实现此功能,但我们可以自定义装饰器来满足需求。我们将详细介绍如何创建和使用这样的装饰器,以及一些注意事项,帮助你更好地理解和应用这种技术。

自定义装饰器实现方法调用日志记录

在软件开发中,记录方法调用对于调试和性能分析至关重要。虽然 Python 的 logging 模块非常强大,但它并没有直接提供一个内置的装饰器来自动记录方法调用。不过,我们可以轻松地自定义一个装饰器来实现这个功能。

装饰器实现

以下是一个简单的装饰器示例,它可以记录方法调用的开始和结束,并输出传入的参数和关键字参数:

import logging, sys

logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
logger = logging.getLogger()

def log(func):
    def logged(*args, **kwargs):
        logger.info(f"{func.__name__} starting with args={args} kwargs={kwargs}...")
        result = func(*args, **kwargs)
        logger.info(f"{func.__name__} finished.")
        return result
    return logged

代码解释:

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

Biopython
Biopython

全面的分子生物学工具集。适用于序列操作、文件解析(FASTA/GenBank/PDB)、系统发育分析,以及通过 Bio.Entrez 以编程方式访问 NCBI/

下载
  1. logging.basicConfig(...): 配置日志记录的基本设置,将日志输出到标准输出,并将日志级别设置为 DEBUG。
  2. logger = logging.getLogger(): 获取一个 logger 实例。
  3. log(func): log 函数是一个装饰器,它接受一个函数 func 作为参数。
  4. logged(*args, **kwargs)*: logged 函数是装饰器内部的包装函数,它接收任意数量的位置参数 `args和关键字参数kwargs`。
  5. logger.info(...): 使用 logger.info 记录方法调用的开始和结束信息,包括函数名、参数和关键字参数。
  6. *`result = func(args, kwargs)`: 调用原始函数 func,并将结果存储在 result 变量中。
  7. return result: 返回原始函数的结果。

使用示例

要使用这个装饰器,只需在要记录的方法上方添加 @log 即可:

class A:
    @log
    def foo(self, x, y):
        pass

    @log
    def bar(self, x, y):
        try:
            1/0
        except Exception as e:
            logger.error(f"Error in bar: {e}")
            raise # Re-raise the exception so the program doesn't silently fail

a = A()
a.foo(2, y=3)
try:
    a.bar(2, y=3)
except Exception as e:
    print(f"Caught exception: {e}")

输出结果:

INFO:root:foo starting with args=(<__main__.A object at 0x...>, 2) kwargs={'y': 3}...
INFO:root:foo finished.
INFO:root:bar starting with args=(<__main__.A object at 0x...>, 2) kwargs={'y': 3}...
ERROR:root:Error in bar: division by zero
Caught exception: division by zero

注意事项:

  • 异常处理:在 bar 方法中,我们添加了 try...except 块来捕获 ZeroDivisionError 异常。这可以防止程序崩溃,并允许我们记录错误信息。注意,在捕获异常后,我们使用 raise 重新抛出异常,以便调用者可以处理它。
  • self 参数:请注意,对于类方法,*args 的第一个参数将是类的实例 self。
  • 日志级别:根据需要调整 logging.basicConfig 中的 level 参数。

总结

虽然 Python 的 logging 模块没有内置的方法调用日志记录装饰器,但我们可以通过自定义装饰器轻松实现此功能。 这种方法不仅简单易用,而且高度可定制,可以满足各种日志记录需求。 记住,良好的日志记录实践对于软件开发至关重要,它可以帮助我们调试代码、分析性能并监控应用程序的运行状况。 通过使用装饰器,我们可以以一种优雅且非侵入性的方式将日志记录添加到我们的代码中。

热门AI工具

更多
讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

豆包大模型

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

笔灵降AI

一款AI论文写作工具,主要用于论文降AI神器,适配知网及维普!一键降至安全线,100%保留原文格式;无口语化问题,文风更学术,降后字数控制最佳!,适合需要提升相关任务效率的用户。

DeepSeek

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

小橡皮AI

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

WorkBuddy

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

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

相关专题

更多
GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

20

2026.11.17

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

20

2026.11.17

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

20

2026.11.17

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

20

2026.11.17

SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查

SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。

20

2026.11.17

SQLAlchemy ORM 模型怎么写
SQLAlchemy ORM 模型怎么写

SQLAlchemy ORM 模型怎么写?本专题整理模型类定义、Mapped 字段映射、主键与约束、表结构创建和常见报错的相关文章,帮助你从基础配置到实际建模逐步掌握 SQLAlchemy。

20

2026.11.17

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

180

2026.11.12

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

120

2026.11.12

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

120

2026.11.12

热门下载

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

精品课程

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

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