Python的裝飾器模式與面向切面編程詳解
今天來(lái)討論一下裝飾器。裝飾器是一個(gè)很著名的設(shè)計(jì)模式,經(jīng)常被用于有切面需求的場(chǎng)景,較為經(jīng)典的有插入日志、性能測(cè)試、事務(wù)處理等。裝飾器是解決這類(lèi)問(wèn)題的絕佳設(shè)計(jì),有了裝飾器,我們就可以抽離出大量函數(shù)中與函數(shù)功能本身無(wú)關(guān)的雷同代碼并繼續(xù)重用。概括的講,裝飾器的作用就是為已經(jīng)存在的對(duì)象添加額外的功能。
1. 裝飾器入門(mén)
1.1. 需求是怎么來(lái)的?
裝飾器的定義很是抽象,我們來(lái)看一個(gè)小例子。
def foo():
print 'in foo()'
foo()
這是一個(gè)很無(wú)聊的函數(shù)沒(méi)錯(cuò)。但是突然有一個(gè)更無(wú)聊的人,我們稱(chēng)呼他為B君,說(shuō)我想看看執(zhí)行這個(gè)函數(shù)用了多長(zhǎng)時(shí)間,好吧,那么我們可以這樣做:
import time
def foo():
start = time.clock()
print 'in foo()'
end = time.clock()
print 'used:', end - start
foo()
很好,功能看起來(lái)無(wú)懈可擊??墒堑疤鄣腂君此刻突然不想看這個(gè)函數(shù)了,他對(duì)另一個(gè)叫foo2的函數(shù)產(chǎn)生了更濃厚的興趣。
怎么辦呢?如果把以上新增加的代碼復(fù)制到foo2里,這就犯了大忌了~復(fù)制什么的難道不是最討厭了么!而且,如果B君繼續(xù)看了其他的函數(shù)呢?
1.2. 以不變應(yīng)萬(wàn)變,是變也
還記得嗎,函數(shù)在Python中是一等公民,那么我們可以考慮重新定義一個(gè)函數(shù)timeit,將foo的引用傳遞給他,然后在timeit中調(diào)用foo并進(jìn)行計(jì)時(shí),這樣,我們就達(dá)到了不改動(dòng)foo定義的目的,而且,不論B君看了多少個(gè)函數(shù),我們都不用去修改函數(shù)定義了!
import time
def foo():
print 'in foo()'
def timeit(func):
start = time.clock()
func()
end =time.clock()
print 'used:', end - start
timeit(foo)
看起來(lái)邏輯上并沒(méi)有問(wèn)題,一切都很美好并且運(yùn)作正常!……等等,我們似乎修改了調(diào)用部分的代碼。原本我們是這樣調(diào)用的:foo(),修改以后變成了:timeit(foo)。這樣的話(huà),如果foo在N處都被調(diào)用了,你就不得不去修改這N處的代碼。或者更極端的,考慮其中某處調(diào)用的代碼無(wú)法修改這個(gè)情況,比如:這個(gè)函數(shù)是你交給別人使用的。
1.3. 最大限度地少改動(dòng)!
既然如此,我們就來(lái)想想辦法不修改調(diào)用的代碼;如果不修改調(diào)用代碼,也就意味著調(diào)用foo()需要產(chǎn)生調(diào)用timeit(foo)的效果。我們可以想到將timeit賦值給foo,但是timeit似乎帶有一個(gè)參數(shù)……想辦法把參數(shù)統(tǒng)一吧!如果timeit(foo)不是直接產(chǎn)生調(diào)用效果,而是返回一個(gè)與foo參數(shù)列表一致的函數(shù)的話(huà)……就很好辦了,將timeit(foo)的返回值賦值給foo,然后,調(diào)用foo()的代碼完全不用修改!
#-*- coding: UTF-8 -*-
import time
def foo():
print 'in foo()'
# 定義一個(gè)計(jì)時(shí)器,傳入一個(gè),并返回另一個(gè)附加了計(jì)時(shí)功能的方法
def timeit(func):
# 定義一個(gè)內(nèi)嵌的包裝函數(shù),給傳入的函數(shù)加上計(jì)時(shí)功能的包裝
def wrapper():
start = time.clock()
func()
end =time.clock()
print 'used:', end - start
# 將包裝后的函數(shù)返回
return wrapper
foo = timeit(foo)
foo()
這樣,一個(gè)簡(jiǎn)易的計(jì)時(shí)器就做好了!我們只需要在定義foo以后調(diào)用foo之前,加上foo = timeit(foo),就可以達(dá)到計(jì)時(shí)的目的,這也就是裝飾器的概念,看起來(lái)像是foo被timeit裝飾了。在在這個(gè)例子中,函數(shù)進(jìn)入和退出時(shí)需要計(jì)時(shí),這被稱(chēng)為一個(gè)橫切面(Aspect),這種編程方式被稱(chēng)為面向切面的編程(Aspect-Oriented Programming)。與傳統(tǒng)編程習(xí)慣的從上往下執(zhí)行方式相比較而言,像是在函數(shù)執(zhí)行的流程中橫向地插入了一段邏輯。在特定的業(yè)務(wù)領(lǐng)域里,能減少大量重復(fù)代碼。面向切面編程還有相當(dāng)多的術(shù)語(yǔ),這里就不多做介紹,感興趣的話(huà)可以去找找相關(guān)的資料。
這個(gè)例子僅用于演示,并沒(méi)有考慮foo帶有參數(shù)和有返回值的情況,完善它的重任就交給你了 :)
2. Python的額外支持
2.1. 語(yǔ)法糖
上面這段代碼看起來(lái)似乎已經(jīng)不能再精簡(jiǎn)了,Python于是提供了一個(gè)語(yǔ)法糖來(lái)降低字符輸入量。
import time
def timeit(func):
def wrapper():
start = time.clock()
func()
end =time.clock()
print 'used:', end - start
return wrapper
@timeit
def foo():
print 'in foo()'
foo()
重點(diǎn)關(guān)注第11行的@timeit,在定義上加上這一行與另外寫(xiě)foo = timeit(foo)完全等價(jià),千萬(wàn)不要以為@有另外的魔力。除了字符輸入少了一些,還有一個(gè)額外的好處:這樣看上去更有裝飾器的感覺(jué)。
2.2. 內(nèi)置的裝飾器
內(nèi)置的裝飾器有三個(gè),分別是staticmethod、classmethod和property,作用分別是把類(lèi)中定義的實(shí)例方法變成靜態(tài)方法、類(lèi)方法和類(lèi)屬性。由于模塊里可以定義函數(shù),所以靜態(tài)方法和類(lèi)方法的用處并不是太多,除非你想要完全的面向?qū)ο缶幊?。而屬性也不是不可或缺的,Java沒(méi)有屬性也一樣活得很滋潤(rùn)。從我個(gè)人的Python經(jīng)驗(yàn)來(lái)看,我沒(méi)有使用過(guò)property,使用staticmethod和classmethod的頻率也非常低。
class Rabbit(object):
def __init__(self, name):
self._name = name
@staticmethod
def newRabbit(name):
return Rabbit(name)
@classmethod
def newRabbit2(cls):
return Rabbit('')
@property
def name(self):
return self._name
這里定義的屬性是一個(gè)只讀屬性,如果需要可寫(xiě),則需要再定義一個(gè)setter:
@name.setter
def name(self, name):
self._name = name
2.3. functools模塊
functools模塊提供了兩個(gè)裝飾器。這個(gè)模塊是Python 2.5后新增的,一般來(lái)說(shuō)大家用的應(yīng)該都高于這個(gè)版本。但我平時(shí)的工作環(huán)境是2.4 T-T
2.3.1. wraps(wrapped[, assigned][, updated]):
這是一個(gè)很有用的裝飾器??催^(guò)前一篇反射的朋友應(yīng)該知道,函數(shù)是有幾個(gè)特殊屬性比如函數(shù)名,在被裝飾后,上例中的函數(shù)名foo會(huì)變成包裝函數(shù)的名字wrapper,如果你希望使用反射,可能會(huì)導(dǎo)致意外的結(jié)果。這個(gè)裝飾器可以解決這個(gè)問(wèn)題,它能將裝飾過(guò)的函數(shù)的特殊屬性保留。
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'。另外相信你也注意到了,這個(gè)裝飾器竟然帶有一個(gè)參數(shù)。實(shí)際上,他還有另外兩個(gè)可選的參數(shù),assigned中的屬性名將使用賦值的方式替換,而updated中的屬性名將使用update的方式合并,你可以通過(guò)查看functools的源代碼獲得它們的默認(rèn)值。對(duì)于這個(gè)裝飾器,相當(dāng)于wrapper = functools.wraps(func)(wrapper)。
2.3.2. total_ordering(cls):
這個(gè)裝飾器在特定的場(chǎng)合有一定用處,但是它是在Python 2.7后新增的。它的作用是為實(shí)現(xiàn)了至少__lt__、__le__、__gt__、__ge__其中一個(gè)的類(lèi)加上其他的比較方法,這是一個(gè)類(lèi)裝飾器。如果覺(jué)得不好理解,不妨仔細(xì)看看這個(gè)裝飾器的源代碼:
def total_ordering(cls):
"""Class decorator that fills in missing ordering methods"""
convert = {
'__lt__': [('__gt__', lambda self, other: other < self),
('__le__', lambda self, other: not other < self),
('__ge__', lambda self, other: not self < other)],
'__le__': [('__ge__', lambda self, other: other <= self),
('__lt__', lambda self, other: not other <= self),
('__gt__', lambda self, other: not self <= other)],
'__gt__': [('__lt__', lambda self, other: other > self),
('__ge__', lambda self, other: not other > self),
('__le__', lambda self, other: not self > other)],
'__ge__': [('__le__', lambda self, other: other >= self),
('__gt__', lambda self, other: not other >= self),
('__lt__', lambda self, other: not self >= other)]
}
roots = set(dir(cls)) & set(convert)
if not roots:
raise ValueError('must define at least one ordering operation: < > <= >=')
root = max(roots) # prefer __lt__ to __le__ to __gt__ to __ge__
for opname, opfunc in convert[root]:
if opname not in roots:
opfunc.__name__ = opname
opfunc.__doc__ = getattr(int, opname).__doc__
setattr(cls, opname, opfunc)
return cls
本文到這里就全部結(jié)束了,有空的話(huà)我會(huì)整理一個(gè)用于檢查參數(shù)類(lèi)型的裝飾器的源代碼放上來(lái),算是一個(gè)應(yīng)用吧 :)
相關(guān)文章
使用python測(cè)試prometheus的實(shí)現(xiàn)
本文主要介紹了使用python測(cè)試prometheus的實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-02-02Pytorch之ToPILImage()不輸出圖片問(wèn)題及解決
這篇文章主要介紹了Pytorch之ToPILImage()不輸出圖片問(wèn)題及解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-02-02梳理總結(jié)Python開(kāi)發(fā)中需要摒棄的18個(gè)壞習(xí)慣
大家好,今天給大家分享 18 個(gè) Python 初學(xué)者常有的壞習(xí)慣,這些壞習(xí)慣不僅影響 Python 代碼的可讀性,而且 影響 Python 的運(yùn)行性能,摒棄這些壞習(xí)慣并以 Pythonic 的方式編寫(xiě)代碼,提高的不僅僅是你的代碼質(zhì)量,也給閱讀代碼的人留下好印象2022-01-01python讀取并顯示圖片的三種方法(opencv、matplotlib、PIL庫(kù))
這篇文章主要給大家介紹了關(guān)于python讀取并顯示圖片的三種方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04Python爬蟲(chóng)之pandas基本安裝與使用方法示例
這篇文章主要介紹了Python爬蟲(chóng)之pandas基本安裝與使用方法,結(jié)合實(shí)例形式分析了Python爬蟲(chóng)操作中pandas的pip命令安裝與HTML、Excel等格式文件保存相關(guān)操作技巧,需要的朋友可以參考下2018-08-08Python實(shí)現(xiàn)查找最小的k個(gè)數(shù)示例【兩種解法】
這篇文章主要介紹了Python實(shí)現(xiàn)查找最小的k個(gè)數(shù),結(jié)合實(shí)例形式對(duì)比分析了Python常見(jiàn)的兩種列表排序、查找相關(guān)操作技巧,需要的朋友可以參考下2019-01-01python爬蟲(chóng)開(kāi)發(fā)之使用Python爬蟲(chóng)庫(kù)requests多線(xiàn)程抓取貓眼電影TOP100實(shí)例
這篇文章主要介紹了python爬蟲(chóng)開(kāi)發(fā)之使用Python爬蟲(chóng)庫(kù)requests多線(xiàn)程抓取貓眼電影TOP100實(shí)例,需要的朋友可以參考下2020-03-03Ubuntu中安裝指定Python版本方法詳解(理論上各版本通用)
現(xiàn)在基于linux的發(fā)行版本有很多,有centos,ubuntu等,一般基于linux的衍生系統(tǒng)至少都安裝了Python2版本,但是現(xiàn)在Python已經(jīng)是3.x版本大行其道了,這篇文章主要給大家介紹了關(guān)于Ubuntu中安裝指定Python版本方法的相關(guān)資料,理論上各版本通用,需要的朋友可以參考下2023-06-06