Python闭包与装饰器

曾经终败给现在 2022-07-16 07:58 233阅读 0赞

# Python闭包与装饰器    #

**一、闭包**

函数是一个对象，所以可以对象的形式作为某个函数的结果返回。函数执行完后内部变量将会被回收。在闭包中，由于内部函数存在对外部函数的变量的引用，所以即使外部函数执行完毕，该变量依然存在。

闭包简单来说，外部函数FunOut()里面包含一个内部函数FunIn(),并且外部函数返回内部函数的对象FunIn，内部函数存在对外部函数的变量的引用。那么这个内部函数FunIn就叫做闭包。你在调用函数FunA的时候传递的参数就是自由变量。

def FunOut(name):#外部函数包含内部函数
      def FunIn(age):
        print 'name:', name, 'age:', age #内部函数存在对外部函数变量的引用，如name
      return FunIn                       #返回内部函数对象FunIn
    Funin= FunOut('Alian') #Alian传给参数name,并且返回函数FunIn对象给Funin
    Funin(25)              #此时Funin相当于调用函数FunIn，因此25传给参数age
    运行输出：
    name: Alian age: 25

这里面调用FunOut()的时候就产生了一个闭包FunIn，并且该闭包持有自由变量name，因此这也意味着，当函数FunOut()的生命周期结束之后，自由变量name依然存在，因为它被闭包引用了，所以不会被回收。

def line_conf(a, b):
        def line(x):
            return ax + b
        return line
     
    line1 = line_conf(1, 1)
    line2 = line_conf(4, 5)
    print(line1(5), line2(5))

这个例子中，函数line与环境变量a,b构成闭包。在创建闭包的时候，我们通过line\_conf的参数a,b说明了这两个环境变量的取值，这样，我们就确定了函数的最终形式(y = x + 1和y = 4x + 5)。我们只需要变换参数a,b，就可以获得不同的直线表达函数。由此，我们可以看到， 闭包也具有提高代码可复用性的作用。  
     如果没有闭包，我们需要每次创建直线函数的时候同时说明a,b,x。这样，我们就需要更多的参数传递，也减少了代码的可移植性。利用闭包，我们实际上创建了泛函。line函数定义一种广泛意义的函数。这个函数的一些方面已经确定(必须是直线)，但另一些方面(比如a和b参数待定)。随后，我们根据line\_conf传递来的参数，通过闭包的形式，将最终函数确定下来。

**二、装饰器概念**

**       Python的学习教程：http://www.liaoxuefeng.com/wiki/0014316089557264a6b348958f449949df42a6d3a2e542c000**

**     **  装饰器本质上是一个Python函数，它可以让其他函数在不需要做任何代码变动的前提下增加额外功能，装饰器的返回值也是一个函数对象。装饰器接受其他函数为参数并返回一个装饰过的函数（或其他对象）。

由于函数也是一个对象，而且函数对象可以被赋值给变量，所以，通过变量也能调用该函数。

>>> def now():
    ...     print '2013-12-25'
    ...
    >>> f = now
    >>> f()
    2013-12-25

函数对象有一个`__name__`属性，可以拿到函数的名字：

>>> now.__name__
    'now'
    >>> f.__name__
    'now'

现在，假设我们要增强`now()`函数的功能，比如，在函数调用前后自动打印日志，但又不希望修改`now()`函数的定义，这种在代码运行期间动态增加功能的方式，称之为“装饰器”（Decorator）。

本质上，decorator就是一个返回函数的高阶函数。所以，我们要定义一个能打印日志的decorator，可以定义如下：

def log(func):
        def wrapper(*args, **kw):
            print 'call %s():' % func.__name__
            return func(*args, **kw)
        return wrapper

观察上面的`log`，因为它是一个decorator，所以接受一个函数作为参数，并返回一个函数。我们要借助Python的@语法，把decorator置于函数的定义处：

@log
    def now():
        print '2013-12-25'

调用`now()`函数，不仅会运行`now()`函数本身，还会在运行`now()`函数前打印一行日志：

>>> now()
    call now(): 2013-12-25

把`@log`放到`now()`函数的定义处，相当于执行了语句：

now = log(now)

由于`log()`是一个decorator，返回一个函数，所以，原来的`now()`函数仍然存在，只是现在同名的now变量指向了新的函数，于是调用`now()`将执行新函数，即在`log()`函数中返回的`wrapper()`函数。

`wrapper()`函数的参数定义是`(*args, **kw)`，因此，`wrapper()`函数可以接受任意参数的调用。在`wrapper()`函数内，首先打印日志，再紧接着调用原始函数。

如果decorator本身需要传入参数，那就需要编写一个返回decorator的高阶函数，写出来会更复杂。比如，要自定义log的文本：

def log(text):
        def decorator(func):
            def wrapper(*args, **kw):
                print '%s %s():' % (text, func.__name__)
                return func(*args, **kw)
            return wrapper
        return decorator

这个3层嵌套的decorator用法如下：

@log('execute')
    def now():
        print '2013-12-25'

执行结果如下：

>>> now()
    execute now():
    2013-12-25

和两层嵌套的decorator相比，3层嵌套的效果是这样的：

>>> now = log('execute')(now)

我们来剖析上面的语句，首先执行`log('execute')`，返回的是`decorator`函数，再调用返回的函数，参数是`now`函数，返回值最终是`wrapper`函数。

以上两种decorator的定义都没有问题，但还差最后一步。因为我们讲了函数也是对象，它有`__name__`等属性，但你去看经过decorator装饰之后的函数，它们的`__name__`已经从原来的`'now'`变成了`'wrapper'`：

>>> now.__name__
    'wrapper'

因为返回的那个`wrapper()`函数名字就是`'wrapper'`，所以，需要把原始函数的`__name__`等属性复制到`wrapper()`函数中，否则，有些依赖函数签名的代码执行就会出错。

不需要编写`wrapper.__name__ = func.__name__`这样的代码，Python内置的`functools.wraps`就是干这个事的，所以，一个完整的decorator的写法如下：

import functools
    
    def log(func):
        @functools.wraps(func)
        def wrapper(*args, **kw):
            print 'call %s():' % func.__name__
            return func(*args, **kw)
        return wrapper

或者针对带参数的decorator：

import functools
    
    def log(text):
        def decorator(func):
            @functools.wraps(func)
            def wrapper(*args, **kw):
                print '%s %s():' % (text, func.__name__)
                return func(*args, **kw)
            return wrapper
        return decorator

`import functools`是导入`functools`模块。模块的概念稍候讲解。现在，只需记住在定义`wrapper()`的前面加上`@functools.wraps(func)`即可。

### 小结 ###

在面向对象（OOP）的设计模式中，decorator被称为装饰模式。OOP的装饰模式需要通过继承和组合来实现，而Python除了能支持OOP的decorator外，直接从语法层次支持decorator。Python的decorator可以用函数实现，也可以用类实现。

decorator可以增强函数的功能，定义起来虽然有点复杂，但使用起来非常灵活和方便。

请编写一个decorator，能在函数调用的前后打印出`'begin call'`和`'end call'`的日志。

再思考一下能否写出一个`@log`的decorator，使它既支持：

@log
    def f():
        pass

又支持：

@log('execute')
    def f():
        pass

### **(1)无参数装饰器** ###

# coding=utf-8
    def log(func):
        def wrapper(i, j):
            print('call %s():' % func.__name__)
            return func(i, j)
        return wrapper
    @log
    def now(i, j):
        print('i=%s ,j=%d' % (i, j))
    now(1, 2)

输出结果：

call now():
    i=1 ,j=2

上例，无参的装饰器，相当于直接调用：

now=log(now)
    now(1, 2)

**(2)有参数装饰器**

** **   如果decorator本身需要传入参数，则需要使用三层嵌套关系了

# coding=utf-8
    def log(text):
        def decorator(func):
            def wrapper(i, j):
                print('%s %s():' % (text, func.__name__))
                return func(i, j)
            return wrapper
        return decorator
    @log('execute')
    def now(i, j):
        print('i=%s ,j=%d' %(i ,j ))
    now = log("Alian")(now)
    now(1, 2)

1. 原文请参考：http://blog.csdn.net/thy38/article/details/4471421

2.Python装饰器学习 ：http://blog.csdn.NET/thy38/article/details/4471421  
3. Python装饰器与面向切面编程 ：http://www.cnblogs.com/huxi/archive/2011/03/01/1967600.html  
4. Python装饰器的理解： http://apps.hi.baidu.com/share/detail/17572338