python裝飾器入門

摘要： python裝飾器初級 認識裝飾器 概念: 簡單地說：他們是為其他函式的新增功能的函式 原則 : 不修改被裝飾函式的原始碼 不修...

python裝飾器初級

認識裝飾器

• 概念:
  • 簡單地說：他們是為其他函式的新增功能的函式
• 原則 :
  • 不修改被裝飾函式的原始碼
  • 不修改被裝飾函式的呼叫方式
• 優點:
  • 有助於讓我們的程式碼更簡短，也更Pythonic（Python範兒
• 應用場景:
  • 在專案迭代過程中,需要不停的為某一個功能(函式)新增或刪除某些小功能, 如果可複用的函式本來比較多, 在如果不停的對原始函式進行修改, 這將會是一件煩躁和重複的工作. 而使用裝飾器就可以很完美的解決這種問題, 如web使用者的的授權管理,日誌輸出等!

知識儲備

• 函式即變數

  • 函式本質在計算機的記憶體中的一個單獨記憶體空間, 函式名如同其他型別(int, str, list...)變數名一樣,可以進行賦值,傳遞

• 巢狀函式 :

  • 定義: 在一個函式中定義另一個函式：

    def hi(name="faily"):
    print("now you are inside the hi() function")
    
    def greet():
    return "now you are in the greet() function"
    
    def welcome():
    return "now you are in the welcome() function"
    
    print(greet())
    print(welcome())
    print("now you are back in the hi() function")
    
    if __name__ == "__main__":
    hi()

• 從函式中返回函式

  • 其實並不需要在一個函式裡去執行另一個函式，也可以將其作為輸出返回出來

    def hi(name="faily"):
    def greet():
    return "now you are in the greet() function"
    
    def welcome():
    return "now you are in the welcome() function"
    
    if name == "faily":
    return greet
    else:
    return welcome
    
    if __name__ == "__main__"
    a = hi()# 此時返回的a實際是greet函式名
    print(a)# 執行greet函式

    在if/else 語句中我們返回greet 和welcome ，而不是greet() 和welcome() 。為什麼那樣？這是因為當你把一對小括號放在後面，這個函式就會執行；然而如果你不放括號在它後面，那它可以被到處傳遞，並且可以賦值給別的變數而不去執行它。

    當我們寫下a = hi() ，hi() 會被執行，而由於name 引數預設是yasoob ，所以函式greet 被返回了。如果我們把語句改為a = hi(name = "momo") ，那麼welcome 函式將被返回。我們還可以打印出hi()() ，這會輸出now you are in the greet() function 。

• 高階函式

  • 定義: 把一個函式名當作實參傳遞給另外一個函式

    # 計算函式的bar執行時間
    import time
    
    def bar():
    time.sleep(3)
    print("in the bar")
    
    def run_time(func):
    t1 = time.time()
    func()
    t2 = time.time()
    print("the func:{0} run time is {1}".format(func.__name__,t2-t1))
    
    if __name__ == "__main__":
    run_time(bar)

  • 缺點: 雖然實現了此功能,但是改變了bar 函式名

裝飾器演變

• 實際就是:高階函式 +巢狀函式 的結合體

  認證 裝飾器演變

  • v1將函式作為引數傳遞進 巢狀函式中, 返回函式本身

    def cert_decorator(func):
    
    def wrapTheFunction():
    user = input("pls input password:").strip()
    if user == "faily":
    print("---welcome login----")
    func()
    else:
    print("----wrong password")
    return wrapper
    
    def task():
    print("do somthing ")
    
    if __name__ == "__main__":
    task = cert_decorator(task)# 執行裝飾器函式,將task作為引數傳遞,賦值給task變數,返回的是wrapper函式名,內部函式func並沒有執行
    task()# 執行task,實際就是執行了wrapper(),然後執行了內部的func()函式

    實現了不改變函式名的和內部結構的前提下, 實現了認證,但是, 但是... 使用者需要多些一行重新命名函式變數的方式

  • v2python內部可以通過@ 符號進行直接呼叫

    def cert_decorator(func):
    
    def wrapTheFunction():
    user = input("pls input password:").strip()
    if user == "faily":
    print("---welcome login----")
    func()
    else:
    print("----wrong password")
    return wrapTheFunction
    
    @cert_decorator
    def task():
    print("do somthing ")
    
    if __name__ == "__main__":
    task()

    ※ 好像我們大功告成了... 別高興得太早 ,如果我們執行一下這行程式碼 會存在一個問題

    print(task.__name__)
    #output
    wrapTheFunction

    ♥ . 這並不是我們想要的！Ouput輸出應該是task 。這裡的函式被warpTheFunction替代了。它重寫了我們函式的名字和註釋文件(docstring),如果我們想在被裝飾的函式在執行之前去訪問函式的某些屬性(文件, 變數名...),顯然是沒辦法做到的 ,怎麼辦???

    幸運的是Python提供給我們一個簡單的函式來解決這個問題，那就是functools.wraps 。我們修改上一個例子來使用functools.wraps

  • v3使用functools.wraps

    from functools import wraps
    
    def cert_decorator(func):
    @wraps(func)
    def wrapTheFunction():
    user = input("pls input password:").strip()
    if user == "faily":
    print("---welcome login----")
    func()
    else:
    print("----wrong password----")
    return wrapTheFunction
    
    @cert_decorator
    def task():
    print("do somthing ")
    
    if __name__ == "__main__":
    task()
    print(task.__name__)
    
    
    # output
    pls input password:mm
    ----wrong password----
    task

    注意：@wraps接受一個函式來進行裝飾，並加入了複製函式名稱、註釋文件、引數列表等等的功能。這可以讓我們在裝飾器裡面訪問在裝飾之前的函式的屬性。