20.裝飾器
20.1 函式基礎知識
? ? 在Python中函式為一等公民,我們可以:
- 把函式賦值給變數
- 在函式中定義函式
- 在函式中回傳函式
- 把函式傳遞給函式
20.1.1 把函式賦值給變數
? ? 在Python里,函式是物件,因此可以把它賦值給變數,如下所示:
def hello(name="Surpass"):
return "Hello,"+name.capitalize()
? ? 上述代碼定義了一個函式hello(),具體功能是把對輸入的姓名打招呼,并將姓名首字母轉換為大寫,下面將函式賦值給變數,如下所示:
func=hello
print(func)
其輸出結果如下所示:
<function hello at 0x0000029D25213048>
? ? 在上述代碼中,將hello賦值給func并輸出列印結果,從結果上來看,當不帶括號使用hello時,僅輸出函式物件,而非呼叫函式,當帶上括號時,則表示呼叫函式,如下所示:
func=hello
print(func())
其輸出結果如下所示:
Hello,Surpass
? ? 既然函式是物件,那是不是可以嘗試洗掉物件,來看看以下代碼:
def hello(name="Surpass"):
return "Hello,"+name.capitalize()
func=hello
del hello
try:
print(hello())
except Exception as ex:
print(ex)
print(func())
其輸出結果如下所示:
name 'hello' is not defined
Hello,Surpass
? ? 在上面代碼中,雖然hello函式已經洗掉,但在洗掉之前,已經賦值給變數func,所以不影響func的功能,因此可以得出以下總結:
函式是物件,可以將基賦值給其他變數variable,在呼叫時,需要添加括號variable()
20.1.2 在函式中定義函式
? ? 在Python中,可以在函式中定義函式,示例代碼如下所示:
def hello(name="Surpass"):
def welcome(country="China"):
return "Hello,"+name.capitalize()+",Welcome to "+country
print(welcome())
hello()
其輸出結果如下所示:
Hello,Surpass,Welcome to China
? ? 上述示例中,內部函式welcome表示歡迎來到某個國家,而且這個函式位于hello函式內部,只有通過呼叫hello函式時才能生效,測驗代碼如下所示:
def hello(name="Surpass"):
def welcome(country="China"):
return "Hello,"+name.capitalize()+",Welcome to "+country
print(welcome())
try:
print(welcome())
except Exception as ex:
print(ex)
其輸出結果如下所示:
name 'welcome' is not defined
? ? 通過上面的示例代碼可以得到以下總結:
在函式funcA中可以定義函式funcB,但funcB無法在函式funcA之外進行呼叫
20.1.3 在函式中回傳函式
? ? 通過前面兩個示例,函式即可以回傳其值,也可以回傳其函式物件,示例代碼如下所示:
def hello(type=1):
def name(name="Surpass"):
return "My name is "+name
def welcome(country="China"):
return " Welcome to "+country
def occupation(occupation="engineer"):
return " I am "+occupation
if type==1:
return name
elif type==2:
return welcome
else:
return occupation
? ? 在函式hello中定義了3個函式,然后根據type引數來回傳不同的資訊,在hello函式中,回傳都為函式物件,可視為變數,運行以下代碼:
print(hello(1))
print(hello(1)())
func=hello(1)
print(func())
其輸出結果如下所示:
<function hello.<locals>.name at 0x000001D65783D5E8>
My name is Surpass
My name is Surpass
? ? 注意上面在寫代碼上的區別,如果不加括號,則代表僅回傳函式物件,添加括號則代表呼叫函式,總結如下所示:
在函式funcA中可以定義多個函式funcB...,并且可以把funcB當成物件進行回傳
20.1.4 把函式傳遞給函式
? ? 在Python中,既然一切都為物件,那函式也可以做引數傳遞給另一個函式,示例代碼如下所示:
import datetime
import time
def hello(name="Surpass"):
print(f"Hello,{name}")
def testFunc(func):
print(f"current time is {datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")
hello()
time.sleep(2)
print(f"current time is {datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")
testFunc(hello)
其輸出結果如下所示:
current time is 2020-05-17 14:58:56
Hello,Surpass
current time is 2020-05-17 14:58:58
? ? 在函式testFunc中接收引數為函式型別的函式hello,而且并未改變函式hello的任何內容,且實作在函式hello前后增加一些內容,因此我們可以總結如下所示:
函式funcA傳遞到函式funcB,函式funcB僅在函式funcA運行前后有操作,但不改變funcA,這就是裝飾器的錐形,
20.2 裝飾器
20.2.1 閉包
? ? 維基的解釋如下所示:
在計算機科學中,閉包(Closure),又稱詞法閉包(Lexical Closure)或函式閉包(function closures),是參考了自由變數的函式,這個被參考的自由變數將和這個函式一同存在,即使已經離開了創造它的環境也不例外,所以,有另一種說法認為閉包是由函式和與其相關的參考環境組合而成的物體,閉包在運行時可以有多個實體,不同的參考環境和相同的函陣列合可以產生不同的實體,
? ? Python里面的閉包是一種高階函式,回傳值為函式物件,簡單來講就是一個函式定義中參考了函式外定義的變數,并且該函式可以在其定義環境外執行,這種函式稱之為閉包,詳細如下圖所示:

? ? 在函式make_averager中,series為make_averager函式的區域變數,在averager函式中series稱之為自由變數(未在本地作用域中系結的變數)
示例如下所示:
def outter(name):
def inner():
print(f"para is {name}")
return inner
? ? 內部函式inner()可以使用外部函式outter()的引數name,最后回傳內部函式物件inner,可以按照在函式中回傳函式進行呼叫,現在我們將outter換成decorator,inner換成wrapper,如下所示:
def decorator(name):
def wrapper():
print(f"para is {name}")
return wrapper
? ? 以上這種形式就是裝飾器,回傳值為wrapper物件并等候呼叫,一旦被呼叫就運行 print(f"para is {name}")輸出結果,對于裝飾器而言,嚴格定義來講,引數是函式而不是變數,常用形式如下所示:
def decorator(func):
def wrapper():
return func()
return wrapper
20.2.2 裝飾器初體驗
? ? 我們先來看看一個簡單的示例,代碼如下所示:
def hello():
print("call hello function")
def decorator(func):
def wrapper():
return func()
return wrapper
tmp=decorator(hello)
tmp()
其輸出結果如下所示:
call hello function
? ? 裝飾器的特性就是給原函式做裝飾,但不改變原函式的內容,在以下代碼中,希望在運行原函式func()之前,輸出原函式的名字:
def hello():
print("call hello function")
def decorator(func):
def wrapper():
print(f"before call func name is {func.__name__}")
return func()
return wrapper
tmp=decorator(hello)
tmp()
其輸出結果如下所示:
before call func name is hello
call hello function
? ? 經過前面的不斷學習,相信已經初步掌握了裝飾器的原理,如果每次都這樣呼叫是不是太麻煩了,于是Python提供了一種語法糖@裝飾函式寫在被裝飾函式上面即可,如下所示:
def decorator(func):
def wrapper():
print(f"before call func name is {func.__name__}")
return func()
return wrapper
@decorator
def hello():
print("call hello function")
hello()
其輸出結果如下所示:
before call func name is hello
call hello function
? ? 上面這種寫法等價于
tmp=decorator(hello)
tmp()
語法糖 (syntactic sugar):指計算機語言中添加的某種語法,對語言的功能沒有影響,但是讓程式員更方便地使用,
20.2.3 裝飾器知識點
20.2.3.1 多個裝飾器
? ? 即裝飾器的特性是給函式進行裝飾,那是不是一個函式可以被多個函式進行裝飾,定義一個函式如下所示:
def hello(name="Surpass"):
return f"Hello,{name}"
? ? 針對以上這個函式,我們希望能完成以下功能:
- 字串全部大寫
- 將回傳的字串拆分成單個單詞串列
? ? 為完成以上功能,我們定義兩個裝飾器如下所示:
# 裝飾器一:
def toUpper(func):
def wrapper():
return func().upper()
return wrapper
# 裝飾器二:
def splitStr(func):
def wrapper():
return func().split(",")
return wrapper
@splitStr
@toUpper
def hello(name="Surpass"):
return f"Hello,{name}"
print(hello())
其輸出結果如下所示:
['HELLO', 'SURPASS']
? ? 以下代碼等價于:
print(splitStr(toUpper(hello))())
總結一下:一個函式存在多個裝飾器,順序是按照就近原則,即哪個函式靠近被裝飾函式,則優先進行裝飾,上面示例中@toUpper離被裝飾函式hello最近,優先運行,依次類推,
20.2.3.2 傳遞引數給裝飾函式
? ? 裝飾函式就是wrapper(),因為要呼叫原函式func,一旦它有引數,則需要將這些引數傳遞給wrapper(),示例如下所示:
1.沒有引數的wrapper()
def decorator(func):
def wrapper():
funcName=func.__name__
print(f"Befor call {funcName}")
func()
print(f"After call {funcName}")
return wrapper
@decorator
def testFunc():
print(f"call function is testFunc")
testFunc()
其輸出結果如下所示:
Befor call testFunc
call function is testFunc
After call testFunc
2.傳固定引數個數的wrapper()
? ? 如果被裝飾函式有傳入引數,則在裝飾函式添加引數即可,
def decorator(func):
def wrapper(args1,args2):
funcName=func.__name__
print(f"Befor call {funcName}")
func(args1,args2)
print(f"After call {funcName}")
return wrapper
@decorator
def testFunc(name,age):
print(f"Name is {name},age is {str(age)}")
testFunc("Surpass",28)
其輸出結果如下所示:
Befor call testFunc
Name is Surpass,age is 28
After call testFunc
3.帶回傳值的wrapper()
? ? 如果被裝飾函式有回傳,則在裝飾函式中將被裝飾函式的結果賦給變數回傳即可,
def decorator(func):
def wrapper(args1,args2):
funcName=func.__name__
print(f"Befor call {funcName}")
result=func(args1,args2)
print(f"After call {funcName}")
return result
return wrapper
@decorator
def testFunc(name,age):
return f"Name is {name},age is {str(age)}"
print(testFunc("Surpass",28))
其輸出結果如下所示:
Befor call testFunc
After call testFunc
Name is Surpass,age is 28
4.無固定引數個數的wrapper()
? ? 在學習Python函式時,如果引數較多或無法確定引數個數,可以使用位置引數(*agrs)也可以使用關鍵字引數(**kwargs),示例代碼如下所示:
def decorator(func):
def wrapper(*args,**kwargs):
funcName=func.__name__
print(f"Befor call {funcName}")
result=func(*args,**kwargs)
print(f"After call {funcName}")
return result
return wrapper
@decorator
def testFunc(*args,**kwargs):
sum,dicSum=0,0
for item in args:
sum+=item
for k,v in kwargs.items():
dicSum+=v
return sum,dicSum
print(testFunc(1,2,3,4,5,key1=1,key2=2,key3=5,key4=1000))
其輸出結果如下所示:
Befor call testFunc
After call testFunc
(15, 1008)
20.2.3.3 functools.wrap
? ? 在裝飾器中,裝飾之后的函式名稱會變亂,如一個函式為hello(),其名稱為hello
def hello():
pass
hello.__name__
其最終的函式名為:
'hello'
? ? 而在裝飾器中,在使用@裝飾函式名稱之后,其名稱已經變成wrapper,原因也非常簡單,因為我們最終的呼叫形式都是decorator(被裝飾函式),而這個函式回傳的是wrapper()函式,因此名稱為wrapper,示例代碼如下所示:
def decorator(func):
def wrapper():
return func()
return wrapper
@decorator
def testFunc():
pass
print(testFunc.__name__)
其輸出結果如下所示:
wrapper
? ? 這種情況下,多種情況下應該不需要關注,但如果需要根據函式名來進行一些操作(如反射)則會出錯,如果仍然希望保持函式的原名,可以使用functools.wraps,示例代碼如下所示:
from functools import wraps
def decorator(func):
@wraps(func)
def wrapper():
return func()
return wrapper
@decorator
def testFunc():
pass
print(testFunc.__name__)
其輸出結果如下所示:
testFunc
仔細看上面代碼,是不是裝飾函式又被裝飾了一次?
20.2.3.4 傳遞引數給裝飾器
? ? 除了可以傳遞引數給裝飾函式(wapper),也可以傳遞引數給裝飾函式(decorator),來看看以下示例,在示例中,只有裝飾函式有引數,裝飾器將數值保留2位小數,如下所示:
def digitalFormat(func):
def wrapper(*args,**kwargs):
result=func(*args,**kwargs)
formatResult=round(result,2)
return formatResult
return wrapper
@digitalFormat
def add(a:float,b:float)->float:
return a+b
print(add(12.09,19.12345))
其輸出結果如下所示:
31.21
? ? 通過裝飾器,我們很快就達到要求,但有些情況,單純的數值可能并沒有太大意義,需要結合單位,假設上面示例回傳為重量,則單位可能為g、kg等,那這種需求有沒有解決辦法了?示例代碼如下所示:
def unit(unit:str)->str:
def digitalFormat(func):
def wrapper(*args,**kwargs):
result=func(*args,**kwargs)
formatResult=f"{round(result,2)} {unit}"
return formatResult
return wrapper
return digitalFormat
@unit("kg")
def add(a:float,b:float)->float:
return a+b
print(add(12.09,19.12345))
其輸出結果如下所示:
31.21 kg
如果裝飾飾器本身需要傳遞引數,那么再定義一層函式,將裝飾的引數傳入即可,是不是很簡單,
20.2.3.5 類裝飾器
1.使用類去裝飾函式
? ? 前面實作的裝飾器都是針對函式而言,在實際應用中,類也可以作為裝飾器,在類裝飾器中主要依賴函式__call__(),每呼叫一個類的示例時,函式__call__()就會被執行一次,示例代碼如下所示:
class Count:
def __init__(self,func):
self.func=func
self.callCount=0
def __call__(self, *args, **kwargs):
self.callCount+=1
print(f"call count is {self.callCount}")
return self.func(*args,**kwargs)
@Count
def testSample():
print("Hello, Surpass")
for i in range(3):
print(f"first call {testSample()}")
其輸出結果如下所示:
call count is 1
Hello, Surpass
first call None
call count is 2
Hello, Surpass
first call None
call count is 3
Hello, Surpass
first call None
2.使用函式去裝飾類
def decorator(num):
def wrapper(cls):
cls.callCount=num
return cls
return wrapper
@decorator(10)
class Count:
callCount = 0
def __init__(self):
pass
def __call__(self, *args, **kwargs):
self.callCount+=1
print(f"call count is {self.callCount}")
return self.func(*args,**kwargs)
if __name__ == '__main__':
count=Count()
print(count.callCount)
其輸出結果如下所示:
10
20.4.4 何時使用裝飾器
? ? 這個需要據實際的需求而定,比如需要測驗每個函式運行時間,此時可以使用裝飾器,很輕松就能達到,另外裝飾器也可應用到身價認證、日志記錄和輸入合理性檢查等等,
20.4.5 裝飾器實際案例
? ? 在實際作業中,裝飾器經常會用來記錄日志和時間,示例如下所示:
from functools import wraps
import logging
import time
def logType(logType):
def myLogger(func):
logging.basicConfig(filename=f"{func.__name__}.log",level=logging.INFO)
@wraps(func)
def wrapper(*args,**kwargs):
logging.info(f" {logType} Run with args:{args} and kwargs is {kwargs}")
return func(*args,**kwargs)
return wrapper
return myLogger
def myTimer(func):
@wraps(func)
def wrapper(*args,**kwargs):
startTime=time.time()
result=func(*args,**kwargs)
endTime=time.time()
print(f"{func.__name__} run time is {endTime-startTime} s ")
return result
return wrapper
@logType("Release - ")
@myTimer
def testWrapperA(name:str,color:str)->None:
time.sleep(5)
print(f"{testWrapperA.__name__} input paras is {(name,color)}")
@logType("Test - ")
@myTimer
def testWrapperB(name:str,color:str)->None:
time.sleep(5)
print(f"{testWrapperB.__name__} input paras is {(name,color)}")
if __name__ == '__main__':
testWrapperA("apple","red")
testWrapperB("apple", "red")
其輸出結果如下所示:
testWrapperA input paras is ('apple', 'red')
testWrapperA run time is 5.000441789627075 s
testWrapperB input paras is ('apple', 'red')
testWrapperB run time is 5.000349521636963 s
日志記錄資訊如下所示:

20.4.6 小結
? ? 裝飾器就是接受引數型別為函式或類并回傳函式或類的函式,通過裝飾器函式,在不改變原函式的基礎上添加新的功能,示意圖如下所示:

本文地址:https://www.cnblogs.com/surpassme/p/12906122.html
本文同步在微信訂閱號上發布,如各位小伙伴們喜歡我的文章,也可以關注我的微信訂閱號:woaitest,或掃描下面的二維碼添加關注:

轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/138074.html
標籤:Python
