Python中的装饰器
本文的内容主要参考了《Python进阶》一书
装饰器(Decorators)是什么?
我理解的装饰器,主要是设计模式中的装饰器模式(关于设计模式的内容,个人觉得写的最清楚的就是《Head First》系列的设计模式了)。在Python中,所谓的装饰器指的是一种能够修改其他Python函数的特殊函数,以我目前的理解,两者实现的功能是一致的。
万物皆对象
我们知道,在Python中,一切都是对象,自然我们最常用的函数也是Python中的一个对象,因此我们可以在Python函数中定义函数,可以在函数中传递函数,也可以在Python的函数中返回函数
请看如下的代码:
# coding:utf-8
def my_function():
print("This is a function to do something")
def a_new_decorators(a_func):
def wrap_func():
print("I am doing some work before executing a_func()")
a_func()
print("I am doing some work after executing a_func()")
return wrap_func
a_function_requiring_decoration = a_new_decorators(my_function)
a_function_requiring_decoration()
I am doing some work before executing a_func()
This is a function to do something
I am doing some work after executing a_func()
在上面的代码中,我们首先定义了一个函数my_function
,这可以认为是一个需要执行特定功能的函数。之后,我们定义了一个函数a_new_decorators
,在该函数内部又定义了一个wrap_func
,在其执行特定功能后,将wrap_func
作为返回值返回。之后,我们定义了一个新的变量a_function_requiring_decoration
,该变量明显等于返回的wrap_func
,因此当调用该函数时,系统会输出:
I am doing some work before executing a_func()
This is a function to do something
I am doing some work after executing a_func()
事实上,你已经完成了一个装饰器的编写工作!
很神奇吧,只不过你没有看到我们常见的使用@的这种方式。接下来,我们来使用带有“@”符号的写法
@a_new_decorators
def my_new_function():
print("This is a new function to do something")
my_new_function()
I am doing some work before executing a_func()
This is a new function to do something
I am doing some work after executing a_func()
非常完美,相信现在你已经能够理解了Python的装饰器的工作原理和其具体的实现方式,但是其实还是有一点点小问题的,我们来看一下
print(my_new_function.__name__)
wrap_func
看到了么?如果按照上述写法,函数的名字会发生变化,怎么办呢?幸运的是,Python已经提供了一个装饰器接口来帮助我们处理上述问题,此时我们应该修改装饰器函数,即
from functools import wraps
def a_new_decorators(a_func):
@wraps(a_func)
def wrap_func():
print("I am doing some work before executing a_func()")
a_func()
print("I am doing some work after executing a_func()")
return wrap_func
@a_new_decorators
def my_new_function():
print("This is a new function to do something")
print(my_new_function.__name__)
my_new_function
是不是感觉好多了?接下来,可以把函数的参数加进去:
from functools import wraps
def a_new_decorators(a_func):
@wraps(a_func)
def wrap_func(*args, **kwargs):
print("I am doing some work before executing a_func()")
return a_func(*args, **kwargs)
print("I am doing some work after executing a_func()")
return wrap_func
以上就是一个完整的装饰器的写法,在《Python进阶》一书的代码中,还使用了一个全局变量can_run
,我理解按照封装的原理,是不是不应该将其暴露出来,这里暂且算一个小疑问吧,如果有理解的朋友,希望帮忙解答一下。
装饰器类
装饰器已经很好用了,但是正所谓“人心不足蛇吞象”,当我们使用装饰器的时候,有时也会遇到几件事需要做的差不太多,但是呢,又需要写多个装饰器,这就很尴尬了。
事实上,要实现上述功能,还是有办法的,仔细想想这不就是面向对象中“多态”的概念么?于是,在这种场景下,装饰器类闪亮✨登场:
以下代码抄袭自《Python进阶》中的装饰器类一节
from functools import wraps
class logit(object):
def __init__(self, logfile='out.log'):
self.logfile = logfile
def __call__(self, func):
@wraps(func)
def wrapped_function(*args, **kwargs):
log_string = func.__name__ + " was called"
print(log_string)
with open(self.logfile, 'a') as opened_file:
opened_file.write(log_string + '\n')
self.notify()
return func(*args, **kwargs)
return wrapped_function
def notify(self):
pass
上面的方式是定义了一个装饰器类,其主要功能是在执行特定的函数时,将执行该操作的动作记录到文件out.log
中,同时发送一个通知。此时,如果我们想发送不同种类的通知(例如通过微信、短信、邮件等多种形式),那么就可以继承该类,下面的类是一个发送email版本的
class email_logit(logit):
'''
一个logit的实现版本,可以在函数调用时发送email给管理员
'''
def __init__(self, email='admin@myproject.com', *args, **kwargs):
self.email = email
super(email_logit, self).__init__(*args, **kwargs)
def notify(self):
# 发送一封email到self.email
# 这里就不做实现了
pass
其优势在于代码更加规整,更加灵活,但是调用方式不发生变化:
@logit
def myfunc1():
pass
@email_logit
def myfunc2():
pass
以下为《Python进阶》中一些装饰器的常用场景,此处照搬原书,如有侵权请及时联系我。
装饰器的常用场景
授权(Authorization)
装饰器能有助于检查某个人是否被授权去使用一个web应用的端点(endpoint)。它们被大量使用于Flask和Django web框架中。这里是一个例子来使用基于装饰器的授权:
from functools import wraps
def requires_auth(f):
@wraps(f)
def decorated(*args, **kwargs):
auth = request.authorization
if not auth or not check_auth(auth.username, auth.password):
authenticate()
return f(*args, **kwargs)
return decorated