很多寫裝飾器的都是直接甩給你最終的裝飾器代碼,然后給你說(shuō)下大致的原理,比如:
#現(xiàn)在,假設(shè)我們要增強(qiáng)now()函數(shù)的功能漫试,比如浸锨,在函數(shù)調(diào)用前后自動(dòng)打印日志彻秆,但又不希望修改now()函數(shù)的定義柬泽,這種在代碼運(yùn)行期間動(dòng)態(tài)增加功能的方式,稱之為“裝飾器”(Decorator)框喳。
def log(func):
def wrapper(*args, **kw):
print('call %s():' % func.__name__)
return func(*args, **kw)
return wrapper
#觀察上面的log课幕,因?yàn)樗且粋€(gè)decorator,所以接受一個(gè)函數(shù)作為參數(shù)五垮,并返回一個(gè)函數(shù)乍惊。我們要借助Python的@語(yǔ)法,把decorator置于函數(shù)的定義處:
@log
def now():
print('hello world')
#調(diào)用now()函數(shù)拼余,不僅會(huì)運(yùn)行now()函數(shù)本身污桦,還會(huì)在運(yùn)行now()函數(shù)前打印一行日志:
>>> now()
call now():
hello world
然后來(lái)上一句,把@log放到now()函數(shù)的定義處亩歹,相當(dāng)于執(zhí)行了語(yǔ)句:
now = log(now)
對(duì)裝飾器只是大致的解釋了下原理,但是對(duì)于初學(xué)者根本就是懵逼的狀態(tài)
我認(rèn)為任何事都是一個(gè)復(fù)雜的組合體,就跟數(shù)學(xué)一樣,一個(gè)復(fù)雜的題是有很多簡(jiǎn)單的題組成的,化繁為簡(jiǎn)就可以很清晰的理解事情的本質(zhì)
下面讓我們把裝飾器拆分來(lái)看
1.函數(shù)/函數(shù)執(zhí)行
首先區(qū)分函數(shù)和函數(shù)的執(zhí)行
def foo():
print('foo')
foo #表示是函數(shù)
foo() #表示執(zhí)行foo函數(shù)
2.函數(shù)指針
def foo():
print('foo')
foo = lambda x: x + 1
foo()# 執(zhí)行下面的lambda表達(dá)式匙监,而不再是原來(lái)的foo函數(shù),因?yàn)閒oo這個(gè)名字被重新指向了另外一個(gè)匿名函數(shù)
3.最減版裝飾器
def w1(func):
def inner():
func()
return inner
@w1
def f1():
print('f1')
這段代碼不清楚沒(méi)關(guān)系,讓我們轉(zhuǎn)成另外一段,因?yàn)锧w1 等價(jià)于 w1(f1)
def w1(func):
def inner():
func()
return inner
def f1():
print('f1')
f1 = w1(f1)
如果你還是不清楚,那讓我們來(lái)一步步解釋下
執(zhí)行w1函數(shù) 小作,并將 f1 作為w1函數(shù)的參數(shù)亭姥,內(nèi)部就會(huì)回返inner(由1.函數(shù)/函數(shù)執(zhí)行應(yīng)該知道這是函數(shù)),即將w1的返回值再重新賦值給 f1,即:
新f1 = def inner():
想要添加的方法內(nèi)容
原來(lái)f1()
return inner
當(dāng)執(zhí)行f1時(shí),就會(huì)調(diào)用inner函數(shù),先執(zhí)行你想要添加的方法內(nèi)容,然后再執(zhí)行原有的f1方法
再看下最減版的裝飾器了,看看理解了嗎.
4.用裝飾器給方法添加點(diǎn)內(nèi)容
def addStr(fn):
def wrapped():
return '添加的內(nèi)容:' + fn()
return wrapped
@addStr
def test1()
return 'hello world'
print(test1())
運(yùn)行結(jié)果:
添加內(nèi)容:hello world
5.裝飾器(decorator)功能
- 引入日志
- 函數(shù)執(zhí)行時(shí)間統(tǒng)計(jì)
- 執(zhí)行函數(shù)前預(yù)備處理
- 執(zhí)行函數(shù)后清理功能
- 權(quán)限校驗(yàn)等場(chǎng)景
- 緩存
6.裝飾有參數(shù)的函數(shù)
上邊是裝飾無(wú)參數(shù)的函數(shù),下邊讓我們看下裝飾有參數(shù)的函數(shù)
def test(func):
def wrappedfunc(a, b):
print(a, b)
func(a, b)
return wrappedfunc
@test
def foo(a, b):
print(a+b)
foo(1,2)
7.裝飾不定長(zhǎng)參數(shù)的函數(shù)
def test(func):
def wrappedfunc(*args, **kwargs):
print(args, kwargs)
func(*args, **kwargs)
return wrappedfunc
@test
def foo1(a, b):
print(a+b)
@test
def foo2(a, b, c):
print(a+b+c)
foo1(1,2)
foo2(1,2,3)
對(duì)于不定長(zhǎng)參數(shù)的函數(shù)參數(shù)可以通過(guò)(args, kwargs)來(lái)修飾,args代表tuple(元組),kwargs代表dict(字典),這樣裝飾器就可以修飾不同參數(shù)長(zhǎng)度的函數(shù)
8.裝飾帶有return的函數(shù)
def test(func):
def wrappedfunc():
return func()
return wrappedfunc
@test
def foo1():
return 'haha'
@test
def foo2():
print('----foo2----')
foo2()
print(foo1())
運(yùn)行可以知道兩個(gè)函數(shù)都可以正常運(yùn)行,因?yàn)閒oo2沒(méi)有return的,在wrappedfunc中return的是None,不會(huì)影響函數(shù)的正常執(zhí)行,而foo1中有return的也可以通過(guò)wrappedfunc中的return返回回來(lái).
9.通用裝飾器
這里就回到了開(kāi)頭大家普遍看到的通用裝飾器
def log(func):
def wrapper(*args, **kw):
print('call %s():' % func.__name__)
return func(*args, **kw)
return wrapper
@log
def now():
print('hello world')
這時(shí)候看這個(gè)裝飾器,是不是感覺(jué)明白多了func.name就是打印函數(shù)名的一個(gè)方法
10.裝飾器帶參數(shù),在原有裝飾器的基礎(chǔ)上,設(shè)置外部變量
def test(pre="hello"):
def testfun(func):
def wrappedfunc():
print(pre)
return func()
return wrappedfunc
return testfun
@test("python")
def foo():
print("I am foo")
可以理解為:foo()=test("python")(foo)()
11.類裝飾器
裝飾器函數(shù)其實(shí)是這樣一個(gè)接口約束顾稀,它必須接受一個(gè)callable對(duì)象作為參數(shù)达罗,然后返回一個(gè)callable對(duì)象。在Python中一般callable對(duì)象都是函數(shù)静秆,但也有例外粮揉。只要某個(gè)對(duì)象重寫了 call() 方法,那么這個(gè)對(duì)象就是callable的抚笔。
class Test(object):
def __init__(self, func):
print("---初始化---")
print("func name is %s"%func.__name__)
self.__func = func
def __call__(self):
print("---裝飾器中的功能---")
self.__func()
#說(shuō)明:
#1. 當(dāng)用Test來(lái)裝作裝飾器對(duì)test函數(shù)進(jìn)行裝飾的時(shí)候扶认,首先會(huì)創(chuàng)建Test的實(shí)例對(duì)象
# 并且會(huì)把test這個(gè)函數(shù)名當(dāng)做參數(shù)傳遞到__init__方法中
# 即在__init__方法中的func變量指向了test函數(shù)體
#
#2. test函數(shù)相當(dāng)于指向了用Test創(chuàng)建出來(lái)的實(shí)例對(duì)象
#
#3. 當(dāng)在使用test()進(jìn)行調(diào)用時(shí),就相當(dāng)于讓這個(gè)對(duì)象()殊橙,因此會(huì)調(diào)用這個(gè)對(duì)象的__call__方法
#
#4. 為了能夠在__call__方法中調(diào)用原來(lái)test指向的函數(shù)體辐宾,所以在__init__方法中就需要一個(gè)實(shí)例屬性來(lái)保存這個(gè)函數(shù)體的引用
# 所以才有了self.__func = func這句代碼狱从,從而在調(diào)用__call__方法中能夠調(diào)用到test之前的函數(shù)體
@Test
def test():
print("----test---")
test()
showpy()#如果把這句話注釋,重新運(yùn)行程序叠纹,依然會(huì)看到"--初始化--"
運(yùn)行結(jié)果如下
---初始化---
func name is test
---裝飾器中的功能---
----test---