文档章节

Python 函数(类)的装饰器与闭包

lionets
 lionets
发布于 2013/11/23 20:35
字数 2571
阅读 3897
收藏 17

装饰器是在函数调用上的修饰。这些修饰仅是当声明一个函数或者方法的时候,才会应用的额外调用。

装饰器的语法看起来像是这个样子:

def decorator(func2bedecorated):#定义装饰器
    ```
    return wrappedFunc

@decorator([dec_opt_args])#使用装饰器
def func2bedecorated([func_opt_args]):#定义被装饰的函数
    ```
    ```
  • 首先需要定义装饰器(或者你也可以用内建的装饰器),其实装饰器就是一个函数,它接受其他函数为参数并返回一个装饰过的函数(或其他对象)。

  • 是的,装饰器在使用的时候后面没有冒号,因此下面的语句也就不需要缩进。

  • 从定义装饰器的语句可以看到,它是有返回值的。他把自定义的wrappedFunc 返回给了 func2bedecorated,也就是被装饰的函数自身,即,原函数被覆盖了。对应到数学概念上,使用装饰器来定义函数就像是写一个复合函数,就像 g(f(x)) 这样,g(x)是装饰器

因此看起来似乎正确的装饰器函数调用方法应该是这样:

func2bedecorated = decorator(func2bedecorated)

或者至少也应该是这样:

decorator(func2bedecorated)

实际上面两种方法都可行。从某种意义上说,装饰器的语法就是一个语法糖。还记得前面介绍过的如何定义类的静态方法么:

class C:
   def __init__(self):
       pass
    
   def foo():
       print("calling static method foo().")
   foo = staticmethod(foo)

这里的staticmethod()其实就是一个内建的装饰器函数。因此上面的示例代码也可以使用装饰器的标准语法写成:

class C:
   def __init__(self):
       pass
   
   @staticmethod 
   def foo():
       print("calling static method foo().")

这种语法看起来要漂亮得多。

好了,那么装饰器一般都用在什么地方呢?(除了上面提到的静态方法、或者静态属性)

于是最后给出一个时间戳的例子,因为偶尔会有给函数做性能测试的需求,如果给每个函数都手动添加 time.ctime() 的话,就太不科学了。这时候使用一个时间戳装饰器是个不错的做法:

from time import ctime,sleep

def tsfunc(func):
    def wrappedFunc():
        print('[%s] %s() called'%(ctime(),func.__name__))
        func()
        print('[%s] %s() ended'%(ctime(),func.__name__))
    return wrappedFunc


@tsfunc
def foo():
    sleep(1)

foo()

这里我们首先定义了一个名为 tsfunc 的时间戳装饰器。可以看到它对传入的 func 都做了什么:

  1. 在装饰器内定义出新的函数名为 wrappedFunc() ,好待会把它返回出去

  2. wrappedFunc 的实际内容仅为:先打印出一行程序启动的时间戳,随后调用 func() , 最后再打印出一行程序结束的时间戳

要做测试的演示函数 foo() 的内容仅是 sleep 一秒钟,可以看到下面的运行结果正如期望:

[Sat Nov 23 20:33:34 2013] foo() called
[Sat Nov 23 20:33:35 2013] foo() ended
>>>

在Python3 中,类也有装饰器了,用法与函数相同(即可以给装饰器函数传入一个class作为参数)。另外地,上面提到过一句,装饰器返回的可以不是一个函数。这一点会在之后的“描述符”(descriptor)中讲到。

然后,很多地方会提到,装饰器分为有参数和无参数两种。这种说法容易造成混淆,让人误以为他们之间只是带不带参数的区别。而实际上有无参数的装饰器在结构和功能上都是不同的。或者直白些讲:带参数的装饰器其实是一个返回另一个装饰器的 deco_maker,不带参数的装饰器才是真正的 real_deco。用伪代码可以表示为:

def real_deco(func_2b_decorated):
    def wrapped(func_2b_decorated):
        ...
        ...
    return wrapped

def deco_maker(deco_args):
    def real_deco(func_2b_decorated):
        ...
        ...
    return real_deco

即带参数的装饰器返回的其实是一个真正(不带参数)的装饰器。前面说过,装饰器就是一个函数,一个接受函数做参数并返回一个新函数的函数,所以装饰器也可以用来返回另一个装饰器就不难理解了。@deco 的语法仅是一种语法糖,它和社交网站的 @somebody 没有啥区别,表示通知 deco 来干活了。所以你看到 @deco 这语法里仅是 @ 了一下函数名;但带参数的情况就不同了,带参数的装饰器用起来是这样子的:

@deco_maker(deco_args)
def func_2b_decorated():
    ...
    ...

这里 @ 的对象明显已经不是一个函数名了,而是一个函数调用。所以这里真正被叫来干活(装饰 func_2b_decorated)的家伙其实是将要被 deco_maker 返回的那个 real_deco。

这就是带参数的装饰器的作用,他可以通过参数的设定来返回不同的装饰器,这比直接调用不同的装饰器看起来优雅一些。下面贴出一个带参数装饰器的示例,并引出闭包的话题:

from time import time

def logged(when):
    def log(f,*args,**kargs):
        print('''Called:
function:%s
args:%r
kargs:%r'''%(f,args,kargs))

    def pre_logged(f):
        def wrapper(*args,**kargs):
            log(f,*args,**kargs)
            return f(*args,**kargs)
        return wrapper

    def post_logged(f):
        def wrapper(*args,**kargs):
            now = time()
            try:
                return f(*args,**kargs)
            finally:
                log(f,*args,**kargs)
                print('time delta:%s'%(time()-now))
        return wrapper
    
    try:
        return {'pre':pre_logged,'post':post_logged}[when]
    except KeyError as e:
        raise ValueError(e,'must be "pre" or "post"')

下面是运行示例:

>>> @logged('post')
def hello(name):
    print("Hello,",name)

    
>>> hello('Worlds!')
Hello, Worlds!
Called:
function:<function hello at 0x000000000A69C2F0>
args:('Worlds!',)
kargs:{}
time delta:0.034002065658569336

本装饰器提供的功能为给函数加 log,而且分为“先输出 log,后调用函数”和“先调用函数,后输出 log”两种方式。log 的内容包含:函数名、非关键字参数、关键字参数的信息。并且如果是 post_log 的方式,还可以打印出函数执行花费的时间。和上面的时间戳功能类似。

这里在使用装饰器的时候,就给“@logged('post')”传了一个“post”参数,用来选定要返回的 real_deco。同时,返回的也是一个闭包。因为 Python 支持静态嵌套域,所以可以从函数内部访问外部作用域的变量。假如在一个外部函数中嵌套了一个内部函数,并且这个内部函数又引用了外部函数作用域里的变量,那么这个内部函数连带外部作用域一起,就叫做闭包。所以说到底闭包仍然是一个函数,但他比一般函数高级之处就是带了多余的自由变量(被引用的外部作用域(非全局)的变量就叫做自由变量)。这使得这个函数在调用的时候能记忆状态了,因为自由变量没有位于内部函数里,所以即使内部函数调用完毕,这个变量也不会被释放。这看起来就像类的属性一样,实际用起来也像类的属性一样。因为 Python 并非专业的函数式编程语言,所以除非有额外要求必须返回一个带自己作用域的回调函数,一般还是建议使用类实现。上面的装饰器就是一个有额外要求的例子。因为我们是要包装函数的,所以也要返回一个函数。返回的装饰器携带了 log() 函数,所以这个装饰器也就是一个闭包。

如果上面这个例子不明显的话,一般用来做闭包举例的是下面这样的计数程序:

def counter(start_at=0):
    count = [start_at]
    def incr():
        count[0] += 1
        return count[0]
    return incr

运行结果如下

>>> a = counter()
>>> b = counter(100)
>>> a()
1
>>> a()
2
>>> b()
101
>>> b()
102
>>> a()
3

a 和 b 两个函数对象分别携带了自己的自由变量 count,并可以通过这个变量来计数,这里用函数实现了平时要用一个类来实现的功能,并且对象还是可调用的。不过这里需要注意的是,如你所见在 counter() 函数里使用的是一个列表,既然只使用一个值(count[0]),干吗不用整数呢?这是因为如果把 count[0] 换成整数 count 的话,会报下面的错:

UnboundLocalError: local variable 'count' referenced before assignment

因为内部作用域会覆盖外部作用域。所以当你在内部作用域运行 count += 1,这条语句的时候,解释器会直接认定你在声明本地变量 count 并试图给它赋值。实际上解释器运行 incr() 这个函数时做的第一件事就是把 count 标记为本地变量,因为他看到了这个名字后面有一个赋值符号。而接下来又因为 count 还没有赋值,就被等号后面引用了,这才引发了那个异常。也就是说解释器根本没想着去外部作用域寻找 count 变量。但 count[0] 就不同了,这时的 count 是一个可变类型,解释器会试图寻找 count 并赋值,而不是直接声明本地变量。也许这种状况会让人产生“为什么 Python 不把变量声明和赋值分开呢,那样就不会出错了”的抱怨,但实际上这种动态设定带来的好处远比麻烦多,而且也不是没有方法来解决上面这个问题。(虽然这个方法是从 Python3 开始添加的)

这个解决方法就是 nonlocal 关键字,它的作用与 global 极其相似,区别仅在于作用域不同。Python2.1 以前函数只能访问自己的作用域或者全局作用域,那样有 global 就够用了,现在因为有了闭包,就需要一种声明变量既不是本地,又不是全局的方法,这就是 nonlocal。所以配合 nonlocal,就可以使用整数来实现上面的计数器了:

def counter(start_at=0):
    count = start_at
    def incr():
        nonlocal count
        count += 1
        return count
    return incr

运行:

>>> a = counter()
>>> a()
1
>>> a()
2

最后要说的是,闭包的功能是可以被类取代的。只要定义了 __call__(self) 方法,这个类的实例就是可调用的,再带上实例本身的属性,就可以当闭包用。

© 著作权归作者所有

共有 人打赏支持
lionets
粉丝 91
博文 98
码字总数 132850
作品 0
朝阳
程序员
python三大神器===》装饰器

1.认识装饰器   如果你经常看我的博客,你已经学会了python的前两大‘神器’(迭代器,生成器),那么什么是装饰器呢?就如字面意义装饰器是对某个事物(通常指函数)进行装饰,让其在不修改...

许传坤
08/23
0
0
Python基础——装饰器、模块(0417)

一、Python基础——复习 1、字符串的常用操作 2、列表的常用操作 3、字典的常用操作 二、Python——装饰器:函数可以是变量 1、Python是一种面向对象的编程语言,在Python中所有的都可以是Pyt...

python初雪之路
04/17
0
0
深入浅出 Python 装饰器:16 步轻松搞定 Python 装饰器

Python的装饰器的英文名叫Decorator,当你看到这个英文名的时候,你可能会把其跟Design Pattern里的Decorator搞混了,其实这是完全不同的两个东西。虽然好像,他们要干的事都很相似——都是想...

大数据之路
2015/07/12
0
2
Python 核心编程 (全)

浅拷贝和深拷贝 1.浅拷贝:是对于一个对象的顶层拷贝,通俗的理解是:拷贝了引用,并没有拷贝内容。相当于把变量里面指向的一个地址给了另一个变量就是浅拷贝,而没有创建一个新的对象,如a=b...

代码打碟手
08/18
0
1
Python3 与 C# 扩展之~基础拓展

上次知识回顾:https://www.cnblogs.com/dotnetcrazy/p/9278573.html 代码裤子:https://github.com/lotapp/BaseCode 在线编程:https://mybinder.org/v2/gh/lotapp/BaseCode/master 在线预览......

鲲逸鹏
07/19
0
0

没有更多内容

加载失败,请刷新页面

加载更多

【大福利】极客时间专栏返现二维码大汇总

我已经购买了如下专栏,大家通过我的二维码你可以获得一定额度的返现! 然后,再给大家来个福利,只要你通过我的二维码购买,并且关注了【飞鱼说编程】公众号,可以加我微信或者私聊我,我再...

飞鱼说编程
57分钟前
1
0
Spring5对比Spring3.2源码之容器的基本实现

最近看了《Spring源码深度解析》,该书是基于Spring3.2版本的,其中关于第二章容器的基本实现部分,目前spring5的实现方式已有较大改变。 Spring3.2的实现: public void testSimpleLoad(){...

Ilike_Java
今天
1
0
【王阳明心学语录】-001

1.“破山中贼易,破心中贼难。” 2.“夫万事万物之理不外于吾心。” 3.“心即理也。”“心外无理,心外无物,心外无事。” 4.“人心之得其正者即道心;道心之失其正者即人心。” 5.“无...

卯金刀GG
今天
2
0
OSChina 周三乱弹 —— 我们无法成为野兽

Osc乱弹歌单(2018)请戳(这里) 【今日歌曲】 @ _刚刚好: 霸王洗发水这波很骚 手机党少年们想听歌,请使劲儿戳(这里) hahahahahahh @嘻酱:居然忘了喝水。 让你喝可乐的话, 你准忘不了...

小小编辑
今天
9
0
vm GC 日志 配置及查看

-XX:+PrintGCDetails 打印 gc 日志 -XX:+PrintTenuringDistribution 监控晋升分布 -XX:+PrintGCTimeStamps 包含时间戳 -XX:+printGCDateStamps 包含时间 -Xloggc:<filename> 可以将数据保存为......

Canaan_
昨天
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部