Python中的装饰器（decorator）

已于 2023-12-05 13:58:54 修改
阅读量94 收藏 1
点赞数
CC 4.0 BY-SA版权
文章标签： python 开发语言
于 2023-12-05 13:57:12 首次发布
原文链接：https://www.zhihu.com/question/271201015/answer/2387427580 作者：无尘粉笔

作者：无尘粉笔
链接：https://www.zhihu.com/question/271201015/answer/2387427580
来源：知乎
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

装饰器（decorator）是Python一个进阶的用法，通常以如下形式出现，但是它到底怎么用呢？且看本文细细分解。

@decorator           # 装饰器
def self_defined_function():
    print("Self-defined function is called.")

1. 什么时候需要用装饰器？

试想你有一系列函数，例如如下所示的两个函数（分别计算和与积）： 

def my_sum_function(*args):
    print("The sum is", sum(args))

def my_product_function(*args):
    res = 1
    for x in args:
        res *= x
    print("The product is", res)

my_sum_function(1, 2, 3, 4)
my_product_function(1, 2, 3, 4, 5)

现在，你需要为这一系列函数添加一个一样的功能，就是统计输入参数的个数，同时检查里面是否有0，那么低阶的解决方法就是为每一个函数单独添加部分代码，即：

def my_sum_function(*args):
    print("No. of input args is", len(args))                # 重复部分
    contain_zero = any([x == 0 for x in args])              # 重复部分
    print("Input arguments contain 0:", contain_zero)       # 重复部分

    print("The sum is", sum(args))

def my_product_function(*args):
    print("No. of input args is", len(args))                # 重复部分
    contain_zero = any([x == 0 for x in args])              # 重复部分
    print("Input arguments contain 0:", contain_zero)       # 重复部分

    res = 1
    for x in args:
        res *= x
    print("The product is", res)

my_sum_function(1, 2, 3, 4)
my_product_function(0, 1, 2, 3, 4, 5)

这样写的话，代码中存在大量重复的部分，有没有好一点的办法呢？也许你已经想到了，就是把添加的这部分功能封装成一个单独的函数，然后让每一个函数单独调用这个函数（嵌套调用），这样就能减少写代码过程中的“Ctrl+C和Ctrl+V”，即

def my_sum_function(*args):
    additional_function(*args)    # 嵌套调用

    print("The sum is", sum(args))

def my_product_function(*args):
    additional_function(*args)    # 嵌套调用

    res = 1
    for x in args:
        res *= x
    print("The product is", res)

def additional_function(*args):
    print("No. of input args is", len(args))
    contain_zero = any([x == 0 for x in args])
    print("Input arguments contain 0:", contain_zero)

my_sum_function(1, 2, 3, 4)
my_product_function(0, 1, 2, 3, 4, 5)

那有没有更pythonic的写法呢？这里就可以用到装饰器了，实现方法如下 

def a_decorator(f):
    def additional_function(*args):
        print("No. of input args is", len(args))
        contain_zero = any([x == 0 for x in args])
        print("Input arguments contain 0:", contain_zero)
        f(*args)
    return additional_function

@a_decorator
def my_sum_function(*args):
    print("The sum is", sum(args))

@a_decorator
def my_product_function(*args):
    res = 1
    for x in args:
        res *= x
    print("The product is", res)

my_sum_function(1, 2, 3, 4)
my_product_function(0, 1, 2, 3, 4, 5)

2. 装饰器的执行机制

现在我么已经知道了装饰器的使用场景：就是为函数定制化额外功能的时候，可是添加装饰器。使用装饰器可以使代码更加简洁。那么装饰器是如何工作的呢？我们以如下例子说明：

def a_decorator(f):                         # 函数作为参数被传入
    print(f"Function {f.__name__} is passed as the augument!")
    def additional_function(*args):         # 函数嵌套
        print("No. of input args is", len(args))
        contain_zero = any([x == 0 for x in args])
        print("Input arguments contain 0:", contain_zero)
        f(*args)    # 最终执行目标函数my_sum_function的地方
    return additional_function  # 函数作为返回对象

@a_decorator
def my_sum_function(*args):
    print("The sum is", sum(args))

my_sum_function(1, 2, 3, 4)

运行结果如下 

$ python demo.py
Function my_sum_function is passed as the augument!
No. of input args is 4
Input arguments contain 0: False
The sum is 10

在进一步解释运行机制之前，我们需要明确几个问题：

  • 一、在Python中，一切皆对象，包括函数。一个函数可以作为另一个函数的参数，一个函数也可以作为另一个函数的返回对象；
  • 二、如果在一个函数体中定义了另一个函数，称为函数嵌套，前者称为enclosing function，后者称为enclosed function或者nested function

根据运行结果，我们可以反推出装饰器的工作机制：

  • my_sum_function作为参数传入a_decorator函数，并开始执行，因此首先打印出“Function my_sum_function is passed as the augument!”
  • 随后a_decorator函数执行过程中返回了additional_function函数对象，然后开始执行additional_function(1, 2, 3, 4)，于是打印出“No. of input args is 4”和“Input arguments contain 0: False”
  • 在additional_function函数嵌套调用了my_sum_function函数，因此最后打印“The sum is 10”

也就是说，上述例子如果不用@符号，和下面是完全等价的：

def a_decorator(f):
    print(f"Function {f.__name__} is passed as the augument!")
    def additional_function(*args):
        print("No. of input args is", len(args))
        contain_zero = any([x == 0 for x in args])
        print("Input arguments contain 0:", contain_zero)
        f(*args)
    return additional_function

def my_sum_function(*args):
    print("The sum is", sum(args))

a_decorator(my_sum_function)(1, 2, 3, 4)    # 注意理解这一行

3. 闭包

在上述例子中，对于a_decorator函数的设计使用了闭包（closure）的概念[1]，即

  1. 一个函数中嵌套了另一个函数，如上述a_decorator函数中嵌套了additional_function函数
  2. enclosed function中直接使用了enclosing funcion中的参数，如上述additional_function函数中使用了a_decorator函数的参数f
  3. 最终返回enclosing funcion，如上述例子中最终返回了additional_function

满足以上三个条件的称为Python闭包。

4. 函数名被重写了怎么办？用functools.wraps！

在上述例子中，如我们print(my_sum_function.__name__)，会发现：

def a_decorator(f):                         # 函数作为参数被传入
    print(f"Function {f.__name__} is passed as the augument!")
    def additional_function(*args):         # 函数嵌套
        print("No. of input args is", len(args))
        contain_zero = any([x == 0 for x in args])
        print("Input arguments contain 0:", contain_zero)
        f(*args)    # 最终执行目标函数my_sum_function的地方
    return additional_function  # 函数作为返回对象

@a_decorator
def my_sum_function(*args):
    print("The sum is", sum(args))

print(my_sum_function.__name__)
# output: additional_function

my_sum_function函数的名字被重写了，怎么解决这个问题呢，很简单，调用functools.wraps即可[2]，即 

from functools import wraps

def a_decorator(f):                         # 函数作为参数被传入
    print(f"Function {f.__name__} is passed as the augument!")
    @wraps(f)                               # 注意这一行
    def additional_function(*args):         # 函数嵌套
        print("No. of input args is", len(args))
        contain_zero = any([x == 0 for x in args])
        print("Input arguments contain 0:", contain_zero)
        f(*args)    # 最终执行目标函数my_sum_function的地方
    return additional_function  # 函数作为返回对象

@a_decorator
def my_sum_function(*args):
    print("The sum is", sum(args))

print(my_sum_function.__name__)
# output: my_sum_function

5. 如何给装饰器传入参数？带参装饰器！

如果我想给装饰器再添加一个功能，就是把目标函数（my_sum_function）的计算结果存入本地文件，本地文件的文件名可以作为参数随时进行修改。这时候就需要用到带参装饰器了，那么带参装饰器如何实现呢？其实很简单，就是再嵌套一层，即

from functools import wraps
filename = "output.txt"

def a_decorator(filename):   
    print(filename)
    def inter_function(f):  # 第一层嵌套
        @wraps(f)
        def additional_function(*args): # 第二层嵌套       
            print("No. of input args is", len(args))
            contain_zero = any([x == 0 for x in args])
            print("Input arguments contain 0:", contain_zero)
            result = f(*args)    
            with open(filename, "w") as txt:
                txt.write(result)
                txt.close()
        return additional_function  
    return inter_function

@a_decorator(filename)  # 带参装饰器
def my_sum_function(*args):
    print("The sum is", sum(args))
    return str(sum(args))

my_sum_function(1, 2, 3)
# 执行完毕会在本地创建output.txt文件同时写入结果

你应该也已经注意到了，在调用functools.wraps时，@wraps(f)其实就是一个带参装饰器。

6. 类装饰器

除了函数可以作为装饰器，类也可以作为装饰器，这时候就需要类可以作为函数进行调用。如何实现把类作为函数使用呢？答案是__call__魔法函数，如

from functools import wraps

class A_decorater:

    def __init__(self) -> None:
        pass

    def __call__(self, f):
        @wraps(f)
        def additional_function(*args): 
            print("No. of input args is", len(args))
            contain_zero = any([x == 0 for x in args])
            print("Input arguments contain 0:", contain_zero)
            f(*args)    
        return additional_function  


@A_decorater()  # 千万注意这里括号不能少，因为A_decorater是类，A_decorater()是类的实例
def my_sum_function(*args):
    print("The sum is", sum(args))
    return str(sum(args))

my_sum_function(1, 2, 3)

如果要带参数的话，同样地需要再嵌套一层，即 

from functools import wraps
filename = "output.txt"

class A_decorater:

    def __init__(self) -> None:
        pass

    def __call__(self, filename):
        print(filename)
        def inter_function(f):
            @wraps(f)
            def additional_function(*args): 
                print("No. of input args is", len(args))
                contain_zero = any([x == 0 for x in args])
                print("Input arguments contain 0:", contain_zero)
                result = f(*args)    
                with open(filename, "w") as txt:
                    txt.write(result)
                    txt.close()
            return additional_function  
        return inter_function

a_decorater = A_decorater()    # 不可避免，还是要先生成一个实例

@a_decorater(filename)
def my_sum_function(*args):
    print("The sum is", sum(args))
    return str(sum(args))

my_sum_function(1, 2, 3)

参考

  1. ^Python装饰器、闭包 9. Python 装饰器、闭包 — openstack 1.0 documentation
  2. ^Python 函数装饰器 Python 函数装饰器 | 菜鸟教程



作者：无尘粉笔
链接：https://www.zhihu.com/question/271201015/answer/2387427580
来源：知乎
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

zxcjjjc
关注
7.Python中的装饰器（Decorator）
bai666ai的博客
02-21 407
《Python编程的术与道：Python语言进阶》视频课程 《Python编程的术与道：Python语言进阶》视频课程链接：https://edu.youkuaiyun.com/course/detail/28618 装饰器 （Decorator） 装饰器本质上是一个 Python 函数或类，它可以让其他函数或类在不需要做任何代码修改的前提下增加额外的功能。装饰器的返回值也是一个函数/类对象。有了装饰器，我们就可以抽离出大量与函数功能本身无关的雷同代码到装饰器中并继续重用。 它经常用于有切面(aspect)需求的场景，
Python 使用装饰器 decorator 修改函数行为
dowhileprogramming的专栏
12-30 1131
在 Python 中，装饰器是一种特殊的高阶函数，它使开发者能够在现有函数（或方法）中添加新功能，而无需添加或更改函数中的任何内容。标准装饰器是一个函数，它接受一个函数作为实参，返回一个内部函数，执行装饰工作。在一个函数上，可以使用多个装饰器，这可以通过链接装饰器实现。值得一提的是，装饰器在简化代码和以简洁的方式添加行为方面非常有用，但其代价是在执行过程中产生额外的开销。我们在调试程序的时候，需要更详细的函数调用信息，然而，使用了装饰器后，当我们在被装饰的函数上调用。装饰器，它返回了一个内部函数。
python中的装饰器decorator
Python热爱者的博客
08-30 502
python中的装饰器 装饰器是为了解决以下描述的问题而产生的方法 我们在已有的函数代码的基础上，想要动态的为这个函数增加功能而又不改变原函数的代码 例如有三个函数： def f1(x): return x def f2(x): return x*x def f3(x): return x*x*x 而我们想为这三个函数增加一个函数调用打印功能 类似print("call f1()") 如果我们直接修改的话，需要对每个函数的内部进行改写。 所以为了简化代码，我们可以使用python内
一文看懂Python系列之装饰器(decorator)
qq_44955314的博客
09-27 1482
python的装饰器可以在不修改源代码和调用方式的前提下为被装饰对象添加新功能
【python】装饰器：decorator
风高秋月白，雨霁晚霞红
07-03 1253
python装饰器。
python中装饰器decorator的用法及案例
qq_39400324的博客
05-30 1128
装饰器（Decorator）是 Python 中一种用于修改函数或类的行为的高级技术。装饰器本质上是一个函数，它接受一个函数作为输入，并返回一个新的函数作为输出。通过使用装饰器，可以在不修改原始函数代码的情况下，添加额外的功能或修改函数的行为。定义装饰器函数：创建一个装饰器函数，它接受一个函数作为参数，并返回一个新的函数。使用装饰器修饰函数：在要修饰的函数前面加上 @装饰器函数名 的语法糖。调用修饰后的函数：通过调用修饰后的函数来执行原始函数，并获得装饰器添加的额外功能或修改的行为。
python装饰器（Decorator）
棠越的博客
03-04 9322
python装饰器（Decorator）
Python 装饰器（Decorator）简介
weixin_43414019的博客
12-15 379
装饰器（Decorator）是 Python 中一种非常强大且灵活的功能，它允许在不修改函数本身的情况下，动态地扩展或修改函数的行为。简而言之，装饰器是用来“包装”函数或类的方法的函数，它可以在函数执行前或执行后做一些附加操作。装饰器是 Python 中一种非常有用的功能，它允许我们以优雅的方式扩展或修改函数的行为。装饰器不仅可以用于函数，也可以用于类。装饰器本质上是一个函数，它接受一个函数作为参数，并返回一个新的函数。如果装饰器需要接受参数，通常需要写一个嵌套的函数，使得装饰器本身能够接受参数。
Python-装饰器Decorator
u014783334的博客
08-05 307
python-装饰器的使用
Python-装饰器（Decorator）详解
网络风云的博客
12-16 9677
装饰器就是一个返回函数的函数。 是python 中的一种用于修改函数或方法行为的高级特性，功能强大且灵活。在提高代码复用、增强代码的可维护性、可扩展性方面有着广泛的应用。
理解Python的装饰器 decorator
nvd11的专栏
05-06 810
既然是装饰器， 肯定就是跟设计模式中的装饰模式有关了装饰器就是python 中对装饰模式的一种注解实现，令其可以对其他函数进行一些功能上的增强。住这里的增强并不是真正的修改函数的业务逻辑， 只是前后增加一些步骤。
python装饰器decorator介绍
12-24
一、装饰器decorator decorator设计模式允许动态地对现有的对象或函数包装以至于修改现有的职责和行为，简单地讲用来动态地扩展现有的功能。其实也就是其他语言中的AOP的概念，将对象或函数的真正功能也其他辅助的...
Python装饰器decorator用法实例
12-23
Python装饰器是编程中一种强大的工具，用于在不修改原函数代码的情况下，向函数添加额外功能。装饰器本质上是一个接收函数作为输入并返回新函数的函数。这种设计模式在Python中广泛使用，因为它允许程序员优雅地扩展...
深入了解和应用Python 装饰器 @decorator
09-19
### 深入了解与应用Python装饰器 @decorator #### 装饰器的概念及其重要性 在软件开发过程中，经常会遇到重复性的任务，比如登录验证、权限检查或者日志记录等功能。这些功能虽然重要但又相对独立，且在整个项目中...
力扣30 天 Pandas 挑战（3）---数据操作
最新发布
qq_66660756的博客
07-29 979
本文介绍了6道力扣Pandas简单题的解题思路：1) 177.第N高的薪水 - 通过去重排序获取第N高工资；2) 176.第二高薪水 - 类似177题的简化版；3) 184.部门最高薪员工 - 使用分组和合并查询部门最高薪；4) 178.分数排名 - 使用dense_rank()实现连续排名；5) 196.删除重复邮箱 - 通过排序和去重保留最小id记录；6) 1795.产品价格重构 - 使用melt()将宽表转为长表。这些题目涵盖了Pandas数据处理的基本操作，适合初学者练习数据清洗、转换和分析。
Redis 键值对操作详解：Python 实现指南
AI浩
07-29 903
场景推荐操作替代方案添加小数据SETHSET（对象）添加大数据HSET/MSET分批次添加添加临时数据SETEX删除小数据DELETEUNLINK删除大数据UNLINK无批量操作管道 + MSET/UNLINK单独命令添加操作使用set()添加单个键值对使用mset()批量添加多个键值对使用setex()添加带过期时间的键值对删除操作优先使用unlink()进行删除（尤其大型数据）仅在需要立即释放内存时使用delete()批量删除时结合管道提高效率。
【Python】绘制小提琴、箱线和散点的组合图
a11113112的博客
07-25 508
可根据需求修改各图的配色。
Python快速入门(2025版)：常量、变量
iotzgq的博客
07-28 670
本文介绍了Python编程中常量和变量的核心概念。常量是固定不变的值（如数字100、圆周率3.14），用于组成运算表达式；变量则是可变的存储空间（如num1=100），用于临时保存数据以便后续处理。文章通过生活化类比（如购物篮）和编程示例，清晰区分了两者的用途与差异，并强调这是Python编程的重要基础。适合初学者快速理解基本概念，为后续学习打下基础。
Python游戏开发：Pygame全面指南与实战
LiuYiCheng123456的博客
07-29 794
Pygame是一个基于Python的开源游戏开发库，提供多媒体应用开发所需的图形、声音和输入功能。文章首先介绍了Pygame的特点、与其他游戏引擎的对比以及安装方法。然后详细讲解了创建游戏窗口的基础知识，包括初始化、主循环结构和基本绘图功能，并提供了简单绘图板的完整示例代码。最后介绍了图像处理与动画技术，涵盖图像加载、变换和动画实现原理，附有角色动画的实践示例。全文循序渐进地展示了使用Pygame开发2D游戏的核心技术要点。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值