1. 裝飾器入門

1.1. 需求是怎么來的？

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

?

1 2 3 4

def foo(): ????print 'in foo()' ?? foo()

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

?

1 2 3 4 5 6 7 8

import time def foo(): ????start = time.clock() ????print 'in foo()' ????end = time.clock() ????print 'used:', end - start ?? foo()

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

怎么辦呢？如果把以上新增加的代碼復(fù)制到foo2里，這就犯了大忌了~復(fù)制什么的難道不是最討厭了么！而且，如果B君繼續(xù)看了其他的函數(shù)呢？

1.2. 以不變應(yīng)萬變，是變也

還記得嗎，函數(shù)在Python中是一等公民，那么我們可以考慮重新定義一個函數(shù)timeit，將foo的引用傳遞給他，然后在timeit中調(diào)用foo并進(jìn)行計時，這樣，我們就達(dá)到了不改動foo定義的目的，而且，不論B君看了多少個函數(shù)，我們都不用去修改函數(shù)定義了！

?

1 2 3 4 5 6 7 8 9 10 11 12

import time ?? def foo(): ????print 'in foo()' ?? def timeit(func): //當(dāng)函數(shù)作為參數(shù)傳給另外一個函數(shù)時,可考慮使用裝飾器 ????start = time.clock() ????func() ????end =time.clock() ????print 'used:', end - start ?? timeit(foo)

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

1.3. 最大限度地少改動！

既然如此，我們就來想想辦法不修改調(diào)用的代碼；如果不修改調(diào)用代碼，也就意味著調(diào)用foo()需要產(chǎn)生調(diào)用timeit(foo)的效果。我們可以想到將timeit賦值給foo，但是timeit似乎帶有一個參數(shù)……想辦法把參數(shù)統(tǒng)一吧！如果timeit(foo)不是直接產(chǎn)生調(diào)用效果，而是返回一個與foo參數(shù)列表一致的函數(shù)的話……就很好辦了，將timeit(foo)的返回值賦值給foo，然后，調(diào)用foo()的代碼完全不用修改！

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

#-*- coding: UTF-8 -*- import time ?? def foo(): ????print 'in foo()' ?? # 定義一個計時器，傳入一個，并返回另一個附加了計時功能的方法 def timeit(func): ?????? ????# 定義一個內(nèi)嵌的包裝函數(shù)，給傳入的函數(shù)加上計時功能的包裝 ????def wrapper(): ????????start = time.clock() ????????func() ????????end =time.clock() ????????print 'used:', end - start ?????? ????# 將包裝后的函數(shù)返回,返回wrapper函數(shù)的地址 ????return wrapper ?? foo = timeit(foo) foo()

這樣，一個簡易的計時器就做好了！我們只需要在定義foo以后調(diào)用foo之前，加上foo = timeit(foo)，就可以達(dá)到計時的目的，這也就是裝飾器的概念，看起來像是foo被timeit裝飾了。在在這個例子中，函數(shù)進(jìn)入和退出時需要計時，這被稱為一個橫切面(Aspect)，這種編程方式被稱為面向切面的編程(Aspect-Oriented Programming)。與傳統(tǒng)編程習(xí)慣的從上往下執(zhí)行方式相比較而言，像是在函數(shù)執(zhí)行的流程中橫向地插入了一段邏輯。在特定的業(yè)務(wù)領(lǐng)域里，能減少大量重復(fù)代碼。面向切面編程還有相當(dāng)多的術(shù)語，這里就不多做介紹，感興趣的話可以去找找相關(guān)的資料。

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

2. Python的額外支持

2.1. 語法糖

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

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

import time ?? def timeit(func): ????def wrapper(): ????????start = time.clock() ????????func() ????????end =time.clock() ????????print 'used:', end - start ????return wrapper ?? @timeit? ( @timeit相當(dāng)于 foo=timeit(foo) ) def foo(): ????print 'in foo()' ?? foo()

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

2.2. 內(nèi)置的裝飾器

內(nèi)置的裝飾器有三個，分別是staticmethod、classmethod和property，作用分別是把類中定義的實例方法變成靜態(tài)方法、類方法和類屬性。由于模塊里可以定義函數(shù)，所以靜態(tài)方法和類方法的用處并不是太多，除非你想要完全的面向?qū)ο缶幊獭６鴮傩砸膊皇遣豢苫蛉钡?#xff0c;Java沒有屬性也一樣活得很滋潤。從我個人的Python經(jīng)驗來看，我沒有使用過property，使用staticmethod和classmethod的頻率也非常低。

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

class Rabbit(object): ?????? ????def __init__(self, name): ????????self._name = name ?????? ????@staticmethod //靜態(tài)方法 ????def newRabbit(name): ????????return Rabbit(name) ?????? ????@classmethod? //類方法 ????def newRabbit2(cls): ????????return Rabbit('') ?????? ????@property???? //類屬性 ????def name(self): ????????return self._name

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

?

1 2 3

@name.setter def name(self, name): ????self._name = name

2.3. functools模塊

functools模塊提供了兩個裝飾器。這個模塊是Python 2.5后新增的，一般來說大家用的應(yīng)該都高于這個版本。但我平時的工作環(huán)境是2.4 T-T

2.3.1. wraps(wrapped[, assigned][, updated]):
這是一個很有用的裝飾器。看過前一篇反射的朋友應(yīng)該知道，函數(shù)是有幾個特殊屬性比如函數(shù)名，在被裝飾后，上例中的函數(shù)名foo會變成包裝函數(shù)的名字wrapper，如果你希望使用反射，可能會導(dǎo)致意外的結(jié)果。這個裝飾器可以解決這個問題，它能將裝飾過的函數(shù)的特殊屬性保留。

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

import time import functools ?? def timeit(func): ????@functools.wraps(func) ????def wrapper(): ????????start = time.clock() ????????func() ????????end =time.clock() ????????print 'used:', end - start ????return wrapper ?? @timeit def foo(): ????print 'in foo()' ?? foo() print foo.__name__

首先注意第5行，如果注釋這一行，foo.__name__將是'wrapper'。另外相信你也注意到了，這個裝飾器竟然帶有一個參數(shù)。實際上，他還有另外兩個可選的參數(shù)，assigned中的屬性名將使用賦值的方式替換，而updated中的屬性名將使用update的方式合并，你可以通過查看functools的源代碼獲得它們的默認(rèn)值。對于這個裝飾器，相當(dāng)于wrapper = functools.wraps(func)(wrapper)。

2.3.2. total_ordering(cls):
這個裝飾器在特定的場合有一定用處，但是它是在Python 2.7后新增的。它的作用是為實現(xiàn)了至少__lt__、__le__、__gt__、__ge__其中一個的類加上其他的比較方法，這是一個類裝飾器。如果覺得不好理解，不妨仔細(xì)看看這個裝飾器的源代碼：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

53? def total_ordering(cls): 54????? """Class decorator that fills in missing ordering methods""" 55????? convert = { 56????????? '__lt__': [('__gt__', lambda self, other: other < self), 57???????????????????? ('__le__', lambda self, other: not other < self), 58???????????????????? ('__ge__', lambda self, other: not self < other)], 59????????? '__le__': [('__ge__', lambda self, other: other <= self), 60???????????????????? ('__lt__', lambda self, other: not other <= self), 61???????????????????? ('__gt__', lambda self, other: not self <= other)], 62????????? '__gt__': [('__lt__', lambda self, other: other > self), 63???????????????????? ('__ge__', lambda self, other: not other > self), 64???????????????????? ('__le__', lambda self, other: not self > other)], 65????????? '__ge__': [('__le__', lambda self, other: other >= self), 66???????????????????? ('__gt__', lambda self, other: not other >= self), 67???????????????????? ('__lt__', lambda self, other: not self >= other)] 68????? } 69????? roots = set(dir(cls)) & set(convert) 70????? if not roots: 71????????? raise ValueError('must define at least one ordering operation: < > <= >=') 72????? root = max(roots)?????? # prefer __lt__ to __le__ to __gt__ to __ge__ 73????? for opname, opfunc in convert[root]: 74????????? if opname not in roots: 75????????????? opfunc.__name__ = opname 76????????????? opfunc.__doc__ = getattr(int, opname).__doc__ 77????????????? setattr(cls, opname, opfunc) 78????? return cls

轉(zhuǎn)載于:https://www.cnblogs.com/zhangjing0502/archive/2012/05/17/2505828.html

總結(jié)

以上是生活随笔為你收集整理的python 装饰器入门的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。