Python里Decorator的本质

 Python的修饰器的英文名叫Decorator,当你看到这个英文名的时候,你可能会把其跟Design Pattern里的Decorator搞混了,其实这是完全不同的两个东西。在认识装饰器之前,我们先来点感性认识,看一个Python修饰器的Hello World的代码。

1

2

3

4

5

6

7

8

9

10

11

12

13

下面是代码:文件名:hello.py

def hello(fn):

    def wrapper():

        print "hello, %s" % fn.__name__

        fn()

        print "goodby, %s" % fn.__name__

    return wrapper

  

@hello

def foo():

    print "i am foo"

  

foo()

 当你运行代码,你会看到如下输出:

1

2

3

4

[chenaho@chenhao-air]$ python hello.py

hello, foo

i am foo

goodby, foo

 你可以看到如下的东西:
  1)函数foo前面有个@hello的“注解”,hello就是我们前面定义的函数hello;
  2)在hello函数中,其需要一个fn的参数(这就用来做回调的函数);
  3)hello函数中返回了一个inner函数wrapper,这个wrapper函数回调了传进来的fn,并在回调前后加了两条语句。

Decorator 的本质

  对于Python的这个@注解语法糖- Syntactic Sugar 来说,当你在用某个@decorator来修饰某个函数func时,如下所示:

1

2

3

@decorator

def func():

    pass

其解释器会解释成下面这样的语句:

1

func = decorator(func)

   了然,这不就是把一个函数当参数传到另一个函数中,然后再回调吗?是的,但是,我们需要注意,那里还有一个赋值语句,把decorator这个函数的返回值赋值回了原来的func。 根据《函数式编程》中的first class functions中的定义的,你可以把函数当成变量来使用,所以,decorator必需得返回了一个函数出来给func,这就是所谓的higher order function 高阶函数,不然,后面当func()调用的时候就会出错。 就我们上面那个hello.py里的例子来说,

1

2

3

@hello

def foo():

    print "i am foo"

 被解释成了:

1

foo = hello(foo)

 是的,这是一条语句,而且还被执行了。你如果不信的话,你可以写这样的程序来试试看:

1

2

3

4

5

6

def fuck(fn):

    print "fuck %s!" % fn.__name__[::-1].upper()

  

@fuck

def wfg():

    pass

 没了,就上面这段代码,没有调用wfg()的语句,你会发现, fuck函数被调用了,而且还很NB地输出了我们每个人的心声!

  再回到我们hello.py的那个例子,我们可以看到,hello(foo)返回了wrapper()函数,所以,foo其实变成了wrapper的一个变量,而后面的foo()执行其实变成了wrapper()。知道这点本质,当你看到有多个decorator或是带参数的decorator,你也就不会害怕了。

比如:多个decorator:

1

2

3

4

@decorator_one

@decorator_two

def func():

    pass

 相当于:

1

func = decorator_one(decorator_two(func))

 比如:带参数的decorator:

1

2

3

@decorator(arg1, arg2)

def func():

    pass

 相当于:

1

func = decorator(arg1,arg2)(func)

 这意味着decorator(arg1, arg2)这个函数需要返回一个“真正的decorator”。

带参数及多个Decrorator

我们来看一个有点意义的例子:

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

def makeHtmlTag(tag, *args, **kwds):

    def real_decorator(fn):

        css_class = " class='{0}'".format(kwds["css_class"]) if "css_class" in kwds else ""

        def wrapped(*args, **kwds):

            return "<"+tag+css_class+">" + fn(*args, **kwds) + "</"+tag+">"

        return wrapped

    return real_decorator

  

@makeHtmlTag(tag="b", css_class="bold_css")

@makeHtmlTag(tag="i", css_class="italic_css")

def hello():

    return "hello world"

  

print hello()

  

# 输出:

# <b class='bold_css'><i class='italic_css'>hello world</i></b>

 在上面这个例子中,我们可以看到:makeHtmlTag有两个参数。所以,为了让 hello = makeHtmlTag(arg1, arg2)(hello) 成功,makeHtmlTag 必需返回一个decorator(这就是为什么我们在makeHtmlTag中加入了real_decorator()的原因),这样一来,我们就可以进入到 decorator 的逻辑中去了—— decorator得返回一个wrapper,wrapper里回调hello。看似那个makeHtmlTag() 写得层层叠叠,但是,已经了解了本质的我们觉得写得很自然。

上一篇:设计模式第六讲--装饰模式 Decorator


下一篇:ovirt自承载引擎安装配置 安装过程中的FQDN问题