Python裝飾器（decorator）

了解裝飾器，要先了解閉包。

 

1，閉包（closure）

閉包是Python所支持的一種特性，它讓在非global scope定義的函數可以引用其外圍空間中的變量，這些外圍空間中被引用的變量叫做這個函數的環境變量。環境變量和這個非全局函數一起構成了閉包。

def outer(x):
    y = [1,2,3]
    def inner():
        print x
        print y
    return inner

x = 5    #這個x沒有被引用
f = outer(2)
f()
print f.__closure__   #函數屬性__closure__存儲了函數的環境變量

x和y都是屬於函數outer命名空間的，在inner中被引用，當outer函數退出后，outer的命名空間不存在了，但是inner依然維護了其定義時候對其外部變量x，y的連接。

程序輸出：

　　2
　　[1, 2, 3]
　　(<cell at 0x7f672a5b98d8: int object at 0x23a3c50>, <cell at 0x7f672a5b9910: list object at 0x7f672a5a03f8>)

 

 

2，裝飾器（Decorator）

裝飾器是一個可調用對象（a callable），在Python中，函數是對象，當然也是可調用的，所以裝飾器可以是一個函數，我們稱其為函數裝飾器。

這個可調用對象以一個函數作為參數，閉且返回另一個函數（來替換參數那個函數）。

比如：

def entrance(func):
    def inner():
        print "inside function :", func.__name__
        func()
    return inner

entrance是一個裝飾器，它是一個函數，它可以接收一個函數func作為參數，返回了另一個函數inner。

 

那為什么叫裝飾器了，在返回函數inner()的內部，調用了func()，而且還作了額外的操作，相當於“裝飾”了函數func。

 

那如何使用裝飾器？

def fun1():
    pass
fun1 = entrance(fun1)

def fun2():
    pass
fun2 = entrance(fun2)

fun1，fun2的名字都沒有變，但是通過調用函數裝飾器entrance()，它們已經指向了另一個函數inner()，“裝飾了”自己。

 

@操作符

Python提供的@符號，實質上就是上面做的，對一個函數名進行從新賦值，是語法上的技巧。所以上面的代碼等價於

@entrance
def fun1():
    pass

@entrance
def fun2():
    pass

 

裝飾器的用途？

從這個刻意構造的很簡單的例子，可以看出裝飾器的意義，如果一個函數需要一個功能，如果這個功能可以被使用在很多函數上，或是函數並不是自己實現，那可以寫個裝飾器來實現這些功能。

上面的裝飾器entrance，裝飾一個函數后，函數被調用時會打印出這個函數的名字。

 

但是有一個問題，這個裝飾器從功能上看，是要應該可以用來裝飾任何函數，但是如果我們用它來裝飾了一個帶參數的函數

@entrance
def fun3(x):
    pass

只要不調用fun3，這三行代碼是不會讓Python解釋器報錯的，因為我們已經知道，它等價於:

def fun3(x):
    pass
fun3 = entrance(fun3)

我們定義了一個帶參的函數fun3，然后把fun3指向了另一個函數inner()，當然不會有什么錯。

 

但是，當我們使用fun3時，我們肯定會按照它定義時的樣子去使用它，給它傳入一個參數。

>>>fun3(1)

這里就會出錯了，看看解釋器怎么報錯的

Traceback (most recent call last):
File "decorator.py", line 23, in <module>
fun3(1)
TypeError: inner() takes no arguments (1 given)

當然我們已經很容易知到為什么會這樣報錯了，fun3已經不是指向它定義時那個函數了，它現在指向了"inner()"，而inner是沒有參數的，當然會出錯。

 

那怎么解決呢？

 

修改一下inner()的定義，讓它可以就收任意個參數就可以了   【注：參見Python函數一文】

def entrance(func):
    def inner(*args, **kvargs):
        print "inside function : ", func.__name__
        func(*args, **kvargs)
    return inner

現在，給inner傳任意個參數都不會出錯了，也就是entrance可以被用來裝飾任何一個函數了。

 

 

3，寫個裝飾器logger

一個函數被調用時，在日志里記錄其名稱和被調用的實際參數

def logger(func):
    def inner(*args, **kvargs):
        print  func.__name__, 'called, arguments: ', args, kvargs
        func(*args, **kvargs)
    return inner
        

 

 

 

參考：

1，http://www.cnblogs.com/vamei/archive/2013/02/16/2820212.html   Vamei博客

2，http://simeonfranklin.com/blog/2012/jul/1/python-decorators-in-12-steps/   12步學習Python decorator