python 如何用 Hypothesis 來自動化單元測試

Posted on by

高質量的代碼離不開單元測試，而設計單元測試的用例往往又比較耗時，而且難以想到一些極端情況，本文講述如何使用 Hypothesis 來自動化單元測試

刷過力扣算法題的同學都知道，有時候覺得代碼已經很完善瞭，一提交才發現很多情況沒有考慮到。然後感嘆力扣的單元測試真的牛比。

因此，高質量的代碼離不開單元測試，如果現在還沒有寫過單元測試，建議先去學習以下常用的單元測試庫[1]，隻要實踐過，才能感受到本文開頭提到的那些痛點。

Hypothesis 是一個 Python 庫，用於讓單元測試編寫起來更簡單，運行時功能更強大，可以在代碼中查找您不會想到的極端情況。它穩定，強大且易於添加到任何現有測試框架中。它的工作原理是讓您編寫斷言每種情況都應該正確的測試，而不僅僅是您偶然想到的那些。

Hypothesis 的基礎知識

典型的單元測試需要自己寫一些測試用例，然後編寫測試函數，通過一段代碼運行它，然後根據預期結果檢查結果。

Hypothesis 有所不同。它是基於屬性進行單元測試。它通過生成與您的規范匹配的任意數據並檢查在這種情況下程序是否仍然有效。如果找到瞭一個失敗的用例，它將采用該示例並將其測試用例范圍縮減縮減為一定尺寸，然後對其進行簡化，直到找到一個仍會導致問題的小得多的示例。然後將其保存，後續單元測試時仍會使用這些用例。

現在就讓我們看看怎麼用吧。

Hypothesis 快速入門

1、安裝

可以通過 pip 安裝，也可以通過源代碼安裝[2]，也可以安裝一些擴展[3]，如下：

pip install hypothesis
pip install hypothesis[pandas,django]

2、使用

先寫一段代碼，保存在 mycode.py 中，功能是對字符串進行特定的編碼和解碼，內容如下：

def encode(input_string):
 count = 1
 prev = ""
 lst = []
 for character in input_string:
  if character != prev:
   if prev:
    entry = (prev, count)
    lst.append(entry)
   count = 1
   prev = character
  else:
   count += 1
 entry = (character, count)
 lst.append(entry)
 return lst


def decode(lst):
 q = ""
 for character, count in lst:
  q += character * count
 return q

對這段代碼進行單元測試，往往需要寫很多測試用例，現在我們使用 hypothesis 來自動為我們測試，編寫 test_mycode.py （文件名隨意），內容如下：

from hypothesis import given
from mycode import decode,encode
from hypothesis.strategies import text
import unittest


class TestEncoding(unittest.TestCase):
 @given(text())
 def test_decode_inverts_encode(self, s):
  self.assertEqual(decode(encode(s)), s)


if __name__ == "__main__":
 unittest.main()

可以看出，這裡並沒有出現具體的測試用例，而是使用來 text 的策略，相當於 hypothesis 自動窮舉來可能的情況，也可以看出它很容易可其他測試框架集成，這裡是 unittest。現在來運行一下看看效果：

(py38env) ➜ tmp python test_mycode.py
Falsifying example: test_decode_inverts_encode(
 self=<__main__.TestEncoding testMethod=test_decode_inverts_encode>, s='',
)
E
======================================================================
ERROR: test_decode_inverts_encode (__main__.TestEncoding)
----------------------------------------------------------------------
Traceback (most recent call last):
 File "test_mycode.py", line 9, in test_decode_inverts_encode
 def test_decode_inverts_encode(self, s):
 File "/Users/aaron/py38env/lib/python3.8/site-packages/hypothesis/core.py", line 1162, in wrapped_test
 raise the_error_hypothesis_found
 File "test_mycode.py", line 10, in test_decode_inverts_encode
 self.assertEqual(decode(encode(s)), s)
 File "/Users/aaron/tmp/mycode.py", line 14, in encode
 entry = (character, count)
UnboundLocalError: local variable 'character' referenced before assignment

----------------------------------------------------------------------
Ran 1 test in 0.048s

FAILED (errors=1)

這裡測試出當字符串為 ” 的時候會拋出 UnboundLocalError 的異常。現在我們來修復這個 bug，然後把所有的測試用例 s 給打印出來，看看它用瞭哪些測試用例。

encode 函數加入以下代碼：

if not input_string:
 return []

test_mycode.py 文件打印出測試用例:

@given(text())
def test_decode_inverts_encode(self, s):
 print(f"{s=}")
 self.assertEqual(decode(encode(s)), s)

再次執行：

(py38env) ➜ tmp python test_mycode.py
s=''
s='1'
s='0'
s='0'
s='0'
s='Ā'
s='\U000cf5e5'
s='0'
s=''
s='0'
s='0'
s='E'
s=")dù'\x18\U0003deb3¤jd"
s='\U0005bc37\x07\U000537a1ÝÀãiÎ\U000ce9e5\x0b'
s='\U0005bc37\U0005bc37\U000537a1ÝÀãiÎ\U000ce9e5\x0b'
s='\U0005bc37\U000537a1\U000537a1ÝÀãiÎ\U000ce9e5\x0b'
s='À\U000537a1\U000537a1ÝÀãiÎ\U000ce9e5\x0b'
s='\U000965e1\x12\x85&\U000f500aÄÃc'
s='\n\U0004466c\x86Î\x07'
s='Ê\U00063f1e\x01G\x88'
s='ÚV\n'
s='VV\n'
s='\U0008debf湆è'
s='\U0008debf湆è'
s='\U0008debf湆'
s='\U0008debf\U0008debf'
s='\U0008debf\U0008debfó]½àq\x82#\U00015196\U0001c8beg'
s='\U0008debfgó]½àq\x82#\U00015196\U0001c8beg'
s='?'
s='Î'
s='Î\U00085b9e'
s="Î8'?\U00057c38Ù;\x07\U000a5ea8Ò»=\U00091d5b~8뺈"
s='\U000d6497Ý>'
s='\U000e0f01'
s='\U000e0f01Å0y¢KN®'
s='\U000e0f01Å0y¢KN®'
s='\U00050a06'
s='Å\U000b98b3か\U000ba80aá`Ã-Êu\x8c\x90³FÔ"'
s='\x8e\U0004612a\x83ç'
s='\x8e'
s='\x8e\x98\U000fb3e0\U0010d2b3\x10\x82\x94Ð渥'
s='¥W'
s='p\U000e5a2aE·`ì'
s='\U000b80f8\x12\U000c2d54'
s='.\U000703de'
s='6\U00010ffa\U000f7994\x8e'
s='116\U000f7994\x8e'
s='1?6\U000f7994\x8e'
s='4?6\U000f7994\x8e'
s='4\x8e6\U000f7994\x8e'
s='0'
s='\U0006a564´Ð\x93ü\x9eb&i\x1cÑ'
s='\U000ceb6f'
s='\U000ceb6f\xa0\x08'
s='\U000ceb6f\xa0\x08'
s='\U000ceb6fꄃ\x08'
s='\U000ceb6fꄃ勻\U0007cc15\U000b2aaa×**'
s='\U000ceb6fꄃ勻'
s='勻ꄃ勻'
s='J\x14?ö'
s='q)'
s='q)'
s='q\U00060931'
s='q6'
s='\U000e3441'
s='\U000e3441\U00019958¯'
s='\x13'
s='\U000f34dbk'
s='Kp&tÛà'
s='\nö\x93'
s='\n\n\x93'
s='\U00019c8dѳ\U00056cbd\U000e3b2f\U00058d302'
s='\x90=R\x8bß\x03'
s='\x9a'
s='\U000147e7'
s='\U000147e7\x85\U0007a3ef'
s='\U000147e7\U00050a070Â>'
s='\U000a4089\x0eC+RÁ\x02\x97\x9cüÌïSS\U0006cbc5;ÿ~\x16\x019VÇ\U000a32fdQ÷\x15'
s='ÞÚ¾\x19©Z®'
s='ਸ਼æ'
s='\U000cd45a'
s='\U000cd45a\U000e15cbÑ\x08J\ueb3eúß\x07I\x91\x9a\x18\x16Ç\x80\x1a'
s='\x8f}º\x0eq\x0b'
s='\x0e}º\x0eq\x0b'
s="\U000e05a3&¶º[fõ\x8bÜR'ͼt\x97íW\x05\U000caea9\U0008fd74\U000e8f1c¹?dfƾ\x13"
s='\x10\U000e12e2ù\U0006f96erý\U00014baf\x00\x95\U000dbc92É\U00081613µ\U0003b865Z\U0008cc3c'
s='ú\U000b561f\x8fÎ'
s='\tàÖ÷'
s='à\x92©Ì\U000618fa\x92'
s='\U000aaf94\x94\x84\U000cda69\U0005291a\U000a63deþ¿O\x8a>\U000b458bÊ.\U00086f07\x1a'
s='\U0009754e?U_\xa0\x13PQ\x18º\x07\U0006c9c5.Á'
s='\U00102456'
s='³WᵎÕ'
s='\x14\x1c'
s='\x14'
s='\x14\U00105bcd"\x10Ô\x99\U000a5032R\U00056c44V&÷>+\U000aaff2ñ®\U000d7570%ª!\U00032553´8x^«'
s='\x00\U000e2ac4¼ÄUrB'
s='\x00\U000e2ac4¼ÄUrB'
s='\x00\U000e2ac4¼ÄUrB'
s='ª\x1aU\x8aÇ\U000b2fb9\U0005a586'
.
----------------------------------------------------------------------
Ran 1 test in 0.180s

OK

從執行結果可以看出，” 首先被測試，其次 hypothesis 使用瞭大量的極端測試用例，減輕瞭手寫的負擔，大大提升瞭效率。

雖然 hypothesis 具有自動記憶功能，你仍然可以顯式的指定某個測試用例一直被測試，而且這是推薦的做法，比如我想在每次的測試中都測試 ”，可以這樣寫：

from hypothesis import given, example
from hypothesis.strategies import text


@given(text())
@example("")
def test_decode_inverts_encode(s):
 assert decode(encode(s)) == s

這一點非常有用，提升瞭測試代碼的可讀性，可以用來告訴開發人員或者未來的自己，輸入的字符串必須要考慮 ” 的情形。

此外，執行單元測試，不一定要使用 unittest.main()，也可以這樣，是不是很方便：

if __name__ == "__main__":
 test_decode_inverts_encode()

3、其他策略參考

從哪裡開始

以上僅僅是拋磚引玉，hypothesis 還有很多自動化的特性，不再一一列舉，最好的學習方法是邊做，邊嘗試。hypothesis 是一個開源項目，有著詳細的官方文檔[4]，GitHub 倉庫[5]這裡都是你開啟自動化測試的好地方：

參考資料

[1]

庫: https://realpython.com/python-testing/

[2]

源代碼安裝: https://github.com/HypothesisWorks/hypothesis/blob/master/CONTRIBUTING.rst

[3]

擴展: https://hypothesis.readthedocs.io/en/latest/extras.html

[4]

官方文檔: https://hypothesis.readthedocs.io/en/latest/quickstart.html#running-tests

[5]

GitHub 倉庫: https://github.com/HypothesisWorks/hypothesis/

以上就是python 如何用 Hypothesis 來自動化單元測試的詳細內容，更多關於python 用 Hypothesis 來自動化單元測試的資料請關註WalkonNet其它相關文章！

推薦閱讀：