今天给大家分享一下关于装饰器的知识点,内容非常干,全程高能,认真吸收看完,一定会对装饰器有更深的理解。
Hello,装饰器
装饰器本质上是一个Python函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外功能,装饰器的返回值也是一个函数对象。
它经常用于有切面需求的场景,比如:插入日志、性能测试、事务处理、缓存、权限校验等场景。
装饰器是解决这类问题的绝佳设计,有了装饰器,我们就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。
装饰器的使用方法很固定
- 先定义一个装饰器(帽子)
- 再定义你的业务函数或者类(人)
- 最后把这装饰器(帽子)扣在这个函数(人)头上
就像下面这样子
- # 定义装饰器
- def decorator(func):
- def wrapper(*args, **kw):
- return func()
- return wrapper
- # 定义业务函数并进行装饰
- @decorator
- def function():
- print("hello, decorator")
实际上,装饰器并不是编码必须性,意思就是说,你不使用装饰器完全可以,它的出现,应该是使我们的代码
更加优雅,代码结构更加清晰
将实现特定的功能代码封装成装饰器,提高代码复用率,增强代码可读性
接下来,我将以实例讲解,如何编写出各种简单及复杂的装饰器。
第一种:普通装饰器
首先咱来写一个最普通的装饰器,它实现的功能是:
- 在函数执行前,先记录一行日志
- 在函数执行完,再记录一行日志
- # 这是装饰器函数,参数 func 是被装饰的函数
- 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 函数。
- add(200, 50)
来看看输出了什么?
- 我准备开始执行:add 函数了:
- 200 + 50 = 250
- 我执行完啦。
第二种:带参数的函数装饰器
通过上面两个简单的入门示例,你应该能体会到装饰器的工作原理了。
不过,装饰器的用法还远不止如此,深究下去,还大有文章。今天就一起来把这个知识点学透。
回过头去看看上面的例子,装饰器是不能接收参数的。其用法,只能适用于一些简单的场景。不传参的装饰器,只能对被装饰函数,执行固定逻辑。
装饰器本身是一个函数,做为一个函数,如果不能传参,那这个函数的功能就会很受限,只能执行固定的逻辑。这意味着,如果装饰器的逻辑代码的执行需要根据不同场景进行调整,若不能传参的话,我们就要写两个装饰器,这显然是不合理的。
比如我们要实现一个可以定时发送邮件的任务(一分钟发送一封),定时进行时间同步的任务(一天同步一次),就可以自己实现一个 periodic_task (定时任务)的装饰器,这个装饰器可以接收一个时间间隔的参数,间隔多长时间执行一次任务。
可以这样像下面这样写,由于这个功能代码比较复杂,不利于学习,这里就不贴了。
- @periodic_task(spacing=60)
- def send_mail():
- pass
- @periodic_task(spacing=86400)
- def ntp()
- pass
那我们来自己创造一个伪场景,可以在装饰器里传入一个参数,指明国籍,并在函数执行前,用自己国家的母语打一个招呼。
- # 小明,中国人
- @say_hello("china")
- def xiaoming():
- pass
- # jack,美国人
- @say_hello("america")
- def jack():
- pass
那我们如果实现这个装饰器,让其可以实现 传参 呢?
会比较复杂,需要两层嵌套。
- 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
来执行一下
- xiaoming()
- print("------------")
- jack()
看看输出结果。
- 你好!
- ------------
- hello.
第三种:不带参数的类装饰器
以上都是基于函数实现的装饰器,在阅读别人代码时,还可以时常发现还有基于类实现的装饰器。
基于类装饰器的实现,必须实现 __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))
- say("hello")
执行一下,看看输出
- [INFO]: the function say() is running...
- say hello!
第四种:带参数的类装饰器
上面不带参数的例子,你发现没有,只能打印INFO级别的日志,正常情况下,我们还需要打印DEBUG WARNING等级别的日志。这就需要给类装饰器传入参数,给这个函数指定级别了。
带参数和不带参数的类装饰器有很大的不同。
__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))
- say("hello")
我们指定WARNING级别,运行一下,来看看输出。
- [WARNING]: the function say() is running...
- say hello!
第五种:使用偏函数与类实现装饰器
绝大多数装饰器都是基于函数和闭包实现的,但这并非制造装饰器的唯一方式。
事实上,Python 对某个对象是否能通过装饰器( @decorator)形式使用只有一个要求:decorator 必须是一个“可被调用(callable)的对象。
对于这个 callable 对象,我们最熟悉的就是函数了。
除函数之外,类也可以是 callable 对象,只要实现了__call__ 函数(上面几个例子已经接触过了)。
还有容易被人忽略的偏函数其实也是 callable 对象。
接下来就来说说,如何使用 类和偏函数结合实现一个与众不同的装饰器。
如下所示,DelayFunc 是一个实现了 __call__ 的类,delay 返回一个偏函数,在这里 delay 就可以做为一个装饰器。(以下代码摘自 Python工匠:使用装饰器的小技巧)
- 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 这个类。装饰器用在类上,并不是很常见,但只要熟悉装饰器的实现过程,就不难以实现对类的装饰。在上面这个例子中,装饰器就只是实现对类实例的生成的控制而已。
其实例化的过程,你可以参考我这里的调试过程,加以理解。