裝飾器是Python中非常重要的一個概念，如果你會Python的基本語法，你可以寫出能夠跑通的代碼，但是如果你想寫出高效、簡潔的代碼，我認為離不開這些高級用法，當然也包括本文要講解的裝飾器，就如同前面提到的代碼除錯神器PySnooper一樣，它就是主要通過裝飾器呼叫的方式對Python代碼進行除錯，
1.什么是Python裝飾器？
顧名思義，從字面意思就可以理解，它是用來"裝飾"Python的工具，使得代碼更具有Python簡潔的風格，換句話說，它是一種函式的函式，因為裝飾器傳入的引數就是一個函式，然后通過實作各種功能來對這個函式的功能進行增強，
2.為什么用裝飾器？
前面提到了，裝飾器是通過某種方式來增強函式的功能，當然，我們可以通過很多方式來增強函式的功能，只是裝飾器有一個無法替代的優勢--簡潔，
你只需要在每個函式上方加一個@就可以對這個函式進行增強，
3.在哪里用裝飾器？
裝飾器最大的優勢是用于解決重復性的操作，其主要使用的場景有如下幾個：
- 計算函式運行時間
- 給函式打日志
- 型別檢查
當然，如果遇到其他重復操作的場景也可以類比使用裝飾器，
4.簡單示例
前面都是文字描述，不管說的怎么天花爛墜，可能都無法體會到它的價值，下面就以一個簡單的例子來看一下它的作用，
如果你要對多個函式進行統計運行時間，不使用裝飾器會是這樣的，
from time import time, sleep
def fun_one():
start = time()
sleep(1)
end = time()
cost_time = end - start
print("func one run time {}".format(cost_time))
def fun_two():
start = time()
sleep(1)
end = time()
cost_time = end - start
print("func two run time {}".format(cost_time))
def fun_three():
start = time()
sleep(1)
end = time()
cost_time = end - start
print("func three run time {}".format(cost_time))
在每個函式里都需要獲取開始時間start、結束時間end、計算耗費時間cost_time、加上一個輸出陳述句，
使用裝飾器的方法是這樣的，
def run_time(func):
def wrapper():
start = time()
func() # 函式在這里運行
end = time()
cost_time = end - start
print("func three run time {}".format(cost_time))
return wrapper
@run_time
def fun_one():
sleep(1)
@run_time
def fun_two():
sleep(1)
@run_time
def fun_three():
sleep(1)
通過撰寫一個統計時間的裝飾器run_time，函式的作為裝飾器的引數，然后回傳一個統計時間的函式wrapper，這就是裝飾器的寫法，用專業屬于來說這叫閉包，簡單來說就是函式內嵌套函式，然后再每個函式上面加上@run_time來呼叫這個裝飾器對不同的函式進行統計時間，
可見，統計時間這4行代碼是重復的，一個函式需要4行，如果100個函式就需要400行，而使用裝飾器，只需要幾行代碼實作一個裝飾器，然后每個函式前面加一句命令即可，如果是100個函式，能少300行左右的代碼量，
5.帶引數的裝飾器
通過前面簡單的例子應該已經明白裝飾器的價值和它的簡單用法：通過閉包來實作裝飾器，函式作為外層函式的傳入引數，然后在內層函式中運行、附加功能，隨后把內層函式作為結果回傳，
除了上述簡單的用法還有一些更高級的用法，比如用裝飾器進行型別檢查、添加帶引數的的裝飾器等，它們的用法大同小異，關于高級用法，這里以帶引數的裝飾器為例進行介紹，
不要把問題想的太復雜，帶引數的裝飾器其實就是在上述基本的裝飾器的基礎上在外面套一層接收引數的函式，下面通過一個例子說明一下，
以上述例子為基礎，前面的簡單示例輸出的資訊是，
func three run time 1.0003271102905273
func three run time 1.0006263256072998
func three run time 1.000312328338623
現在我認為這樣的資訊太單薄，需要它攜帶更多的資訊，例如函式名稱、日志等級等，這時候可以把函式名稱和日志等級作為裝飾器的引數，下面來時實作以下，
def logger(msg=None):
def run_time(func):
def wrapper(*args, **kwargs):
start = time()
func() # 函式在這里運行
end = time()
cost_time = end - start
print("[{}] func three run time {}".format(msg, cost_time))
return wrapper
return run_time
@logger(msg="One")
def fun_one():
sleep(1)
@logger(msg="Two")
def fun_two():
sleep(1)
@logger(msg="Three")
def fun_three():
sleep(1)
fun_one()
fun_two()
fun_three()
可以看出，我在示例基本用法里撰寫的裝飾器外層又嵌套了一層函式用來接收引數msg，這樣的話在每個函式(func_one、func_two、func_three)前面呼叫時可以給裝飾器傳入引數，這樣的輸出結果是，
[One] func three run time 1.0013229846954346
[Two] func three run time 1.000720500946045
[Three] func three run time 1.0001459121704102
6.自定義屬性的裝飾器
上述介紹的幾種用法中其實有一個問題，就是裝飾器不夠靈活，我們預先定義了裝飾器run_time，它就會按照我們定義的流程去作業，只具備這固定的一種功能，當然，我們前面介紹的通過帶引數的裝飾器讓它具備了一定的靈活性，但是依然不夠靈活，其實，我們還可以對裝飾器添加一些屬性，就如同給一個類定義實作不同功能的方法那樣，
以輸出日志為例，初學Python的同學都習慣用print列印輸出資訊，其實這不是一個好習慣，當開發商業工程時，你很用意把一些資訊暴露給用戶，在開發程序中，我更加鼓勵使用日志進行輸出，通過定義WARNING、DEBUG、INFO等不同等級來控制資訊的輸出，比如INFO是可以給用戶看到的，讓用戶直到當前程式跑到哪一個階段了，DEBUG是用于開發人員除錯和定位問題時使用，WARING是用于告警和提示，
那么問題來了，如果我們預先定義一個列印日志的裝飾器，
def logger_info(func):
logmsg = func.__name__
def wrapper():
func()
log.log(logging.INFO, "{} if over.".format(logmsg))
return wrapper
http://logging.INFO是列印日志的等級，如果我們僅僅寫一個基本的日志裝飾器logger_info，那么它的靈活度太差了，因為如果我們要輸出DEBUG、WARING等級的日志，還需要重新寫一個裝飾器，
解決這個問題，有兩個解決方法：
- 利用前面所講的帶引數裝飾器，把日志等級傳入裝飾器
- 利用自定義屬性來修改日志等級
由于第一種已經以統計函式運行時間的方式進行講解，這里主要講解第二種方法，
先看一下代碼，
import logging
from functools import partial
def wrapper_property(obj, func=None):
if func is None:
return partial(attach_wrapper, obj)
setattr(obj, func.__name__, func)
return func
def logger_info(level, name=None, message=None):
def decorate(func):
logmsg = message if message else func.__name__
def wrapper(*args, **kwargs):
log.log(level, logmsg)
return func(*args, **kwargs)
@wrapper_property(wrapper)
def set_level(newlevel):
nonlocal level
level = newlevel
@wrapper_property(wrapper)
def set_message(newmsg):
nonlocal logmsg
logmsg = newmsg
return wrapper
return decorate
@logger_info(logging.WARNING)
def main(x, y):
return x + y
這里面最重要的是wrapper_property這個函式，它的功能是把一個函式func編程一個物件obj的屬性，然后通過呼叫wrapper_property，給裝飾器添加了兩個屬性set_message和set_level，分別用于改變輸出日志的內容和改變輸出日志的等級，
看一下輸出結果，
main(3, 3)
# 輸出
# WARNING:Test:main
# 6
來改改變一下輸出日志等級，
main.set_level(logging.ERROR)
main(5, 5)
# 輸出
# ERROR:Test:main
# 10
輸出日志等級改成了ERROR，
7.保留元資訊的裝飾器
很多教程中都會介紹裝飾器，但是大多數都是千篇一律的圍繞基本用法在展開，少部分會講一下帶引數的裝飾器，但是有一個細節很少有教程提及，那就是保留元資訊的裝飾器，
什么是函式的元資訊？
就是函式攜帶的一些基本資訊，例如函式名、函式檔案等，我們可以通過func.name獲取函式名、可以通過func.doc獲取函式的檔案資訊，用戶也可以通過注解等方式為函式添加元資訊，
例如下面代碼，
from time import time
def run_time(func):
def wrapper(*args, **kwargs):
start = time()
func() # 函式在這里運行
end = time()
cost_time = end - start
print("func three run time {}".format(cost_time))
return wrapper
#學習中遇到問題沒人解答？小編創建了一個Python學習交流群：711312441
@run_time
def fun_one():
'''
func one doc.
'''
sleep(1)
fun_one()
print(fun_one.__name__)
print(fun_one.__doc__)
# 輸出
# wrapper
# None
可以看出，通過使用裝飾器，函式fun_one的元資訊都丟失了，那怎么樣才能保留裝飾器的元資訊呢？
可以通過使用Python自帶模塊functools中的wraps來保留函式的元資訊，
from time import time
from functools import wraps
def run_time(func):
@wraps(func) # <- 這里加 wraps(func) 即可
def wrapper(*args, **kwargs):
start = time()
func() # 函式在這里運行
end = time()
cost_time = end - start
print("func three run time {}".format(cost_time))
return wrapper
@run_time
def fun_one():
'''
func one doc.
'''
sleep(1)
fun_one()
print(fun_one.__name__)
print(fun_one.__doc__)
# 輸出
# fun_one
# func one doc.
只需要在代碼中加入箭頭所指的一行即可保留函式的元資訊，
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/543862.html
標籤：Python
上一篇：Python pydot與graphviz庫在Anaconda環境的配置
下一篇：Acwing 327. 玉米田