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

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

(0)

相关推荐

  • Python的装饰器用法学习笔记

    在python中常看到在定义函数是使用@func. 这就是装饰器, 装饰器是把一个函数作为参数的函数,常常用于扩展已有函数,即不改变当前函数状态下增加功能. def run(): print "I'm run." 我有这么一个函数, 我想知道这个函数什么时候开始什么时候结束. 我应该这么写 def run(): print time.ctime() print "I'm run." print time.ctime() 但是如果不允许修改函数的话就需要装饰器了 de

  • 浅析Python编写函数装饰器

    编写函数装饰器 本节主要介绍编写函数装饰器的相关内容. 跟踪调用 如下代码定义并应用一个函数装饰器,来统计对装饰的函数的调用次数,并且针对每一次调用打印跟踪信息. class tracer: def __init__(self,func): self.calls = 0 self.func = func def __call__(self,*args): self.calls += 1 print('call %s to %s' %(self.calls, self.func.__name__)

  • 深入理解Python装饰器

    装饰器简介: 装饰器(decorator)是一种高级Python语法.装饰器可以对一个函数.方法或者类进行加工.在Python中,我们有多种方法对函数和类进行加工,比如在Python闭包中,我们见到函数对象作为某一个函数的返回结果.相对于其它方式,装饰器语法简单,代码可读性高.因此,装饰器在Python项目中有广泛的应用. 装饰器最早在Python 2.5中出现,它最初被用于加工函数和方法这样的可调用对象(callable object,这样的对象定义有__call__方法).在Python 2

  • 深入理解Python中装饰器的用法

    因为函数或类都是对象,它们也能被四处传递.它们又是可变对象,可以被更改.在函数或类对象创建后但绑定到名字前更改之的行为为装饰(decorator). "装饰器"后隐藏了两种意思--一是函数起了装饰作用,例如,执行真正的工作,另一个是依附于装饰器语法的表达式,例如,at符号和装饰函数的名称. 函数可以通过函数装饰器语法装饰: @decorator # ② def function(): # ① pass 函数以标准方式定义.① 以@做为定义为装饰器函数前缀的表达式②.在 @ 后的部分必须

  • Python的几个高级语法概念浅析(lambda表达式闭包装饰器)

    1. 匿名函数 匿名函数(anonymous function)是指未与任何标识符绑定的函数,多用在functional programming languages领域,典型应用场合: 1) 作为参数传给高阶函数(higher-order function ),如python中的built-in函数filter/map/reduce都是典型的高阶函数 2) 作为高阶函数的返回值(虽然此处的"值"实际上是个函数对象) 与命名函数(named function)相比,若函数只被调用1次或有

  • 12步教你理解Python装饰器

    通过下面的步骤让你由浅入深明白装饰器是什么.假定你拥有最基本的Python知识,本文阐述的东西可能对那些在工作中经常接触Python的人有很大的帮助. 1.函数(Functions) 在Python里,函数是用def关键字后跟一个函数名称和一个可选的参数表列来创建的,可以用关键字return指定返回值.下面让我们创建和调用一个最简单的函数: >>> def foo(): ... return 1 >>> foo() 1 该函数的函数体(在Python里将就是多行语句)是

  • python装饰器初探(推荐)

    一.含有一个装饰器 #encoding: utf-8 ############含有一个装饰器######### def outer(func): def inner(*args, **kwargs):#要装饰f1(),这里用这俩形式参数,可以接受任意个参数,不管f1定义几个参数 print "1" r = func(*args, **kwargs)#这里要用func,不要用f1 print "2" return r return inner @outer #这里ou

  • 简析Python的闭包和装饰器

    什么是装饰器? 装饰器(Decorator)相对简单,咱们先介绍它:"装饰器的功能是将被装饰的函数当作参数传递给与装饰器对应的函数(名称相同的函数),并返回包装后的被装饰的函数",听起来有点绕,没关系,直接看示意图,其中 a 为与装饰器 @a 对应的函数, b 为装饰器修饰的函数,装饰器@a的作用是: 简而言之:@a 就是将 b 传递给 a(),并返回新的 b = a(b) 栗子: 上面使用@dobi来表示装饰器,其等同于:qinfeng = dobi(qinfeng) 因此装饰器本质

  • Python黑魔法@property装饰器的使用技巧解析

    @property有什么用呢?表面看来,就是将一个方法用属性的方式来访问. 上代码,代码最清晰了. class Circle(object): def __init__(self, radius): self.radius = radius @property def area(self): return 3.14 * self.radius ** 2 c = Circle(4) print c.radius print c.area 可以看到,area虽然是定义成一个方法的形式,但是加上@pr

  • 详解Python装饰器由浅入深

    装饰器的功能在很多语言中都有,名字也不尽相同,其实它体现的是一种设计模式,强调的是开放封闭原则,更多的用于后期功能升级而不是编写新的代码.装饰器不光能装饰函数,也能装饰其他的对象,比如类,但通常,我们以装饰函数为例子介绍其用法.要理解在Python中装饰器的原理,需要一步一步来.本文尽量描述得浅显易懂,从最基础的内容讲起. (注:以下使用Python3.5.1环境) 一.Python的函数相关基础 第一,必须强调的是python是从上往下顺序执行的,而且碰到函数的定义代码块是不会立即执行它的,只

  • 深入理解python中的闭包和装饰器

    python中的闭包从表现形式上定义(解释)为:如果在一个内部函数里,对在外部作用域(但不是在全局作用域)的变量进行引用,那么内部函数就被认为是闭包(closure). 以下说明主要针对 python2.7,其他版本可能存在差异. 也许直接看定义并不太能明白,下面我们先来看一下什么叫做内部函数: def wai_hanshu(canshu_1): def nei_hanshu(canshu_2): # 我在函数内部有定义了一个函数 return canshu_1*canshu_2 return

随机推荐