Python装饰器四种实现方式

原创 于 2024-08-03 15:32:36 发布 · 1.5k 阅读 · 19 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#python #开发语言

装饰器的概念就不介绍了，按照装饰器的类型、被装饰对象的类型，我将装饰器分为如下四种：

  1. 函数的函数装饰器：装饰器和被装饰对象都为函数；
  2. 类的函数装饰器：装饰器为函数，被装饰对象为类；
  3. 函数的类装饰器：装饰器为类，被装饰对象为函数；
  4. 类的类装饰器：装饰器和被装饰对象都为类。

一.函数的函数装饰器

装饰器包含装饰对象和被装饰对象，最简单的装饰器是用装饰器函数装饰被装饰函数，在这种场景下，装饰器为函数装饰器，被装饰对象也是函数。

1、概述

函数装饰器就是一个特殊的函数，该函数的参数就是一个函数，在装饰器函数内重新定义一个新的函数，并且在其中执行某些功能前后或中间来使用被装饰的函数，最后返回这个新定义的函数。

装饰器也可以称为函数的包装器，实际上就是在被装饰的函数执行前或后增加一些单独的逻辑代码，以使得被装饰函数执行后最终的结果受到装饰函数逻辑的影响以改变或限定被装饰函数的执行结果。

2、装饰器定义语法
@decoratorName
def originalFunction（*args,**kwargvs）:

    函数体
3、装饰器语法解释

装饰器的定义是以@符号开头来声明的
decoratorName是装饰器的名字，decoratorName必须对应存在一个封闭函数，该封闭函数满足如下要求：

  • 参数是一个函数对象；
  • 封闭函数内部存在一个嵌套函数，该嵌套函数内会调用封闭函数参数指定的函数，并添加额外的其他代码（这些代码就是装饰）；
  • 嵌套函数的参数必须包含originalFunction的参数，但不能带被装饰对象originalFunction；
  • 嵌套函数返回值必须与封闭函数参数指定函数的返回值类似，二者符合鸭子类型要求；
  • 封闭函数的返回值必须是嵌套函数。

装饰器函数的定义参考如下形式：

def decoratorName(originalFunction,*args,**kwargvs):

    def closedFunction(*args,**kwargvs):
        ...  #originalFunction函数执行前的一些装饰代码
        ret = originalFunction(*args,**kwargvs)
        ... #originalFunction函数执行的一些装饰代码
        return ret

    return closedFunction

其中decoratorName是装饰器函数，originalFunction是被装饰的函数，closedFunction是装饰器函数内的嵌套函数。

装饰器定义的语法本质上等同于如下语句：

originalFunction = decoratorName(originalFunction)
4、多层装饰器的使用

在一个函数外，可以顺序定义多个装饰器，类似如：

@decorator1
@decorator2
@decorator3
def originalFunction（*args,**kwargvs）:
    函数体

这种多个装饰器实际上就是叠加作用，且在上面的装饰器是对其下装饰器的包装，以上定义语句效果等同于如下语句：

originalFunction = decorator3(originalFunction)
originalFunction = decorator2(originalFunction)
originalFunction = decorator1(originalFunction)

也即等价于：

originalFunction = decorator1（decorator2（decorator3(originalFunction)））

二、类的函数装饰器

1、定义

函数装饰器除了给函数加装饰器（使用函数名作为装饰器函数的参数）外，还可以给类加函数装饰器，给类加函数装饰器时，将类名作为装饰器函数的参数，并在装饰器函数内定义一个类如wrapClass，该类称为包装类，包装类的构造函数中必须调用被装饰类来定义一个实例变量，装饰器函数将返回包装类如wrapClass。

2、类的函数装饰器案例1
def decorateFunction(fun, *a, **k):
    class wrapClass():
        def __init__(self, *a, **k):
            self.wrappedClass=fun(*a, **k)

        def fun1(self,*a, **k):
            print("准备调用被装饰类的方法fun1")
            self.wrappedClass.fun1(*a, **k)
            print("调用被装饰类的方法fun1完成")

    return wrapClass

@decorateFunction
class wrappedClass:

    def __init__(self ,*a, **k):
        print("我是被装饰类的构造方法")
        if a:print("构造方法存在位置参数：",a)
        if k:print("构造方法存在关键字参数：",k)
        print("被装饰类构造方法执行完毕")

    def fun1(self,*a, **k):
        print("我是被装饰类的fun1方法")
        if a:print("fun1存在位置参数：",a)
        if k:print("fun1存在关键字参数：",k)
        print("被装饰类fun1方法执行完毕")

    def fun2(self,*a, **k):
        print("我是被装饰类的fun2方法")

针对以上被装饰函数装饰的类wrappedClass，我们执行如下语句：

>>> c1 = wrappedClass('testPara',a=1,b=2)
我是被装饰类的构造方法
构造方法存在位置参数： ('testPara',)
构造方法存在关键字参数： {'a': 1, 'b': 2}
被装饰类构造方法执行完毕

>>> c1.fun1()
准备调用被装饰类的方法fun1
我是被装饰类的fun1方法
被装饰类fun1方法执行完毕
调用被装饰类的方法fun1完成

>>> c1.fun2()
Traceback (most recent call last):
  File "<pyshell#37>", line 1, in <module>
    c1.fun2()
AttributeError: 'wrapClass' object has no attribute 'fun2'

>>>

可以看到被装饰类的相关方法必须在装饰类中调用才能执行，装饰后的类如果装饰函数定义类时未定义被装饰类的同名函数，在装饰后返回的类对象无法执行被装饰类的相关方法。

3、类的函数装饰器案例2

上面的案例1是通过将被装饰类的方法在装饰器函数内部的装饰类中静态重新定义方式来实现对被包装类方法的支持，这种情况可以用于装饰器装饰后的类只需调用指定已知方法，但有时我们的装饰器可能用于装饰多个类，只针对构造方法和特定方法在装饰类中重写会导致被装饰类需要调用的功能不能调用，这时我们需要在装饰器中实现一个通用方法来保障被装饰类装饰后能执行被装饰类的所有方法。这就需要借助setattr进行类实例方法的动态定义。

def decorateFunction(fun, *a, **k):
    class wrapClass():
        def __init__(self, *a, **k):
            self.wrappedClass=fun(*a, **k)
            self.decorate() #针对没有重写定义的方法赋值给wrapClass作为实例变量，本案例中为涉及的为fun2方法

        def fun1(self,*a, **k):
            print("准备调用被装饰类的方法fun1")
            self.wrappedClass.fun1(*a, **k)
            print("调用被装饰类的方法fun1完成")

        def decorate(self):#针对没有重写定义的方法赋值给wrapClass作为实例变量

            for m in dir(self.wrappedClass):
                if not m.startswith('_')and m!='fun1':
                    fn = getattr(self.wrappedClass, m)
                    if callable(fn):
                        setattr(self, m,fn)

    return wrapClass

@decorateFunction
class wrappedClass:
    def __init__(self ,*a, **k):
        print("我是被装饰类的构造方法")
        self.name = a[0]
        if a:print("构造方法存在位置参数：",a)
        if k:print("构造方法存在关键字参数：",k)
        print("被装饰类构造方法执行完毕")        

    def fun1(self,*a, **k):
        print("我是被装饰类的fun1方法")   
        if a:print("fun1存在位置参数：",a)
        if k:print("fun1存在关键字参数：",k)
        print("我的实例名字为:",self.name)
        print("被装饰类fun1方法执行完毕")

    def fun2(self,*a, **k):
        print("我是被装饰类的fun2方法")
        if a:print("fun2方法存在位置参数：",a)
        if k:print("fun2存在关键字参数：",k)
        print("我的实例名字为:",self.name)

针对以上被装饰函数装饰的类wrappedClass，我们执行如下语句：

>>> c1 = wrappedClass('c1',a=1,b=2)
我是被装饰类的构造方法
构造方法存在位置参数： ('c1',)
构造方法存在关键字参数： {'a': 1, 'b': 2}
被装饰类构造方法执行完毕

>>> c2 = wrappedClass('c2',a=12,b=22)
我是被装饰类的构造方法
构造方法存在位置参数： ('c2',)
构造方法存在关键字参数： {'a': 12, 'b': 22}
被装饰类构造方法执行完毕

>>> c1.fun1()
准备调用被装饰类的方法fun1
我是被装饰类的fun1方法
我的实例名字为: c1
被装饰类fun1方法执行完毕
调用被装饰类的方法fun1完成

>>> c2.fun2()
我是被装饰类的fun2方法
我的实例名字为: c2

>>> c1.fun2()
我是被装饰类的fun2方法
我的实例名字为: c1

>>>

可以看到，除了在装饰类中重写的fun1方法可以正常执行外，没有重写的方法fun2也可以正常执行。

三、函数的类装饰器

除了用函数作为装饰器装饰函数或者装饰类之外，也可以使用类作为函数的装饰器。将类作为函数的装饰器时，需将要装饰的函数作为装饰器类的实例成员，由于装饰后，调用相关方法时实际上调用的是装饰类的实例对象本身，为了确保类的实例对象可以调用，需要给类增加 __call__方法。

案例：

class decorateClass:
    def __init__(self,fun):
        self.fun=fun

    def __call__(self, *a, **k):
        print("执行被装饰函数")
        return self.fun( *a, **k)

@decorateClass 
def fun( *a, **k):
    print(f"我是函数fun,带参数：",a,k)

定义后执行相关调用情况如下：

>>> f = fun('funcation1',a=1,b=2)
执行被装饰函数
我是函数fun,带参数： ('funcation1',) {'a': 1, 'b': 2}
>>>

四、类的类装饰器

前面分别介绍了函数的函数装饰器、类的函数装饰器、函数的类装饰器，但公开资料中未查到是否可以有类的类装饰器，即装饰器和被装饰对象都是类。老猿参考类的函数装饰器、函数的类装饰器最终确认类的类装饰器也是可以支持的。

1、实现要点

要实现类的类装饰器，按老猿的研究，类的装饰器类的实现需要遵循如下要点：

  • 装饰器类必须实现至少两个实例方法，包括__init__和__call__；
  • 在装饰器类的构造方法的参数包括self,wrapedClass,*a,**k，其中wrapedClass代表被装饰类，a代表被装饰类构造方法的位置参数，k代表被装饰类构造方法的关键字参数；
  • 在装饰器类的构造方法中定义一个包装类如叫wrapClass，包装类从装饰器类的构造方法的参数wrapedClass（即被装饰类）继承，包装类wrapClass的构造方法参数为self,*a,**k，相关参数含义同上；
  • 在包装类的构造方法中调用父类的构造方法，传入参数a、k；
  • 在装饰器类的构造方法中用实例变量(例如self.wrapedClass)保存wrapClass类；
  • 在装饰器类的__call__方法中调用self.wrapedClass(*a,**k)创建被装饰类的一个对象，并返回该对象。

按照以上步骤创建的类装饰器，就可以用于装饰其他类。当然上述方法只是老猿自己研究测试的结论，是否还有其他方法老猿也不肯定。

2、类的类装饰器案例
#学习中遇到问题没人解答？小编创建了一个Python学习交流群：531509025
class decorateClass: #装饰器类
    def __init__(self,wrapedClass,*a,**k): #wrapedClass代表被装饰类
        print("准备执行装饰类初始化")

        class wrapClass(wrapedClass):
            def __init__(self,*a,**k):
                print(f"初始化被封装类实例开始，位置参数包括:{a}, 关键字参数为{k}")
                super().__init__(*a,**k)
                print(f"初始化被封装类实例结束")

        self.wrapedClass=wrapClass
        print("装饰类初始化完成")

    def __call__(self, *a, **k):
        print("被装饰类对象初始化开始")
        wrapedClassObj = self.wrapedClass(*a,**k)
        print("被装饰类对象初始化结束")
        return wrapedClassObj

@decorateClass
class car:
    def __init__(self,type,weight,cost):
        print("class car __init__ start...")
        self.type = type
        self.weight = weight
        self.cost = cost
        self.distance = 0
        print("class car __init__ end.")

    def driver(self,distance):
        self.distance += distance
        print(f"{self.type}已经累计行驶了{self.distance}公里")       

c = car('爱丽舍','1.2吨',8)
c.driver(10)
c.driver(110)

执行以上代码，输出如下：

准备执行装饰类初始化
装饰类初始化完成
被装饰类对象初始化开始
初始化被封装类实例开始，位置参数包括:('爱丽舍', '1.2吨', 8), 关键字参数为{}
class car __init__ start...
class car __init__ end.
初始化被封装类实例结束
被装饰类对象初始化结束
爱丽舍已经累计行驶了10公里
爱丽舍已经累计行驶了120公里
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值