如何理解Python的装饰器并实现一个简单的日志装饰器?

夢幻星辰
发布: 2025-09-03 19:05:01
原创
677人浏览过
装饰器是Python中用于扩展函数或类行为的语法糖,通过包装原函数添加日志、性能测试、权限验证等功能而不修改其源码。其核心在于函数是一等对象,可作为参数传递和返回。实现日志装饰器需定义接收函数的外层函数,内部创建包装函数执行额外逻辑后调用原函数,并用 @functools.wraps 保留原函数元信息。使用 @decorator 语法等价于 func = decorator(func)。带参数的装饰器实为装饰器工厂,返回真正装饰器,如按日志级别定制的 log_calls_level。装饰器广泛用于日志、缓存、权限控制等场景,实现关注点分离。对类方法和静态方法,装饰器应置于 @classmethod 或 @staticmethod 之前,注意应用顺序以避免类型冲突。

如何理解python的装饰器并实现一个简单的日志装饰器?

Python装饰器本质上是一种语法糖,允许你修改函数或类的行为,而无需修改其源代码。它就像给函数穿上了一件“外套”,这件外套可以添加额外的功能,例如日志记录、性能测试权限验证等。

理解装饰器的关键在于理解函数也是对象,可以作为参数传递给其他函数,并且可以作为其他函数的返回值。

解决方案:

要理解并实现一个简单的日志装饰器,可以分为以下几个步骤:

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

  1. 定义一个装饰器函数:这个函数接收一个函数作为参数,并返回一个新的函数(通常是原函数的包装)。
  2. 在装饰器函数内部定义一个包装函数:这个包装函数会执行一些额外的操作(例如日志记录),然后调用原始函数。
  3. 返回包装函数:装饰器函数返回这个包装函数,从而替换原始函数。

以下是一个简单的日志装饰器的例子:

import functools
import logging

logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')

def log_calls(func):
    @functools.wraps(func)  # 保留原函数的元信息
    def wrapper(*args, **kwargs):
        logging.info(f"Calling function: {func.__name__} with arguments: {args}, {kwargs}")
        result = func(*args, **kwargs)
        logging.info(f"Function {func.__name__} returned: {result}")
        return result
    return wrapper

@log_calls
def add(x, y):
    """This function adds two numbers."""
    return x + y

# 使用装饰器
result = add(5, 3)
print(result)
登录后复制

这个例子中,

log_calls
登录后复制
是一个装饰器函数,它接收一个函数
func
登录后复制
作为参数。
wrapper
登录后复制
函数是内部定义的包装函数,它会在调用
func
登录后复制
之前和之后记录日志。
@functools.wraps(func)
登录后复制
是一个重要的部分,它保留了原函数
func
登录后复制
的元信息,例如
__name__
登录后复制
(函数名) 和
__doc__
登录后复制
(文档字符串)。

使用

@log_calls
登录后复制
语法糖,相当于
add = log_calls(add)
登录后复制
。当你调用
add(5, 3)
登录后复制
时,实际上调用的是
wrapper(5, 3)
登录后复制

如何处理带参数的装饰器?

带参数的装饰器其实是“装饰器工厂”,它是一个函数,返回一个装饰器。例如,你可以修改上面的日志装饰器,让它能够指定日志级别:

帮衣帮-AI服装设计
帮衣帮-AI服装设计

AI服装设计神器,AI生成印花、虚拟试衣、面料替换

帮衣帮-AI服装设计 106
查看详情 帮衣帮-AI服装设计
import functools
import logging

def log_calls_level(level=logging.INFO):
    def log_decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            logging.log(level, f"Calling function: {func.__name__} with arguments: {args}, {kwargs}")
            result = func(*args, **kwargs)
            logging.log(level, f"Function {func.__name__} returned: {result}")
            return result
        return wrapper
    return log_decorator

@log_calls_level(level=logging.DEBUG) # 指定日志级别
def subtract(x, y):
    """This function subtracts two numbers."""
    return x - y

result = subtract(10, 4)
print(result)
登录后复制

在这个例子中,

log_calls_level
登录后复制
是一个装饰器工厂,它接收一个
level
登录后复制
参数,并返回一个装饰器
log_decorator
登录后复制
。使用
@log_calls_level(level=logging.DEBUG)
登录后复制
语法糖,相当于
subtract = log_calls_level(level=logging.DEBUG)(subtract)
登录后复制

装饰器在实际开发中有什么用?

装饰器在实际开发中有很多用途,例如:

  • 日志记录:像上面的例子一样,记录函数的调用和返回,方便调试和监控。
  • 性能测试:测量函数的执行时间,帮助优化代码。
  • 权限验证:检查用户是否有权限访问某个函数或资源。
  • 缓存:缓存函数的计算结果,避免重复计算。
  • 事务管理:在函数执行前后开启和关闭数据库事务。

装饰器可以有效地将这些横切关注点(cross-cutting concerns)从核心业务逻辑中分离出来,使代码更加清晰和易于维护。

装饰器如何处理类方法和静态方法?

对于类方法和静态方法,装饰器的使用方式略有不同,但原理是相同的。

对于类方法,装饰器需要放在

@classmethod
登录后复制
之前:

class MyClass:
    @log_calls
    @classmethod
    def my_class_method(cls):
        print("This is a class method")

MyClass.my_class_method()
登录后复制

对于静态方法,装饰器需要放在

@staticmethod
登录后复制
之前:

class MyClass:
    @log_calls
    @staticmethod
    def my_static_method():
        print("This is a static method")

MyClass.my_static_method()
登录后复制

需要注意的是,装饰器的顺序很重要。如果装饰器改变了函数的类型(例如,将一个普通函数变成一个类方法),那么需要确保

@classmethod
登录后复制
@staticmethod
登录后复制
在装饰器之后应用。

以上就是如何理解Python的装饰器并实现一个简单的日志装饰器?的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

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