python 裝飾器詳解

python裝飾器詳解

#python裝飾器的詳細解析

什麼是裝飾器？

推薦學習：Python影片教學

python裝飾器（fuctional decorators）就是用來拓展原來函數功能的函數，目的是在不改變原函數名(或類別名稱)的情況下，為函數增加新的功能。

這個函數的特別之處在於它的回傳值也是一個函數，這個函數是內嵌「原「」函數的函數。

一般而言，我們要拓展原來函數程式碼，最直接的辦法就是侵入程式碼裡面修改，例如：

import time
def f():
    print("hello")
    time.sleep(1)
    print("world")　　

 

#這是我們最原始的的函數，然後我們試著記錄這個函數執行的總時間，那最簡單的做法就是改動原來的程式碼：

import time
def f():
    start_time = time.time()
    print("hello")
    time.sleep(1)
    print("world")
    end_time = time.time()
    execution_time = (end_time - start_time)*1000
    print("time is %d ms" %execution_time)

 

但是實際工作中，有些時候核心程式碼並不可以直接去改，所以在不改動原始程式碼的情況下，我們可以再定義一個函數。（但是生效需要再次執行函數）

import time
def deco(func):
    start_time = time.time()
    f()
    end_time = time.time()
    execution_time = (end_time - start_time)*1000
    print("time is %d ms" %execution_time)
def f():
    print("hello")
    time.sleep(1)
    print("world")
if __name__ == '__main__':
    deco(f)
    print("f.__name__ is",f.__name__)
    print()

 

#這裡我們定義了一個函數deco，它的參數是一個函數，然後給這個函數嵌入了計時功能。但是想要拓展這一千萬個函數功能，

就是要執行一千萬次deco()函數，所以這樣並不理想！接下來，我們可以試著用裝飾器來實現，先看看裝飾器最原始的面貌。 

import time
def deco(f):
    def wrapper():
        start_time = time.time()
        f()
        end_time = time.time()
        execution_time = (end_time - start_time)*1000
        print("time is %d ms" %execution_time )
    return wrapper
@deco
def f():
    print("hello")
    time.sleep(1)
    print("world")
if __name__ == '__main__':
    f()

 

這裡的deco函數就是最原始的裝飾器，它的參數是一個函數，然後傳回值也是一個函數。

其中作為參數的這個函數f()就在傳回函數wrapper()的內部執行。然後在函數f()前面加上@deco，

f()函數就相當於被注入了計時功能，現在只要呼叫f()，它就已經變身為「新的功能更多」的函數了,

（不需要重複執行原函數）。 

擴展1：帶有固定參數的裝飾器

import time
def deco(f):
    def wrapper(a,b):
        start_time = time.time()
        f(a,b)
        end_time = time.time()
        execution_time = (end_time - start_time)*1000
        print("time is %d ms" % execution_time)
    return wrapper
@deco
def f(a,b):
    print("be on")
    time.sleep(1)
    print("result is %d" %(a+b))
if __name__ == '__main__':
    f(3,4)

擴展2：無固定參數的裝飾器

import time
def deco(f):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        f(*args, **kwargs)
        end_time = time.time()
        execution_time_ = (end_time - start_time)*1000
        print("time is %d ms" %execution_time)
    return wrapper
@deco
def f(a,b):
    print("be on")
    time.sleep(1)
    print("result is %d" %(a+b))
@deco
def f2(a,b,c):
    print("be on")
    time.sleep(1)
    print("result is %d" %(a+b+c))
if __name__ == '__main__':
    f2(3,4,5)
    f(3,4)

 

擴充3：使用多個裝飾器，裝飾一個函數

import time
def deco01(f):
    def wrapper(*args, **kwargs):
        print("this is deco01")
        start_time = time.time()
        f(*args, **kwargs)
        end_time = time.time()
        execution_time = (end_time - start_time)*1000
        print("time is %d ms" % execution_time)
        print("deco01 end here")
    return wrapper
def deco02(f):
    def wrapper(*args, **kwargs):
        print("this is deco02")
        f(*args, **kwargs)
        print("deco02 end here")
    return wrapper
@deco01
@deco02
def f(a,b):
    print("be on")
    time.sleep(1)
    print("result is %d" %(a+b))
if __name__ == '__main__':
    f(3,4)

'''
this is deco01
this is deco02
hello，here is a func for add :
result is 7
deco02 end here
time is 1003 ms
deco01 end here
'''

裝飾器呼叫順序

裝飾器是可以疊加使用的，那麼使用裝飾器以後代碼是啥順序呢？

對於Python中的”@”語法糖，裝飾器的呼叫順序與使用 @ 語法糖聲明的順序相反。

在這個例子中，」f(3, 4) = deco01(deco02(f(3, 4)))」。

 

Python內建裝飾器

在Python中有三個內建的裝飾器，都是跟class相關的：staticmethod、classmethod 和property 。

staticmethod 是類別靜態方法，其跟成員方法的區別是沒有self 參數，並且可以在類別不進行實例化的情況下調用

classmethod 與成員方法的區別在於所接收的第一個參數不是self （類別實例的指標），而是cls（目前類別的具體類型）

property 是屬性的意思，表示可以透過透過類別實例直接存取的資訊

對於staticmethod和classmethod這裡就不介紹了，透過一個例子來看看property。

注意，對於Python新式類別（new-style class），如果將上面的「@var.setter」 裝飾器所裝飾的成員函數去掉，則Foo. var 屬性為唯讀屬性，使用「foo.var = 'var 2′」 進行賦值時會拋出異常。但是，對於Python classic class，所宣告的屬性不是 read-only的，所以即使去掉」@var.setter」裝飾器也不會報錯。

總結

本文介紹了Python裝飾器的一些使用，裝飾器的程式碼還是比較容易理解的。只要透過一些例子進行實際操作一下，就很容易理解了。

以上是python 裝飾器詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！