深入理解python3中的装饰器

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_42415326/article/details/91357453

一、装饰器语法糖

 没错,符号就是装饰器的语法糖。

语法糖(Syntactic sugar),也译为糖衣语法,指计算机语言中添加的某种语法,这种语法对语言的功能并没有影响,但是更方便程序员使用。

它放在一个函数开始定义的地方,它就像一顶帽子一样戴在这个函数的头上。和这个函数绑定在一起。在我们调用这个函数的时候,第一件事并不是执行这个函数,而是将这个函数做为参数传入它头顶上这顶帽子,这顶帽子我们称之为装饰函数 或 装饰器

将 和函数绑定在一起,在我们调用函数的时候,第一件事并不是执行这个函数,而是将这个函数做为参数传入 中,@我们称之为装饰函数 或 装饰器

装饰器的使用方法很固定:

  • 先定义一个装饰函数(帽子)(也可以用类、偏函数实现)
  • 再定义你的业务函数、或者类(人)
  • 最后把这顶帽子带在这个人头上

装饰器的简单的用法有很多,这里举两个常见的。

  • 日志打印器
  • 时间计时器

 

二、入门用法1:日志打印器

首先是日志打印器

实现的功能:

  • 在函数执行前,先打印一行日志告知下要执行函数了。
  • 在函数执行完,再打印一行日志告知下函数执行完了。
# 这是装饰函数
def logger(func):
    def wrapper(*args, **kw):
        print('我准备开始计算:{} 函数了:'.format(func.__name__))

        # 真正执行的是这行。
        func(*args, **kw)

        print('啊哈,我计算完啦。给自己加个鸡腿!!')
    return wrapper

假如,我的业务函数是,计算两个数之和。写好后,直接给它带上帽子。

 
@logger              #装饰器
def add(x, y):       #被装饰函数
    print('{} + {} = {}'.format(x, y, x+y))

然后我们来计算一下。

add(200, 50)

快来看看输出了什么,神奇不?

扫描二维码关注公众号,回复: 6418271 查看本文章
我准备开始计算:add 函数了:
200 + 50 = 250
啊哈,我计算完啦。给自己加个鸡腿!

 

三、入门用法2:时间计时器

时间计时器 ,实现功能:顾名思义,就是计算一个函数的执行时长。

# 这是装饰函数
def timer(func):
    def wrapper(*args, **kw):
        t1=time.time()
        # 这是函数真正执行的地方
        func(*args, **kw)
        t2=time.time()

        # 计算下时长
        cost_time = t2-t1 
        print("花费时间:{}秒".format(cost_time))
    return wrapper

假如,我们的函数是要睡眠10秒。这样也能更好的看出这个计算时长到底靠不靠谱。

import time

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

want_sleep(10)

来看看,输出。真的是10秒耶。真历害!!!

花费时间:10.0073800086975098秒

 

四、进阶用法:带参数的函数装饰器

上面的例子,装饰器是不能接收参数的。其用法,只能适用于一些简单的场景。

装饰器的用法远不止如此。我们今天就要把这个知识点讲透。

不传参的装饰器,只能对被装饰函数,执行固定逻辑。但在项目中,常常看到的装饰器是带有参数的。

装饰器本身是一个函数,而装饰器需要两层嵌套来实现传参。

举个例子,我们要在这两个函数的执行的时候,分别根据其国籍,来说出一段打招呼的话。

def american():
    print("我来自中国。")

def chinese():
    print("I am from America.")

对于上面这两个函数,在加上装饰器,就需要指明传入参数(是哪国人),以此来打出对应的招呼。

加上装饰器后如下:

@say_hello("china")
def chinese():
    print("我来自中国。")

@say_hello("america")
def american():
    print("I am from America.")

最后就需要来定义一下带有参数装饰函数,这里需要两层嵌套来实现。

def say_hello(contry):
    def wrapper(func):
        def deco(*args, **kwargs):
            if contry == "china":
                print("你好!")
            elif contry == "america":
                print('hello.')
            else:
                return

            # 真正执行函数的地方
            func(*args, **kwargs)
        return deco
    return wrapper

主函数:

if __name__ = "__main__":
    american()
    print("------------")
    chinese()

完整代码和输出结果如下:

def say_hello(contry):
    def wrapper(func):
        def deco(*args, **kwargs):
            if contry == "china":
                print("你好!")
            elif contry == "america":
                print('hello.')
            else:
                return

            # 真正执行函数的地方
            func(*args, **kwargs)
        return deco
    return wrapper

@say_hello("china")
def chinese():
    print("我来自中国。")

@say_hello("america")
def american():
    print("I am from America.")


if __name__ = "__main__":
    american()
    print("------------")
    chinese()


输出结果:
你好!
我来自中国。
------------
hello.
I am from America

五、高阶用法1:不带参数的类装饰器

以上都是基于函数实现的装饰器,还有基于类实现的装饰器

基于类装饰器的实现,必须实现 __call__ 和 __init__两个内置方法。
__init__ :接收被装饰函数
__call__ :实现装饰逻辑。

举个例子:

class logger(object):
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        print("[INFO]: the function {func}() is running...".format(func=self.func.__name__))
        return self.func(*args, **kwargs)

@logger
def say(something):
    print("say {}!".format(something))

if __name__  == "__main__":
    say("hello")



输出结果如下:
[INFO]: the function say() is running...
say hello!

 

六、高阶用法2:带参数的类装饰器

不带参数的类装饰器,其用法,只能适用于一些简单的场景。上述例子只能打印INFO级别的日志,正常情况下,我们还需要打印DEBUG WARNING等级别的日志。

这就需要给类装饰器传入参数,给这个函数指定级别了。

不带参数的类装饰器必须实现的 __call__ 和 __init__两个内置方法大有不同。

__init__ :不再接收被装饰函数,而是接收传入参数。
__call__ :接收被装饰函数,实现装饰逻辑。

举个栗子:

#类装饰
class logger(object):
    def __init__(self, level='INFO'):
        self.level = level

    def __call__(self, func): # 接受函数
        def wrapper(*args, **kwargs):
            print("[{level}]: the function {func}() is running..."\
                .format(level=self.level, func=func.__name__))
            func(*args, **kwargs)
        return wrapper  #返回函数


@logger(level='WARNING')    #基于类的装饰器
def say(something):         #被装饰函数
    print("say {}!".format(something))


if __name__ == "__main__":
    say("hello")


输出结果如下:
[WARNING]: the function say() is running...
say hello!

七、使用偏函数与类实现装饰器

绝大多数装饰器都是基于函数和闭包实现的,但这并非制造装饰器的唯一方式。

事实上,Python 对某个对象是否能通过装饰器( @decorator形式使用只有一个要求:decorator 必须是一个“可被调用(callable)的对象”。

对于这个 callable 对象包括:

  • 函数
  • 实现了__call__ 函数的类
  • 偏函数

接下来就来说说,如何基于类和偏函数来结合实现一个与众不同的装饰器。

如下所示,DelayFunc 是一个实现了 __call__ 的类,delay 返回一个偏函数,在这里 delay 就可以做为一个装饰器:

import time
import functools

class DelayFunc:
    def __init__(self,  duration, func):
        self.duration = duration
        self.func = func

    def __call__(self, *args, **kwargs):
        print(f'Wait for {self.duration} seconds...')
        time.sleep(self.duration)
        return self.func(*args, **kwargs)

    def eager_call(self, *args, **kwargs):
        print('Call without delay')
        return self.func(*args, **kwargs)

def delay(duration):
    """
    装饰器:推迟某个函数的执行。
    同时提供 .eager_call 方法立即执行
    """
    # 此处为了避免定义额外函数,
    # 直接使用 functools.partial 帮助构造 DelayFunc 实例
    return functools.partial(DelayFunc, duration)

被装饰函数 :

@delay(duration=2)
def add(a, b):
    return a+b

执行输出过程如下:

>>> add    # 可见 add 变成了 Delay 的实例
<__main__.DelayFunc object at 0x107bd0be0>
>>> 
>>> add(3,5)  # 直接调用实例,进入 __call__
Wait for 2 seconds...
8
>>> 
>>> add.func # 实现实例方法
<function add at 0x107bef1e0>

八、如何写能装饰类的装饰器?

用 Python 写单例模式的时候,其中的一种写法,就是用装饰器来实现的。

举个装饰器版的单例写法的例子:

instances = {}


def singleton(cls):
    def get_instance(*args, **kw):
        cls_name = cls.__name__
        print('===== 1 ====')
        if not cls_name in instances:
            print('===== 2 ====')
            instance = cls(*args, **kw)
            instances[cls_name] = instance
        return instances[cls_name]
    return get_instance

@singleton
class User:
    _instance = None

    def __init__(self, name):
        print('===== 3 ====')
        self.name = name

可以看到我们用singleton 这个装饰函数来装饰 User 这个类。装饰器用在类上,并不是很常见,但只要熟悉装饰器的实现过程,就不难以实现对类的装饰。在上面这个例子中,装饰器就只是实现对类实例的生成的控制而已。

其实例化的过程,你可以参考我这里的调试过程,加以理解。

 

九、wraps 装饰器有啥用?

在 functools 标准库中有提供一个 wraps 装饰器,你应该也经常见过,那他有啥用呢?

先来看一个例子:

def wrapper(func):
    def inner_function():
        pass
    return inner_function

@wrapper
def wrapped():
    pass

print(wrapped.__name__)
#inner_function

猜你喜欢

转载自blog.csdn.net/qq_42415326/article/details/91357453