Python裝飾器使用接口測試的步驟

寫接口case時,有時需要對cae做一些共性的操作,最典型的場景如:獲取case執行時間、打印log等。

有沒有一種辦法來集中處理共性操作從而避免在每個case中都寫相同的代碼(如:每個case都需要寫相同的獲取執行時間的代碼)呢?

Python的裝飾器可以做到這一點。

可以這樣理解裝飾器,裝飾器運用閉包對目標函數進行裝飾(目標函數作為閉包外部函數的引用),即在執行目標函數之前、之後執行一些指定的代碼來完成想要的業務邏輯。

概念看起來總是晦澀,直接上語法吧。

第一步,先看一下閉包的語法:

def outer(a):
    b = 10
    # inner是內函數
    def inner():
        # 在內函數中 用到瞭外函數的臨時變量
        print(a + b)
    # 外函數的返回值是內函數的引用
    return inner

第二步,再來看一下閉包的裝飾器版本的語法:

和上面閉包的例子隻有一個區別:閉包中外部函數的引用是一個整數a,而此時是一個函數的引用(函數的引用也就是函數名)。

# 裝飾器用到閉包原理:外函數內部定義瞭一個內函數,內函數使用外函數的局部變量,並且外函數返回瞭內函數的引用
def outer(target):   # 裝飾器函數 傳入一個想對其裝飾的目標函數的 引用,將在內函數中使用。
   b = 10
    c = 1
    d = 5
    # inner是內函數
    def inner():
        print(b + c)
        # 外部函數傳入的參數target,就是希望裝飾的目標函數的引用
        target()   # 這裡實際上執行瞭目標函數,想對這個函數進行裝飾,所以在該函數執行之前和之後進行一番操作,具體什麼操作看業務邏輯
        print(c + d)
    # 外函數的返回值是內函數的引用
    return inner

註意:target隻是函數的一個引用(引用指向函數在內存中的位置),不會執行。帶()時( target() )才會執行該函數。

最後一步,再看一下裝飾器的語法:

@decorator
    def test_01():

所以可以總結出:裝飾器decorator是閉包的外部函數,即 outer() (裝飾器是一個函數,即閉包的外部函數),被裝飾函數test_01是閉包傳入的參數,即target。

舉個例子:

以統計各接口請求耗時為例。

裝飾器(decorat.py):

import time
def time_consume(func):
    def inner():
        time_start = time.time()  # 目標函數開始之前取一下時間
        print("\n接口請求前的時間是", time_start)
        func()
        time_end = time.time()  # 目標函數結束之後取一下時間
        print("接口請求後的時間是", time_end)
        t = time_end - time_start  # 計算目標函數執行花瞭多長時間
        print("接口耗時:", t)
    return inner

接口(test_case.py):

import requests
import decorat
@decorat.time_consume
def test_demo():
    res = requests.get("https://www.baidu.com")
    assert res.status_code == 200

效果:

再來總結下這個例子的整個過程:

'''
@decorat.time_consume實際上執行的是: test_demo = @decorat.time_consume(test_demo)
因為編程語言都是從右向左來解析執行的,那麼這句代碼會發生的事情是:

    1 、把目標函數test_demo(是一個變量名,裡面存的是目標函數的引用) 傳入time_consume函數,被參數func接收,這時func也是目標函數的引用 func和test_demo指向同一個函數對象    
    2 、time_consume函數定義瞭內部函數inner,在inner裡調用func,
    這用到閉包的原理(閉包原理:外函數結束的時會把自身的引用綁定給內函數),外函數結束的時候會把func綁定給內函數,供內函數來使用
    3、 外函數結束的時候把自己創建的內函數的引用inner返回給test_demo接收,
     這時test_demo已經不是原來編寫的目標函數瞭,test_demo可以理解成是一個inner函數的實例對象,再執行test_demo() 的時候實際上執行瞭inner()的一個對象
    4、 再執行test_demo() 的時候 實際上執行瞭inner() :
     先執行取時間,打印
     之後執行func(),才是執行目標函數,即執行test_demo()本身
     最後再次取時間,打印結果

大白話版本:

其實就一句話:
被裝飾函數作為裝飾器外部函數的參數傳入,在裝飾器的內部函數中執行被裝飾函數,並外加其他的代碼片段A,
這樣被裝飾函數除瞭具備自身的邏輯外,也擁有瞭裝飾器內部函數中代碼片段A的邏輯。使得無需修改被裝飾函數,
就增強瞭被裝飾函數的功能。

再來看兩種情景。

第一個:被裝飾函數有參數

一般接口測試的test_case不會想上面例子中提到的是一個函數,而是作為一個類的方法出現的,比如:

運行報錯瞭,報錯日志的意思是inner()需要0個入參,但是被傳入瞭1個。通過該報錯證明瞭上面提到的這個結論

原因是test_demo()有參數self,而inner()沒有定義入參。怎麼解決呢,給inner()定義一個可變入參?先來看第二個問題,最後一起來證明我們的推測吧。

第二個:被裝飾函數有返回值

問題出現瞭,返回值打印出來是None,因為inner()裡沒有變量去接收test_demo的返回值並返回嗎?帶著第一個問題的推測,一起來改下代碼。

做2處改動:

1、inner()定義可變入參

2、inner()裡定義變量去接收test_demo的返回值並return該變量

test_case作為一個類的方法出現的問題解決瞭。

返回值也能被正常打印瞭。

改動後的裝飾器可以作為一個定義裝飾器的通用模板,基本可以給各種各樣的函數來裝飾瞭。

def decorat_demo(func):
    def inner(*args, **kwargs):   # inner()接收可變參數
        # any code before # 定義目標函數前的操作
        # 調用目標函數
        res = func(*args, **kwargs)  # 定義變量接收目標函數返回值
        # any code after # 定義目標函數後的操作
        return res     # 返回目標函數返回值
    return inner

到此這篇關於Python裝飾器使用接口測試的步驟的文章就介紹到這瞭,更多相關python裝飾器接口測試內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: