了解Python中的裝飾器

文章先由stackoverflow上面的一個問題引起吧，如果使用如下的代碼：

列印出如下的輸出：

你會怎麼做？最後給出的答案是：

裝飾器是一個很著名的設計模式，經常被用于有切面需求的場景，較為經典的有插入日志、性能測試、事務處理等。裝飾器是解決這類問題的絕佳設計，有了裝飾器，我們就可以抽離出大量函數中與函數功能本身無關的雷同代碼并繼續重用。概括的講，裝飾器的作用就是為已經存在的對象添加額外的功能。

裝飾器的定義很是抽象，我們來看一個小例子。

這是一個很無聊的函數沒錯。但是突然有一個更無聊的人，我們稱呼他為B君，說我想看看執行這個函數用了多長時間，好吧，那麼我們可以這樣做：

很好，功能看起來無懈可擊。可是蛋疼的B君此刻突然不想看這個函數了，他對另一個叫foo2的函數産生了更濃厚的興趣。

怎麼辦呢？如果把以上新增加的代碼複制到foo2裡，這就犯了大忌了~複制什麼的難道不是最讨厭了麼！而且，如果B君繼續看了其他的函數呢？

還記得嗎，函數在Python中是一等公民，那麼我們可以考慮重新定義一個函數timeit，将foo的引用傳遞給他，然後在timeit中調用foo并進行計時，這樣，我們就達到了不改動foo定義的目的，而且，不論B君看了多少個函數，我們都不用去修改函數定義了！

看起來邏輯上并沒有問題，一切都很美好并且運作正常！……等等，我們似乎修改了調用部分的代碼。原本我們是這樣調用的：foo()，修改以後變成了：timeit(foo)。這樣的話，如果foo在N處都被調用了，你就不得不去修改這N處的代碼。或者更極端的，考慮其中某處調用的代碼無法修改這個情況，比如：這個函數是你交給别人使用的。

既然如此，我們就來想想辦法不修改調用的代碼；如果不修改調用代碼，也就意味着調用foo()需要産生調用timeit(foo)的效果。我們可以想到将timeit指派給foo，但是timeit似乎帶有一個參數……想辦法把參數統一吧！如果timeit(foo)不是直接産生調用效果，而是傳回一個與foo參數清單一緻的函數的話……就很好辦了，将timeit(foo)的傳回值指派給foo，然後，調用foo()的代碼完全不用修改！

這樣，一個簡易的計時器就做好了！我們隻需要在定義foo以後調用foo之前，加上foo = timeit(foo)，就可以達到計時的目的，這也就是裝飾器的概念，看起來像是foo被timeit裝飾了。在在這個例子中，函數進入和退出時需要計時，這被稱為一個橫切面(Aspect)，這種程式設計方式被稱為面向切面的程式設計(Aspect-Oriented Programming)。與傳統程式設計習慣的從上往下執行方式相比較而言，像是在函數執行的流程中橫向地插入了一段邏輯。在特定的業務領域裡，能減少大量重複代碼。面向切面程式設計還有相當多的術語，這裡就不多做介紹，感興趣的話可以去找找相關的資料。

這個例子僅用于示範，并沒有考慮foo帶有參數和有傳回值的情況，完善它的重任就交給你了 ：）

上面這段代碼看起來似乎已經不能再精簡了，Python于是提供了一個文法糖來降低字元輸入量。

重點關注第11行的@timeit，在定義上加上這一行與另外寫foo = timeit(foo)完全等價，千萬不要以為@有另外的魔力。除了字元輸入少了一些，還有一個額外的好處：這樣看上去更有裝飾器的感覺。

-------------------

要了解python的裝飾器，我們首先必須明白在Python中函數也是被視為對象。這一點很重要。先看一個例子：

我們暫且把這個話題放旁邊，我們先看看python另外一個很有意思的屬性：可以在函數中定義函數：

函數引用

從以上兩個例子我們可以得出，函數既然作為一個對象，是以：

1. 其可以被賦給其他變量

2. 其可以被定義在另外一個函數内

這也就是說，函數可以傳回一個函數，看下面的例子：

還有，既然可以傳回一個函數，我們可以把它作為參數傳遞給函數：

這裡你已經足夠能了解裝飾器了，其他它可被視為封裝器。也就是說，它能夠讓你在裝飾前後執行代碼而無須改變函數本身内容。

手工裝飾

那麼如何進行手動裝飾呢？

現在你也許要求當每次調用a_stand_alone_function時，實際調用卻是a_stand_alone_function_decorated。實作也很簡單，可以用my_shiny_new_decorator來給a_stand_alone_function重新指派。

裝飾器揭秘

前面的例子，我們可以使用裝飾器的文法：

當然你也可以累積裝飾：

使用python裝飾器文法：

裝飾器的順序很重要，需要注意：

最後回答前面提到的問題：

内置的裝飾器有三個，分别是staticmethod、classmethod和property，作用分别是把類中定義的執行個體方法變成靜态方法、類方法和類屬性。由于子產品裡可以定義函數，是以靜态方法和類方法的用處并不是太多，除非你想要完全的面向對象程式設計。而屬性也不是不可或缺的，Java沒有屬性也一樣活得很滋潤。從我個人的Python經驗來看，我沒有使用過property，使用staticmethod和classmethod的頻率也非常低。

這裡定義的屬性是一個隻讀屬性，如果需要可寫，則需要再定義一個setter：

functools子產品提供了兩個裝飾器。這個子產品是Python 2.5後新增的，一般來說大家用的應該都高于這個版本。

2.3.1. wraps(wrapped[, assigned][, updated]): 

這是一個很有用的裝飾器。看過前一篇反射的朋友應該知道，函數是有幾個特殊屬性比如函數名，在被裝飾後，上例中的函數名foo會變成包裝函數的名字wrapper，如果你希望使用反射，可能會導緻意外的結果。這個裝飾器可以解決這個問題，它能将裝飾過的函數的特殊屬性保留。

首先注意第5行，如果注釋這一行，foo.__name__将是'wrapper'。另外相信你也注意到了，這個裝飾器竟然帶有一個參數。實際上，他還有另外兩個可選的參數，assigned中的屬性名将使用指派的方式替換，而updated中的屬性名将使用update的方式合并，你可以通過檢視functools的源代碼獲得它們的預設值。對于這個裝飾器，相當于wrapper = functools.wraps(func)(wrapper)。

2.3.2. total_ordering(cls): 

這個裝飾器在特定的場合有一定用處，但是它是在Python 2.7後新增的。它的作用是為實作了至少__lt__、__le__、__gt__、__ge__其中一個的類加上其他的比較方法，這是一個類裝飾器。如果覺得不好了解，不妨仔細看看這個裝飾器的源代碼：

技術改變世界！

--狂詩絕劍