0

0

使用装饰器优雅地记录方法调用

碧海醫心

碧海醫心

发布时间:2025-08-14 18:34:24

|

455人浏览过

|

来源于php中文网

原创

使用装饰器优雅地记录方法调用

本文旨在介绍如何利用装饰器实现方法调用的日志记录。

首先,我们来看一下如何自定义一个简单的@log装饰器来实现方法调用的日志记录:

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

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"{func.__name__} encountered an error: {e}")
            raise

a = A()
a.foo(2, y=3)
try:
    a.bar(2, y=3)
except Exception as e:
    pass # Handle the exception appropriately

代码解析:

  1. 导入模块: 首先,我们导入了logging和sys模块。logging模块用于日志记录,sys模块用于配置日志输出流。
  2. 配置日志: logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)配置日志输出到标准输出,并将日志级别设置为DEBUG,这意味着DEBUG级别及以上的日志都会被输出。logger = logging.getLogger()获取一个logger实例。
  3. 定义log装饰器: log函数是一个装饰器,它接受一个函数func作为参数,并返回一个新的函数logged。
    • logged函数接受任意数量的位置参数*args和关键字参数**kwargs。
    • 在logged函数内部,首先使用logger.info记录方法调用的开始,包括方法名、参数和关键字参数。
    • 然后,调用原始函数func并将结果保存到result变量中。
    • 最后,使用logger.info记录方法调用结束,并返回结果。
  4. 应用装饰器: 在A类的foo和bar方法上使用@log装饰器,这样每次调用这些方法时,都会自动记录日志。
  5. 错误处理: 在bar方法中,添加了try-except块来捕获异常并记录错误日志。这有助于调试和追踪代码中的问题。

注意事项:

智能网站优化SiteSEO1.52
智能网站优化SiteSEO1.52

系统易学易懂,用户只需会上网、不需学习编程及任何语言,只要使用该系统平台,只要会打字,即可在线直接完成建站所有工作。本程序适合不懂php环境配置的新手用来在本机调试智能SiteSEO网站优化软件,安装过程极其简单。您的网站地址:http://localhost您的网站后台:登录地址: http://localhost/admin.php密 码: admin服务器套件所包含的软件:nginx-0.7

下载
  • 日志级别: 根据需要调整日志级别。DEBUG级别会输出最详细的日志,而INFO、WARNING、ERROR和CRITICAL级别则会输出不同严重程度的日志。
  • 日志格式: 可以自定义日志格式,例如添加时间戳、线程ID等信息。
  • 异常处理: 在装饰器中处理异常时,需要谨慎。如果只是简单地捕获异常而不重新抛出,可能会导致程序行为异常。

总结:

虽然Python标准库的logging模块没有内置的@log装饰器,但我们可以轻松地自定义一个。通过使用装饰器,我们可以简洁地记录方法调用,方便调试和追踪代码执行流程。在实际应用中,可以根据需要定制装饰器的行为,例如添加更详细的日志信息、处理异常等。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

715

2023.06.15

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

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

625

2023.07.20

python能做什么
python能做什么

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

739

2023.07.25

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

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

617

2023.07.31

python教程
python教程

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

1235

2023.08.03

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

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

547

2023.08.04

python eval
python eval

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

575

2023.08.04

scratch和python区别
scratch和python区别

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

697

2023.08.11

桌面文件位置介绍
桌面文件位置介绍

本专题整合了桌面文件相关教程,阅读专题下面的文章了解更多内容。

0

2025.12.30

热门下载

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

精品课程

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

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.6万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.0万人学习

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

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