装饰器和类的装饰器

已于 2023-03-14 21:06:19 修改
阅读量780 收藏 2
点赞数 1
文章标签： python 开发语言
于 2023-02-14 21:22:28 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_67859959/article/details/129033003
版权
本文详细介绍了Python装饰器的概念、工作流程、定义方式，包括无参、有参和多重装饰器的使用。还探讨了装饰器中的闭包、@wraps的作用，以及如何使用装饰器来实现功能如时间计时。此外，文章还讨论了类的装饰器，如classmethod、staticmethod和property的用法。
摘要由CSDN通过智能技术生成

目录

❤  python装饰器介绍

❤  什么是装饰器

❤  装饰器的流程

❤  定义装饰器时通常会涉及以下3个函数

无参装饰器

有参装饰器

多重装饰器

❤  装饰器的用法(闭包)

❤  装饰器语法糖

❤  时间计时器

❤  装饰器中@wraps作用

不使用@wraps装饰器

使用@wraps装饰器解决这个问题

❤  装饰器顺序 

❤  类的装饰器 - classmethod

绑定到对象的方法

绑定到类的方法

❤  类的装饰器 - property

❤  类的装饰器 - staticmethod 

python从小白到总裁完整教程目录:https://blog.csdn.net/weixin_67859959/article/details/129328397?spm=1001.2014.3001.5502

❤  python装饰器介绍

  1. 在Python中，装饰器（decorator）是在闭包的基础上发展起来的。
  2. 装饰器的实质是一个高阶函数，其参数是要装饰的函数名，其返回值是完成装饰的函数名，其作用是为已经存在的函数对象添加额外的功能，其特点是不需要对原有函数做任何代码上的变动。
  3. 装饰器在本质上也是一个嵌套函数，其外层函数的返回值是一个新的函数对象引用，所不同的是，其外层函数可以接受一个现有函数对象引用作为参数。
  4. 装饰器可以用于包装现有函数，即在不修改任何代码的前提下为现有函数增加额外功能。
  5. 装饰器通常应用于有切面（面向切面编程是指运行时动态实现程序维护的一种技术）需求的场景，例如插入日志、性能测试、事务处理、缓存以及权限校验等。
  6. 装饰器是解决这类问题的绝佳设计，有了装饰器，就可以抽离出大量与函数功能本身无关的雷同代码并继续重用它们。

❤  什么是装饰器

装饰是为函数和类指定管理代码的一种方式。Python装饰器以两种形式呈现：

  • 函数装饰器在函数定义的时候进行名称重绑定。提供一个逻辑层来管理函数和方法或随后对它们的调用。
  • 类装饰器在类定义的时候进行名称重绑定，提供一个逻辑层来管理类。或管理随后调用它们所创建的实例。

❤  装饰器的流程

  • A函数是装饰器，B函数是A函数传入的参数。

  • 将B函数在A函数中执行，在A函数中可以选择执行或不执行，也可以对B函数的结果进行二次加工处理。

简而言之，装饰器提供了一种方法，在函数和类定义语句的末尾插入自己主动执行的代码——对于函数装饰器。在def的末尾。对于类装饰器，在class的末尾。

这种代码能够扮演不同的角色。
装饰器提供了一些和代码维护性和审美相关的有点。此外，作为结构化工具，装饰器自然地促进了代码封装，这降低了冗余性并使得未来变得更easy。

❤  定义装饰器时通常会涉及以下3个函数:

1）装饰器函数：它在函数嵌套关系中作为外层函数出现，其函数体内容包括定义一个内层函数以完成装饰功能的函数，通过return语句向调用者返回内层函数对象引用。
2）目标函数：即需要进行装饰的函数，它作为装饰器函数的形参出现，该函数的定义则出现在调用装饰器的地方。
3）完成装饰的函数：它在函数嵌套关系中作为内层函数出现，用于为待装饰的目标函数添加额外功能。在这个内层函数中要调用目标函数，并为目标函数添加一些新的功能

无参装饰器

def 装饰器名称(待装饰器函数名称):
    def 装饰器函数名称():
        # 目标函数执行前 添加额外功能
        # 目标函数调用 待装饰器函数执行
        # 目标函数执行后 添加额外功能
    return 装饰器函数名称

def decorator(func):
    def inner(*args, **kwargs):
        # func是被装饰的对象，这里可以写执行前的功能
        res = func(*args, **kwargs)
        # func是被装饰的对象，这里可以写执行后的功能
    return inner

# 使用装饰器

@装饰器名称
def 需装饰函数名称():
    pass

无参数装饰器本质就是一个双层结构的高阶函数，有参数装饰器则是一个3层结构的高阶函数。

有参装饰器

def 装饰器名称(参数1， 参数2，...):
    def 中间层装饰器函数名称(待装饰器函数名称)
        def 里层装饰器函数名称():
            # 目标函数执行前 添加额外功能
            # 目标函数调用 待装饰器函数执行
            # 目标函数执行后 添加额外功能
        return 装饰器函数名称
    return 中间层装饰器函数名称

def decorator(arg1, arg2):
    def middle(func):
        def inner(*args, **kwargs):
            # func是被装饰的对象，这里可以写执行前的功能 可使用参数 arg1, arg2
            res = func(*args, **kwargs)
            # func是被装饰的对象，这里可以写执行后的功能 可使用参数 arg1, arg2
        return inner
    return middle

# 使用装饰器

@装饰器名称(arg1, arg2)
def 需装饰函数名称():
    pass

多重装饰器

多重装饰器是指使用多个装饰器来修改同一个函数。此时要注意多重装饰器的执行顺序是后面的装饰器先执行，前面的装饰器后执行，即后来者居上

def first(func):
    def inner(*args, **kwargs):
        print("函数：first执行...")
        func(*args, **kwargs)
        print("函数：first完成")
    return inner

def second(func):
    def inner(*args, **kwargs):
        print("函数：second执行...")
        func(*args, **kwargs)
        print("函数：second完成")
    return inner

# 两装饰器应用于同一函数

@first
@second
def test():
    print("函数：test执行")

# 执行结果
"""
函数：first执行...
函数：second执行...
函数：test执行
函数：second完成
函数：first完成
"""

❤  装饰器的用法(闭包)

闭包（Closure），又称词法闭包（Lexical Closure）或函数闭包（function closures），是引用了自由变量的函数。

这个被引用的自由变量将和这个函数一同存在，即使已经离开了创造它的环境也不例外。

def print_msg():  # print_msg是外围函数
    msg = "I'm closure"

    def printer():  # printer是嵌套函数
        print(msg)
    return printer

closure = print_msg()  # 这里获得的就是一个闭包
closure()  # 输出 I'm closure

msg是一个局部变量，在print_msg函数执行之后就不会存在了。

但是嵌套函数引用了这个变量，将这个局部变量封闭在了嵌套函数中，这样就形成了一个闭包。

❤  装饰器语法糖

语法糖（Syntactic sugar），也译为糖衣语法，指计算机语言中添加的某种语法。

这种语法对语言的功能并没有影响，但是更方便程序员使用。

通常来说使用语法糖能够增加程序的可读性，从而减少程序代码出错的机会。

@ 符号是装饰器的语法糖。它放在一个函数开始定义的地方（头顶），和这个函数绑定在一起。

在我们调用这个函数的时候，会先将这个函数做为参数传入它头顶，即装饰器里。

❤  时间计时器

以下用装饰器来实现计算一个函数的执行时长，让函数睡眠3秒

# 这是装饰函数
def timer(func):
    def wrapper(*args, **kw):
        start_time = time.time()
        func(*args, **kw)  # 这是函数真正执行的地方
        stop_time = time.time()
        cost_time = stop_time - start_time
        print("花费时间：{}秒".format(cost_time))
    return wrapper

import time

@timer
def want_sleep(sleep_time):
    time.sleep(sleep_time)

want_sleep(3)

❤  装饰器中@wraps作用

装饰器（decorator）在实现的时候，被装饰后的函数其实已经是另外一个函数了（函数名等函数属性会发生改变）。

为了不影响，Python的functools包中提供了一个叫wraps的装饰器来消除这样的副作用。

写一个装饰器的时候，最好在实现之前加上functools中的wraps，它能保留原有函数的名称和文档字符串(DocStrings)。

文档字符串用于解释文档程序，帮助程序文档更加简单易懂。

可以在函数体的第一行使用一对三个单引号 ‘’’ 或者一对三个双引号 “”" 来定义文档字符串。

使用 doc（注意双下划线）调用函数中的文档字符串属性。

不使用@wraps装饰器

def decorator(func):
    """this is decorator __doc__"""

    def wrapper(*args, **kwargs):
        """this is wrapper __doc__"""
        print("this is wrapper method")
        return func(*args, **kwargs)
    return wrapper

@decorator
def test():
    """this is test __doc__"""
    print("this is test method")

print("__name__: ", test.__name__)
print("__doc__:  ", test.__doc__)

输出:

__name__:  wrapper
__doc__:   this is wrapper __doc__

分析：
对test()方法进行装饰时候，实际上是

test = decorator(test)

返回的是wrapper方法的引用，也就是让test指向了wrapper方法，所以调用test.name, 实际上是wrapper.name。

这造成后面查找该方法的名字和注释时得到装饰器内嵌函数的名字和注释。

使用@wraps装饰器解决这个问题

from functools import wraps


def decorator(func):
    """this is decorator __doc__"""

    @wraps(func)
    def wrapper(*args, **kwargs):
        """this is wrapper __doc__"""
        print("this is wrapper method")
        return func(*args, **kwargs)
    return wrapper

@decorator
def test():
    """this is test __doc__"""
    print("this is test method")

print("__name__: ", test.__name__)
print("__doc__:  ", test.__doc__)

输出:

__name__:  test
__doc__:   this is test __doc__

❤  装饰器顺序 

一个函数可以同时定义多个装饰器，比如：

@a
@b
@c
def f ():
    pass

它的执行顺序是从里到外，最先调用最里层的装饰器，最后调用最外层的装饰器，它等效于：

f = a(b(c(f)))

❤  类的装饰器 - classmethod

@classmethod： *****
类的对象绑定的方法都是默认传self参数的，但是当这个self在方法中不被使用时，
然后在方法中准备使用类的静态属性，就可以将该方法修改为类方法
在外部可以不用实例化对象直接通过类名调用类方法

绑定到对象的方法：

在类内部没有任何修饰的情况下直接定义一个方法默认绑定一个self给对象来用

class Mysql:
    def __init__(self,host,port):
        self.host=host
        self.port=port

    def tell_info(self):  
        print("<%s:%s>" %(self.host,self.port))

    
conn1=Mysql('127.0.0.1',8080)
conn1.tell_info()

输出:

<127.0.0.1:8080> 

绑定到类的方法：

当函数体代码需要传进来的参数不再是对象了，而是类的时候

以下是实现从配置文件里读IP和端口，完成实例化的程序：

settings

import settings

class Mysql:
    def __init__(self,host,port):
        self.host=host
        self.port=port

    def tell_info(self):
        print("<%s:%s>" %(self.host,self.port))

    @classmethod   #绑定给类，由类来掉，把它当做第一个参数传进来完成实例化，再把结果返回
    def from_conf(cls):
        return cls(settings.HOST, settings.PORT)

conn2=Mysql.from_conf()print（conn2.tell_info）
conn2.tell_info()

# 打印结果：<bound method Mysql.tell_info of <__main__.Mysql object at 0x00C9CFF0>>          <1.1.1.1:8080>

我们得出以下结论：

  • 在带有 classmethod 装饰器 的 函数 内，是无法调用普通的 带有 self 的函数的
  • 但是在普通的带有 self 的类函数内，是可以调用带有 classmethod 装饰器 的 函数的

 ❤  类的装饰器 - property

property是一种特殊的属性，可实现把函数名变为属性名使用。它可以在不改变类接口的前提下使用存取方法 (即读值和取值)

来修改数据的属性，property类有3个方法getter（读操作）、setter（赋值操作）、deleter（删除操作），分别把对应的操作

绑定到指定的函数实现，应用如下：

class People:
    def __init__(self,name,weight,height):
        self.name=name
        self.wt=weight
        self.ht=height

    @property
    def bmi(self):
        return self.wt / (self.ht ** 2)

    @property     #便于用户访问隐藏的内部值name
    def name(self):
        return self.__name

    @name.setter   #便于用户 修改name值
    def name(self,obj): #obj='EGON'
        if not isinstance(obj,str):
            raise TypeError('名字的值必须是str类型')
        self.__name=obj #self.__name='EGON'

    @name.deleter
    def name(self):
        del self.__name

p=People('egon',75,1.80)
# print(p.bmi)

# print(p.name)
# p.name='EGON'
# p.name=123       #报错
# print(p.name)

# del p.name   #删除name

❤  类的装饰器 - staticmethod 

非绑定方法，不与任何东西绑定，定义的函数不需要任何东西传进来

import uuid

class Mysql:
    def __init__(self,host,port):
        self.host=host
        self.port=port

    @staticmethod
    def create_id():
        return uuid.uuid4()


print(Mysql.create_id)
print(Mysql.create_id())


#打印结果：<function Mysql.create_id at 0x02C6EC90>         2209806a-5ffc-47f2-86f1-cb2ac64ce404

整体代码：

import settings
import uuid

class Mysql:
    def __init__(self,host,port):
        self.host=host
        self.port=port

    def tell_info(self):
        print("<%s:%s>" %(self.host,self.port))

    @classmethod
    def from_conf(cls):
        return cls(settings.HOST, settings.PORT)

    @staticmethod
    def create_id():
        return uuid.uuid4()

conn1=Mysql('127.0.0.1',8080)
conn1.tell_info()

conn2=Mysql.from_conf()
conn2.tell_info()
print(conn2.tell_info)


print(Mysql.create_id)
print(Mysql.create_id())

#打印结果：<127.0.0.1:8080>         <1.1.1.1:8080>         <bound method Mysql.tell_info of <__main__.Mysql object at 0x038294B0>>         <function Mysql.create_id at 0x03831E40>         bab5e25e-7de3-4273-a8cf-40829c716d87

附：使用最广泛的装饰器为 classmethod

橙子味冰可乐
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
装饰器之时间装饰器和类装饰器
Archi_gakki的博客
12-09 232
什么是装饰器 装饰他人的器具，本身可以是任意可调用对象，被装饰者也可以是任意可调用对象。 开放封闭原则 对修改封闭，对扩展开放。 1 不修改被装饰对象的源代码。 2 不修改被装饰对象的调用方式。 装饰器的目标： 在遵循1和2的前提下，为被装饰对象添加上新功能。 装饰器是一个很著名的设计模式，经常被用于有切面需求的场景，较为经典的有插入日志、性能测试、事务处理等。装饰器是解决这类问题的绝佳设计，有了...
django如何通过类视图使用装饰器
09-18
### Django 如何通过类视图使用装饰器 在Django框架中，装饰器是一种非常强大的工具，用于在不修改原始函数或方法的基础上增加新的功能。本文将详细介绍如何设计装饰器来过滤黑名单中的IP地址，并探讨如何在类视图...
类的装饰器
最新发布
h960822的博客
06-26 362
yield i # 函数中有yieid 代表生成了生成器。result = re.match(正则表达式，要匹配的字符串)with 语句 结合上下文 管理器对象使用。print('进入上文方法')print('进入下午方法')4 使用contextmanager装饰器。print('开始生成数据')print('触发了吗')print('执行完了')深拷贝 ：deepcopy。8 正则表达式 re模块。cory为浅拷贝函数。1 使用类定义装饰器。
类装饰器
a593504017的博客
08-07 406
首先__call__方法。 def func(): print('hello') func() print(func()) # 调用--->call--->啥啥的不能called # 对应的，类实例对象的调用，需要使用到__call__特殊方法 class Student: def __init__(self, name): self.name =...
[Python] 类装饰器
知智
07-11 5103
在Python中，是一个装饰器（decorator），用于定义抽象方法（abstract method）。抽象方法是在父类中声明但没有具体实现的方法。子类必须实现该抽象方法才能被实例化。使用装饰器，可以将方法标记为抽象方法。抽象方法在父类中声明时没有提供具体的实现，只有方法名和参数列表。而子类必须提供具体实现以满足父类中的抽象方法要求。以下是一个示例，展示如何使用。
python中的类装饰器
Xzike的博客
03-30 6242
装饰器本身既可以是函数也可以是类，装饰的对象同样可以是函数也可以是类。 例1： import time class Timer: def __init__(self,func) -> None: self.func = func def __call__(self, *args, **kwargs): start = time.time() ret = self.func(*args, **kwargs) prin
TypeScript系列教程十一《装饰器》 -- 类装饰器
星宇大前端
03-18 1894
TS 类装饰器学习总结
Python类装饰器实现方法详解
09-19
在Python中，装饰器是一种强大的功能，可以用来修改或增强函数和类的行为。本文将详细介绍如何使用类装饰器，并通过具体的实例展示其实现方法与使用技巧。 #### 二、什么是类装饰器？ 类装饰器与函数装饰器类似，...
python类装饰器用法实例
09-21
2. **动态修改类行为**：可以通过类装饰器动态地向类添加方法或属性，或者修改现有的方法和属性。 3. **日志记录**：可以使用类装饰器为类的所有方法添加日志记录逻辑。 4. **验证和约束**：可以在类定义时添加验证...
基于Python 装饰器装饰类中的方法实例
09-20
首先，让我们理解类方法和装饰器的基本概念。类方法是属于类的函数，通过`self`参数与类的实例进行交互。装饰器则是一个可调用的对象（通常是函数），它接收一个函数作为输入，并返回一个新的函数，通常会添加额外的...
Python如何将装饰器定义为类
12-17
你需要让你的装饰器可以同时工作在类定义的内部和外部。 解决方案 为了将装饰器定义成一个实例，你需要确保它实现了 __call__() 和 __get__() 方法。 例如，下面的代码定义了一个类，它在其他函数上放置一个简单的...
闭包-装饰器-类装饰-类装饰器传参
Stephen_zsky的博客
04-20 777
闭包闭包:两个函数的嵌套,外部函数返回内部函数的引用,外部函数一定有参数 def 外部函数(参数): def 内部函数(): pass return 内部函数 他跟函数之间的区别: 1.格式两个函数嵌套 2.闭包外部函数的参数可以在内存中保持装饰器装饰器是什么:闭包加@xxx 装饰器的作用:在不改变原先的函数值跟调用的方式,添加额外...
装饰器--装饰器类
mutong_wu的博客
08-30 1679
装饰器的作用： 简单来说，可以把装饰器理解为一个包装函数的函数，它一般将传入的函数或者是类做一定的处理，返回修改之后的对象。 所以我们能够在不修改原函数的基础上，在执行原函数前后执行别的代码，比较常用的场景有日志插入，事物处理等 我们知道，在python中函数也是被视为对象的，可以作为参数传递，那么假如把计算机耗时的独立为一个单独的函数，然后把需要计算耗时的函数都不用修改自己的代码了 普通...
Python 类装饰器
02-24 2539
Python 类装饰器类装饰器顾名思义用类写的装饰器，首先看类的定义class A: def __init__(self, arg = 'a'): print( arg ) def __call__(self, arg): #使对象可以像函数一样调用 print( arg )
装饰器是类装饰器
05-31
是的，装饰器可以是类装饰器。类装饰器是一种特殊的装饰器，它的目标是类而不是函数。类装饰器可以用来修改、替换或扩展类的行为。 类装饰器的基本语法如下所示： ```python def class_decorator(cls): # 在这里修改、替换或扩展类的行为 return cls # 返回修改后的类 ``` 在类装饰器中，`cls`代表被装饰的类对象。你可以在类装饰器中修改、替换或扩展类的任何行为，例如添加属性、方法或修改类的基类等。最后，记得要返回修改后的类对象。 下面是一个简单的类装饰器的示例，它用来给类添加一个`description`属性： ```python def add_description(cls): cls.description = "This is a class" return cls @add_description class MyClass: pass print(MyClass.description) # 输出：This is a class ``` 在这个例子中，我们定义了一个`add_description`函数来作为类装饰器。这个函数接受一个类对象作为参数，并为这个类对象添加了一个`description`属性。最后，我们使用`@add_description`语法来装饰`MyClass`类，这样`MyClass`类就拥有了`description`属性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

橙子味冰可乐

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值