python装饰器基础详解

装饰器(decorator)是一种高级python语法。装饰器可以对一个函数、方法或者类进行加工。在python中,我们有多种方法对函数和类进行加工,比如在python闭包中,我们见到函数对象作为某一个函数的返回结果。相对于其它方式,装饰器语法简单,代码可读性高。因此,装饰器在python项目中有广泛的应用。

前面快速介绍了装饰器的语法,在这里,我们将深入装饰器内部工作机制,更详细更系统地介绍装饰器的内容,并学习自己编写新的装饰器的更多高级语法。

什么是装饰器

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

【1】函数装饰器在函数定义的时候进行名称重绑定,提供一个逻辑层来管理函数和方法或随后对它们的调用。

【2】类装饰器在类定义的时候进行名称重绑定,提供一个逻辑层来管理类,或管理随后调用它们所创建的实例。

简而言之,装饰器提供了一种方法,在函数和类定义语句的末尾插入自动运行的代码——对于函数装饰器,在def的末尾;对于类装饰器,在class的末尾。这样的代码可以扮演不同的角色。
装饰器提供了一些和代码维护性和审美相关的有点。此外,作为结构化工具,装饰器自然地促进了代码封装,这减少了冗余性并使得未来变得更容易。

函数装饰器

通过在一个函数的def语句的末尾运行另一个函数,把最初的函数名重新绑定到结果。

用法

装饰器在紧挨着定义一个函数或方法的def语句之前的一行编写,并且它由@符号以及紧随其后的对于元函数的一个引用组成——这是管理另一个函数的一个函数(或其他可调用对象)。
在编码上,函数装饰器自动将如下语法:

@decorator
def f(arg):

f(99)

映射为这个对等形式:

def f(arg):

f = decorator(f)
f(99)

这里的装饰器是一个单参数的可调用对象,它返回与f具有相同数目的参数的一个可调用对象。
当随后调用f函数的时候,它自动调用装饰器所返回的对象。

换句话说,装饰实际把如下的第一行映射为第二行(尽管装饰器只在装饰的时候运行一次)

fun(6,7)
decorator(func)(6,7)

这一自动名称重绑定也解释了之前介绍的静态方法和property装饰器语法的原因:

class c:
@staticmethod
def meth(…):…
@property
def name(self):…

实现

装饰器自身是返回可调用对象的可调用对象。实际上,它可以是任意类型的可调用对象,并且返回任意类型的可调用对象:函数和类的任何组合都可以使用,尽管一些组合更适合于特定的背景。

有一种常用的编码模式——装饰器返回了一个包装器,包装器把最初的函数保持到一个封闭的作用域中:

def decorator(f):
def wrapper(*args):
# 使用 f 和 *args
# 调用原来的f(*args)
return wrapper
@decorator
def func(x,y):

func(6,7)

当随后调用名称func的时候,它确实调用装饰器所返回的包装器函数;随后包装器函数可能运行最初的func,因为它在一个封闭的作用域中仍然可以使用。

为了对类做同样的事情,我们可以重载调用操作:

class decorator:
def __init__(self,func):
self.func = func
def __call__(self,*args):
# 使用self.func和args
# self.func(*args)调用最初的func
@decorator
def func(x,y):

func(6,7)

但是,要注意的是,基于类的代码中,它对于拦截简单函数有效,但当它应用于类方法函数时,并不很有效:
如下反例:

class decorator:
def __init__(self,func):
self.func = func
def __call__(self,*args):
# 调用self.func(*args)失败,因为c实例参数无法传递
class c:
@decorator
def method(self,x,y):

这时候装饰的方法重绑定到一个类的方法上,而不是一个简单的函数,这一点带来的问题是,当装饰器的方法__call__随后运行的时候,其中的self接受装饰器类实例,并且类c的实例不会包含到一个*args中。

这时候,嵌套函数的替代方法工作得更好:

def decorator:
def warpper(*args):
# …
return wrapper
@decorator
def func(x,y):

func(6,7)
class c:
@decorator
def method(self,x,y):

x = c()
x.method(6,7)

类装饰器

类装饰器与函数装饰器使用相同的语法和非常相似的编码方式。类装饰器是管理类的一种方式,或者用管理或扩展类所创建的实例的额外逻辑,来包装实例构建调用。

用法

假设类装饰器返回一个可调用对象的一个单参数的函数,类装饰器的语法为:

@decorator
class c:

x = c(99)

等同于下面的语法:

class c:

c = decorator(c)
x = c(99)

直接效果是随后调用类名会创建一个实例,该实例会触发装饰器所返回的可调用对象,而不是调用最初的类自身。

实现

类装饰器返回的可调用对象,通常创建并返回最初的类的一个新的实例,以某种方式来扩展对其接口的管理。例如,下面的实例插入一个对象来拦截一个类实例的未定义的属性:

def decorator(cls):
class wrapper:
def __init__(self,*args):
self.wrapped = cls(*args)
def __getattr__(self,name):
return getattr(self.wrapped,name)
return wrapper
@decorator
class c: # c = decorator(c)
def __init__(self,x,y): # run by wrapper.__init__
self.attr = ‘spam’
x = c(6,7) # 等价于wrapper(6,7)
print(x.attr)

在这个例子中,装饰器把类的名称重新绑定到另一个类,这个类在一个封闭的作用域中保持了最初的类。

就像函数装饰器一样,类装饰器通常可以编写为一个创建并返回可调用对象的“工厂”函数。

装饰器嵌套

有时候,一个装饰器不够,装饰器语法允许我们向一个装饰器的函数或方法添加包装器逻辑的多个层。这种形式的装饰器的语法为:

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

如下这样转换:

def f(…):

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

这里,最初的函数通过3个不同的装饰器传递,每个装饰器处理前一个结果。

装饰器参数

函数装饰器和类装饰器都能接受参数,如下:

@decorator(a,b)
def f(arg):

f(99)

自动映射到其对等形式:

def f(arg):

f = decorator(a,b)(f)
f(99)

装饰器参数在装饰之前就解析了,并且它们通常用来保持状态信息供随后的调用使用。例如,这个例子中的装饰器函数,可能采用如下形式:

def decorator(a,b):
# 保存或使用a和b
def actualdecorator(f):
# 保存或使用函数 f
# 返回一个可调用对象
return callable
return actualdecorator

以上,这是装饰器的基础知识,接下来将学习编写自己的装饰器。

Posted in 未分类