python學(xué)習(xí)：三個(gè)測試庫的裝飾器實(shí)現(xiàn)思路

在 Python 中實(shí)現(xiàn)參數(shù)化測試的幾個(gè)庫，并留下一個(gè)問題：

它們是如何做到把一個(gè)方法變成多個(gè)方法，并且將每個(gè)方法與相應(yīng)的參數(shù)綁定起來的呢？

我們再提煉一下，原問題等于是：在一個(gè)類中，如何使用裝飾器把一個(gè)類方法變成多個(gè)類方法（或者產(chǎn)生類似的效果）？

# 帶有一個(gè)方法的測試類
class TestClass:
    def test_func(self):
        pass

# 使用裝飾器，生成多個(gè)類方法
class TestClass:
    def test_func1(self):
        pass
    def test_func2(self):
        pass
    def test_func3(self):
        pass

Python 中裝飾器的本質(zhì)就是移花接木，用一個(gè)新的方法來替代被裝飾的方法。在實(shí)現(xiàn)參數(shù)化的過程中，我們介紹過的幾個(gè)庫到底用了什么手段/秘密武器呢？

1、ddt 如何實(shí)現(xiàn)參數(shù)化？

先回顧一下上篇文章中 ddt 庫的寫法：

import unittest
from ddt import ddt,data,unpack
@ddt
class MyTest(unittest.TestCase):
    @data((3, 1), (-1, 0), (1.2, 1.0))
    @unpack
    def test(self, first, second):
        pass

ddt 可提供 4 個(gè)裝飾器：1 個(gè)加在類上的 @ddt，還有 3 個(gè)加在類方法上的 @data、@unpack 和 @file_data（前文未提及）。

先看看加在類方法上的三個(gè)裝飾器的作用：

# ddt 版本（win）：1.2.1
def data(*values):
    global index_len
    index_len = len(str(len(values)))
    return idata(values)

def idata(iterable):
    def wrapper(func):
        setattr(func, DATA_ATTR, iterable)
        return func
    return wrapper

def unpack(func):
    setattr(func, UNPACK_ATTR, True)
    return func

def file_data(value):
    def wrapper(func):
        setattr(func, FILE_ATTR, value)
        return func
    return wrapper

它們的共同作用是在類方法上 setattr() 添加屬性。至于這些屬性在什么時(shí)候使用？下面看看加在類上的 @ddt 裝飾器源碼：

第一層 for 循環(huán)遍歷了所有的類方法，然后是 if/elif 兩條分支，分別對(duì)應(yīng) DATA_ATTR/FILE_ATTR，即對(duì)應(yīng)參數(shù)的兩種來源：數(shù)據(jù)（@data）和文件（@file_data）。

elif 分支有解析文件的邏輯，之后跟處理數(shù)據(jù)相似，所以我們把它略過，主要看前面的 if 分支。這部分的邏輯很清晰，主要完成的任務(wù)如下：
? 遍歷類方法的參數(shù)鍵值對(duì)
? 根據(jù)原方法及參數(shù)對(duì)，創(chuàng)建新的方法名
? 獲取原方法的文檔字符串
? 對(duì)元組和列表類型的參數(shù)作解包
? 在測試類上添加新的測試方法，并綁定參數(shù)與文檔字符串

分析源碼，可以看出，@data、@unpack 和 @file_data 這三個(gè)裝飾器主要是設(shè)置屬性并傳參，而 @ddt 裝飾器才是核心的處理邏輯。

這種將裝飾器分散（分別加在類與類方法上），再組合使用的方案，很不優(yōu)雅。為什么就不能統(tǒng)一起來使用呢？后面我們會(huì)分析它的難言之隱，先按下不表，看看其它的實(shí)現(xiàn)方案是怎樣的？

2、parameterized 如何實(shí)現(xiàn)參數(shù)化？

先回顧一下上篇文章中 parameterized 庫的寫法：

import unittest
from parameterized import parameterized
class MyTest(unittest.TestCase):
    @parameterized.expand([(3,1), (-1,0), (1.5,1.0)])
    def test_values(self, first, second):
        self.assertTrue(first > second)

它提供了一個(gè)裝飾器類 @parameterized，源碼如下（版本 0.7.1），主要做了一些初始的校驗(yàn)和參數(shù)解析，并非我們關(guān)注的重點(diǎn)，略過。

我們主要關(guān)注這個(gè)裝飾器類的 expand() 方法，它的文檔注釋中寫到：

A "brute force" method of parameterizing test cases. Creates new test cases and injects them into the namespace that the wrapped function is being defined in. Useful for parameterizing tests in subclasses of 'UnitTest', where Nose test generators don't work.

關(guān)鍵的兩個(gè)動(dòng)作是：“creates new test cases（創(chuàng)建新的測試單元）”和“inject them into the namespace…（注入到原方法的命名空間）”。

關(guān)于第一點(diǎn)，它跟 ddt 是相似的，只是一些命名風(fēng)格上的差異，以及參數(shù)的解析及綁定不同，不值得太關(guān)注。

最不同的則是，怎么令新的測試方法生效？

parameterized 使用的是一種“注入”的方式：

inspect 是個(gè)功能強(qiáng)大的標(biāo)準(zhǔn)庫，在此用于獲取程序調(diào)用棧的信息。前三句代碼的目的是取出 f_locals，它的含義是“l(fā)ocal namespace seen by this frame”，此處 f_locals 指的就是類的局部命名空間。

說到局部命名空間，你可能會(huì)想到 locals()，但是，我們之前有文章提到過“l(fā)ocals() 與 globals() 的讀寫問題”，locals() 是可讀不可寫的，所以這段代碼才用了 f_locals。

3、pytest 如何實(shí)現(xiàn)參數(shù)化？

按慣例先看看上篇文章中的寫法：

import pytest
@pytest.mark.parametrize("first,second", [(3,1), (-1,0), (1.5,1.0)])
def test_values(first, second):
    assert(first > second)

首先看到“mark”，pytest 里內(nèi)置了一些標(biāo)簽，例如 parametrize、timeout、skipif、xfail、tryfirst、trylast 等，還支持用戶自定義的標(biāo)簽，可以設(shè)置執(zhí)行條件、分組篩選執(zhí)行，以及修改原測試行為等等。

用法也是非常簡單的，然而，其源碼可復(fù)雜多了。我們這里只關(guān)注 parametrize，先看看核心的一段代碼：

根據(jù)傳入的參數(shù)對(duì)，它復(fù)制了原測試方法的調(diào)用信息，存入待調(diào)用的列表里。跟前面分析的兩個(gè)庫不同，它并沒有在此創(chuàng)建新的測試方法，而是復(fù)用了已有的方法。在 parametrize() 所屬的 Metafunc 類往上查找，可以追蹤到 _calls 列表的使用位置：

最終是在 Function 類中執(zhí)行：

好玩的是，在這里我們可以看到幾行神注釋……

閱讀（粗淺涉獵） pytest 的源碼，真的是自討苦吃……不過，依稀大致可以看出，它在實(shí)現(xiàn)參數(shù)化時(shí)，使用的是生成器的方案，遍歷一個(gè)參數(shù)則調(diào)用一次測試方法，而前面的 ddt 和 parameterized 則是一次性把所有參數(shù)解析完，生成 n 個(gè)新的測試方法，再交給測試框架去調(diào)度。

對(duì)比一下，前兩個(gè)庫的思路很清晰，而且由于其設(shè)計(jì)單純是為了實(shí)現(xiàn)參數(shù)化，不像 pytest 有什么標(biāo)記和過多的抽象設(shè)計(jì)，所以更易讀易懂。前兩個(gè)庫發(fā)揮了 Python 的動(dòng)態(tài)特性，設(shè)置類屬性或者注入局部命名空間，而 pytest 倒像是從什么靜態(tài)語言中借鑒的思路，略顯笨拙。

4、最后小結(jié)

回到標(biāo)題中的問題“如何將一個(gè)方法變?yōu)槎鄠€(gè)方法？”除了在參數(shù)化測試中，不知還有哪些場景會(huì)有此訴求？歡迎留言討論。

本文分析了三個(gè)測試庫的裝飾器實(shí)現(xiàn)思路，通過閱讀源碼，我們可以發(fā)現(xiàn)它們各有千秋，這個(gè)發(fā)現(xiàn)本身還挺有意思。在使用裝飾器時(shí)，表面看它們差異不大，但是真功夫的細(xì)節(jié)都隱藏在底下。

源碼分析的意義在于探究其所以然，在這次探究之旅中，讀者們可有什么收獲??？