很多寫裝飾器的都是直接甩給你最終的裝飾器代碼,然后給你說下大致的原理,比如:
#現在,假設我們要增強now()函數的功能,比如,在函數調用前后自動打印日志,但又不希望修改now()函數的定義,這種在代碼運行期間動態增加功能的方式,稱之為“裝飾器”(Decorator)。
def log(func):
def wrapper(*args, **kw):
print('call %s():' % func.__name__)
return func(*args, **kw)
return wrapper
#觀察上面的log,因為它是一個decorator,所以接受一個函數作為參數,并返回一個函數。我們要借助Python的@語法,把decorator置于函數的定義處:
@log
def now():
print('hello world')
#調用now()函數,不僅會運行now()函數本身,還會在運行now()函數前打印一行日志:
>>> now()
call now():
hello world
然后來上一句,把@log放到now()函數的定義處,相當于執行了語句:
now = log(now)
對裝飾器只是大致的解釋了下原理,但是對于初學者根本就是懵逼的狀態
我認為任何事都是一個復雜的組合體,就跟數學一樣,一個復雜的題是有很多簡單的題組成的,化繁為簡就可以很清晰的理解事情的本質
下面讓我們把裝飾器拆分來看
1.函數/函數執行
首先區分函數和函數的執行
def foo():
print('foo')
foo #表示是函數
foo() #表示執行foo函數
2.函數指針
def foo():
print('foo')
foo = lambda x: x + 1
foo()# 執行下面的lambda表達式,而不再是原來的foo函數,因為foo這個名字被重新指向了另外一個匿名函數
3.最減版裝飾器
def w1(func):
def inner():
func()
return inner
@w1
def f1():
print('f1')
這段代碼不清楚沒關系,讓我們轉成另外一段,因為@w1 等價于 w1(f1)
def w1(func):
def inner():
func()
return inner
def f1():
print('f1')
f1 = w1(f1)
如果你還是不清楚,那讓我們來一步步解釋下
執行w1函數 ,并將 f1 作為w1函數的參數,內部就會回返inner(由1.函數/函數執行應該知道這是函數),即將w1的返回值再重新賦值給 f1,即:
新f1 = def inner():
想要添加的方法內容
原來f1()
return inner
當執行f1時,就會調用inner函數,先執行你想要添加的方法內容,然后再執行原有的f1方法
再看下最減版的裝飾器了,看看理解了嗎.
4.用裝飾器給方法添加點內容
def addStr(fn):
def wrapped():
return '添加的內容:' + fn()
return wrapped
@addStr
def test1()
return 'hello world'
print(test1())
運行結果:
添加內容:hello world
5.裝飾器(decorator)功能
- 引入日志
- 函數執行時間統計
- 執行函數前預備處理
- 執行函數后清理功能
- 權限校驗等場景
- 緩存
6.裝飾有參數的函數
上邊是裝飾無參數的函數,下邊讓我們看下裝飾有參數的函數
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.裝飾不定長參數的函數
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)
對于不定長參數的函數參數可以通過(args, kwargs)來修飾,args代表tuple(元組),kwargs代表dict(字典),這樣裝飾器就可以修飾不同參數長度的函數
8.裝飾帶有return的函數
def test(func):
def wrappedfunc():
return func()
return wrappedfunc
@test
def foo1():
return 'haha'
@test
def foo2():
print('----foo2----')
foo2()
print(foo1())
運行可以知道兩個函數都可以正常運行,因為foo2沒有return的,在wrappedfunc中return的是None,不會影響函數的正常執行,而foo1中有return的也可以通過wrappedfunc中的return返回回來.
9.通用裝飾器
這里就回到了開頭大家普遍看到的通用裝飾器
def log(func):
def wrapper(*args, **kw):
print('call %s():' % func.__name__)
return func(*args, **kw)
return wrapper
@log
def now():
print('hello world')
這時候看這個裝飾器,是不是感覺明白多了func.name就是打印函數名的一個方法
10.裝飾器帶參數,在原有裝飾器的基礎上,設置外部變量
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.類裝飾器
裝飾器函數其實是這樣一個接口約束,它必須接受一個callable對象作為參數,然后返回一個callable對象。在Python中一般callable對象都是函數,但也有例外。只要某個對象重寫了 call() 方法,那么這個對象就是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()
#說明:
#1. 當用Test來裝作裝飾器對test函數進行裝飾的時候,首先會創建Test的實例對象
# 并且會把test這個函數名當做參數傳遞到__init__方法中
# 即在__init__方法中的func變量指向了test函數體
#
#2. test函數相當于指向了用Test創建出來的實例對象
#
#3. 當在使用test()進行調用時,就相當于讓這個對象(),因此會調用這個對象的__call__方法
#
#4. 為了能夠在__call__方法中調用原來test指向的函數體,所以在__init__方法中就需要一個實例屬性來保存這個函數體的引用
# 所以才有了self.__func = func這句代碼,從而在調用__call__方法中能夠調用到test之前的函數體
@Test
def test():
print("----test---")
test()
showpy()#如果把這句話注釋,重新運行程序,依然會看到"--初始化--"
運行結果如下
---初始化---
func name is test
---裝飾器中的功能---
----test---