pytest中文文檔之編寫斷言
更新時間：2019年09月12日 11:46:39 作者：luizyao
這篇文章主要給大家介紹了關于pytest中文文檔之編寫斷言的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用pytest具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧
編寫斷言
使用assert編寫斷言
pytest允許你使用python標準的assert表達式寫斷言；
例如，你可以這樣做：
# test_sample.py def func(x): return x + 1 def test_sample(): assert func(3) == 5
如果這個斷言失敗，你會看到func(3)實際的返回值：
/d/Personal Files/Python/pytest-chinese-doc/src (5.1.2) λ pytest test_sample.py ================================================= test session starts ================================================= platform win32 -- Python 3.7.3, pytest-5.1.2, py-1.8.0, pluggy-0.12.0 rootdir: D:\Personal Files\Python\pytest-chinese-doc\src, inifile: pytest.ini collected 1 item test_sample.py F [100%] ====================================================== FAILURES ======================================================= _____________________________________________________ test_sample _____________________________________________________ def test_sample(): > assert func(3) == 5 E assert 4 == 5 E + where 4 = func(3) test_sample.py:28: AssertionError ================================================== 1 failed in 0.05s ==================================================
pytest支持顯示常見的python子表達式的值，包括：調用、屬性、比較、二進制和一元運算符等（參考pytest支持的python失敗時報告的演示）;
這允許你在沒有模版代碼參考的情況下，可以使用的python的數(shù)據(jù)結構，而無須擔心丟失自省的問題；
同時，你也可以為斷言指定了一條說明信息，用于失敗時的情況說明：
assert a % 2 == 0, "value was odd, should be even"
編寫觸發(fā)期望異常的斷言
你可以使用pytest.raises()作為上下文管理器，來編寫一個觸發(fā)期望異常的斷言：
import pytest
def myfunc():
raise ValueError("Exception 123 raised")
def test_match():
with pytest.raises(ValueError):
myfunc()
當用例沒有返回ValueError或者沒有異常返回時，斷言判斷失??；
如果你希望同時訪問異常的屬性，可以這樣：
import pytest
def myfunc():
raise ValueError("Exception 123 raised")
def test_match():
with pytest.raises(ValueError) as excinfo:
myfunc()
assert '123' in str(excinfo.value)
其中，excinfo是ExceptionInfo的一個實例，它封裝了異常的信息；常用的屬性包括：.type、.value和.traceback；
注意：在上下文管理器的作用域中，raises代碼必須是最后一行，否則，其后面的代碼將不會執(zhí)行；所以，如果上述例子改成：
def test_match(): with pytest.raises(ValueError) as excinfo: myfunc() assert '456' in str(excinfo.value)
則測試將永遠成功，因為assert '456' in str(excinfo.value)并不會執(zhí)行；
你也可以給pytest.raises()傳遞一個關鍵字參數(shù)match，來測試異常的字符串表示str(excinfo.value)是否符合給定的正則表達式（和unittest中的TestCase.assertRaisesRegexp方法類似）：
import pytest
def myfunc():
raise ValueError("Exception 123 raised")
def test_match():
with pytest.raises((ValueError, RuntimeError), match=r'.* 123 .*'):
myfunc()
pytest實際調用的是re.search()方法來做上述檢查；并且，pytest.raises()也支持檢查多個期望異常（以元組的形式傳遞參數(shù)），我們只需要觸發(fā)其中任意一個；
pytest.raises還有另外的一種使用形式：
首先，我們來看一下它在源碼中的定義：
# _pytest/python_api.py def raises( # noqa: F811 expected_exception: Union["Type[_E]", Tuple["Type[_E]", ...]], *args: Any, match: Optional[Union[str, "Pattern"]] = None, **kwargs: Any ) -> Union["RaisesContext[_E]", Optional[_pytest._code.ExceptionInfo[_E]]]:
它接收一個位置參數(shù)expected_exception，一組可變參數(shù)args，一個關鍵字參數(shù)match和一組關鍵字參數(shù)kwargs；
接著往下看：
# _pytest/python_api.py
if not args:
if kwargs:
msg = "Unexpected keyword arguments passed to pytest.raises: "
msg += ", ".join(sorted(kwargs))
msg += "\nUse context-manager form instead?"
raise TypeError(msg)
return RaisesContext(expected_exception, message, match)
else:
func = args[0]
if not callable(func):
raise TypeError(
"{!r} object (type: {}) must be callable".format(func, type(func))
)
try:
func(*args[1:], **kwargs)
except expected_exception as e:
# We just caught the exception - there is a traceback.
assert e.__traceback__ is not None
return _pytest._code.ExceptionInfo.from_exc_info(
(type(e), e, e.__traceback__)
)
fail(message)
其中，args如果存在，那么它的第一個參數(shù)必須是一個可調用的對象，否則會報TypeError異常；同時，它會把剩余的args參數(shù)和所有kwargs參數(shù)傳遞給這個可調用對象，然后檢查這個對象執(zhí)行之后是否觸發(fā)指定異常；
所以我們有了一種新的寫法：
pytest.raises(ZeroDivisionError, lambda x: 1/x, 0) # 或者 pytest.raises(ZeroDivisionError, lambda x: 1/x, x=0)
這個時候如果你再傳遞match參數(shù)，是不生效的，因為它只有在if not args:的時候生效；
另外，pytest.mark.xfail()也可以接收一個raises參數(shù)，來判斷用例是否因為一個具體的異常而導致失?。?/p>
@pytest.mark.xfail(raises=IndexError) def test_f(): f()
如果f()觸發(fā)一個IndexError異常，則用例標記為xfailed；如果沒有，則正常執(zhí)行f()；
注意：如果f()測試成功，用例的結果是xpassed，而不是passed；
pytest.raises適用于檢查由代碼故意引發(fā)的異常；而@pytest.mark.xfail()更適合用于記錄一些未修復的Bug；
特殊數(shù)據(jù)結構比較時的優(yōu)化
# test_special_compare.py
def test_set_comparison():
set1 = set('1308')
set2 = set('8035')
assert set1 == set2
def test_long_str_comparison():
str1 = 'show me codes'
str2 = 'show me money'
assert str1 == str2
def test_dict_comparison():
dict1 = {
'x': 1,
'y': 2,
}
dict2 = {
'x': 1,
'y': 1,
}
assert dict1 == dict2
上面，我們檢查了三種數(shù)據(jù)結構的比較：集合、字符串和字典；
/d/Personal Files/Python/pytest-chinese-doc/src (5.1.2)
λ pytest test_special_compare.py
================================================= test session starts =================================================
platform win32 -- Python 3.7.3, pytest-5.1.2, py-1.8.0, pluggy-0.12.0
rootdir: D:\Personal Files\Python\pytest-chinese-doc\src, inifile: pytest.ini
collected 3 items
test_special_compare.py FFF [100%]
====================================================== FAILURES ======================================================= _________________________________________________ test_set_comparison _________________________________________________
def test_set_comparison():
set1 = set('1308')
set2 = set('8035')
> assert set1 == set2
E AssertionError: assert {'0', '1', '3', '8'} == {'0', '3', '5', '8'}
E Extra items in the left set:
E '1'
E Extra items in the right set:
E '5'
E Use -v to get the full diff
test_special_compare.py:26: AssertionError
______________________________________________ test_long_str_comparison _______________________________________________
def test_long_str_comparison():
str1 = 'show me codes'
str2 = 'show me money'
> assert str1 == str2
E AssertionError: assert 'show me codes' == 'show me money'
E - show me codes
E ? ^ ^ ^
E + show me money
E ? ^ ^ ^
test_special_compare.py:32: AssertionError
________________________________________________ test_dict_comparison _________________________________________________
def test_dict_comparison():
dict1 = {
'x': 1,
'y': 2,
}
dict2 = {
'x': 1,
'y': 1,
}
> assert dict1 == dict2
E AssertionError: assert {'x': 1, 'y': 2} == {'x': 1, 'y': 1}
E Omitting 1 identical items, use -vv to show
E Differing items:
E {'y': 2} != {'y': 1}
E Use -v to get the full diff
test_special_compare.py:44: AssertionError
================================================== 3 failed in 0.09s ==================================================
針對一些特殊的數(shù)據(jù)結構間的比較，pytest對結果的顯示做了一些優(yōu)化：
- 集合、列表等：標記出第一個不同的元素；
- 字符串：標記出不同的部分；
- 字典：標記出不同的條目；
更多例子參考pytest支持的python失敗時報告的演示
為失敗斷言添加自定義的說明
# test_foo_compare.py class Foo: def __init__(self, val): self.val = val def __eq__(self, other): return self.val == other.val def test_foo_compare(): f1 = Foo(1) f2 = Foo(2) assert f1 == f2
我們定義了一個Foo對象，也復寫了它的__eq__()方法，但當我們執(zhí)行這個用例時：
/d/Personal Files/Python/pytest-chinese-doc/src (5.1.2) λ pytest test_foo_compare.py ================================================= test session starts ================================================= platform win32 -- Python 3.7.3, pytest-5.1.2, py-1.8.0, pluggy-0.12.0 rootdir: D:\Personal Files\Python\pytest-chinese-doc\src, inifile: pytest.ini collected 1 item test_foo_compare.py F [100%] ====================================================== FAILURES ======================================================= __________________________________________________ test_foo_compare ___________________________________________________ def test_foo_compare(): f1 = Foo(1) f2 = Foo(2) > assert f1 == f2 E assert <src.test_foo_compare.Foo object at 0x0000020E90C4E978> == <src.test_foo_compare.Foo object at 0x0000020E90C4E630> test_foo_compare.py:37: AssertionError ================================================== 1 failed in 0.04s ==================================================
并不能直觀的看出來失敗的原因；
在這種情況下，我們有兩種方法來解決：
- 復寫Foo的__repr__()方法：
def __repr__(self): return str(self.val)
我們再執(zhí)行用例：
luyao@NJ-LUYAO-T460 /d/Personal Files/Python/pytest-chinese-doc/src (5.1.2)
λ pytest test_foo_compare.py
================================================= test session starts =================================================
platform win32 -- Python 3.7.3, pytest-5.1.2, py-1.8.0, pluggy-0.12.0
rootdir: D:\Personal Files\Python\pytest-chinese-doc\src, inifile: pytest.ini
collected 1 item
test_foo_compare.py F [100%]
====================================================== FAILURES ======================================================= __________________________________________________ test_foo_compare ___________________________________________________
def test_foo_compare():
f1 = Foo(1)
f2 = Foo(2)
> assert f1 == f2
E assert 1 == 2
test_foo_compare.py:37: AssertionError
================================================== 1 failed in 0.06s ==================================================
這時，我們能看到失敗的原因是因為1 == 2不成立；
至于__str__()和__repr__()的區(qū)別，可以參考StackFlow上的這個問題中的回答：https://stackoverflow.com/questions/1436703/difference-between-str-and-repr
- 使用pytest_assertrepr_compare這個鉤子方法添加自定義的失敗說明
# conftest.py
from .test_foo_compare import Foo
def pytest_assertrepr_compare(op, left, right):
if isinstance(left, Foo) and isinstance(right, Foo) and op == "==":
return [
"比較兩個Foo實例:", # 頂頭寫概要
" 值: {} != {}".format(left.val, right.val), # 除了第一個行，其余都可以縮進
]
再次執(zhí)行：
/d/Personal Files/Python/pytest-chinese-doc/src (5.1.2)
λ pytest test_foo_compare.py
================================================= test session starts =================================================
platform win32 -- Python 3.7.3, pytest-5.1.2, py-1.8.0, pluggy-0.12.0
rootdir: D:\Personal Files\Python\pytest-chinese-doc\src, inifile: pytest.ini
collected 1 item
test_foo_compare.py F [100%]
====================================================== FAILURES ======================================================= __________________________________________________ test_foo_compare ___________________________________________________
def test_foo_compare():
f1 = Foo(1)
f2 = Foo(2)
> assert f1 == f2
E assert 比較兩個Foo實例:
E 值: 1 != 2
test_foo_compare.py:37: AssertionError
================================================== 1 failed in 0.05s ==================================================
我們會看到一個更友好的失敗說明；
關于斷言自省的細節(jié)
當斷言失敗時，pytest為我們提供了非常人性化的失敗說明，中間往往夾雜著相應變量的自省信息，這個我們稱為斷言的自省；
那么，pytest是如何做到這樣的：
- pytest發(fā)現(xiàn)測試模塊，并引入他們，與此同時，pytest會復寫斷言語句，添加自省信息；但是，不是測試模塊的斷言語句并不會被復寫；
復寫緩存文件
pytest會把被復寫的模塊存儲到本地作為緩存使用，你可以通過在測試用例的根文件夾中的conftest.py里添加如下配置：
import sys sys.dont_write_bytecode = True
來禁止這種行為；
但是，它并不會妨礙你享受斷言自省的好處，只是不會在本地存儲.pyc文件了。
去使能斷言自省
你可以通過一下兩種方法：
- 在需要去使能模塊的docstring中添加PYTEST_DONT_REWRITE字符串；
- 執(zhí)行pytest時，添加--assert=plain選項；
我們來看一下去使能后的效果：
/d/Personal Files/Python/pytest-chinese-doc/src (5.1.2)
λ pytest test_foo_compare.py --assert=plain
================================================= test session starts =================================================
platform win32 -- Python 3.7.3, pytest-5.1.2, py-1.8.0, pluggy-0.12.0
rootdir: D:\Personal Files\Python\pytest-chinese-doc\src, inifile: pytest.ini
collected 1 item
test_foo_compare.py F [100%]
====================================================== FAILURES ======================================================= __________________________________________________ test_foo_compare ___________________________________________________
def test_foo_compare():
f1 = Foo(1)
f2 = Foo(2)
> assert f1 == f2
E AssertionError
test_foo_compare.py:37: AssertionError
================================================== 1 failed in 0.05s ==================================================
斷言失敗時的信息就非常的不完整了，我們幾乎看不出任何有用的Debug信息；
總結
以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，謝謝大家對腳本之家的支持。
相關文章
pytorch Variable與Tensor合并后 requires_grad()默認與修改方式
這篇文章主要介紹了pytorch Variable與Tensor合并后 requires_grad()默認與修改方式，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-05-05
在本篇文章里小編給大家整理了一篇關于python簡單實現(xiàn)插入排序實例代碼，有需要的朋友們可以學習參考下。2020-12-12
這篇文章主要介紹了python 安全地刪除列表元素的方法，分享的方法有 創(chuàng)建新列表，過濾元素和列表副本上迭代，下面相關內容需要的小伙伴可以參考一下2022-03-03
在本篇文章中小編給大家分享的是關于pycharm重命名文件的方法步驟，對此有需要的朋友們可以學習參考下。2019-07-07
這篇文章主要介紹了Python實現(xiàn)K折交叉驗證法的方法步驟，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-07-07
教你如何將 Sublime 3 打造成 Python/Django IDE開發(fā)利器
Sublime Text 是一款非常強大的文本編輯器, 下面我們介紹如何將 Sublime Text 3 打造成一款 Python/Django 開發(fā)利器:2014-07-07
apply 函數(shù)是 Kotlin 中一個十分方便的工具,它使得對對象進行初始化和配置變得更加簡潔、清晰,通過與 Java 的對比,我們可以看出 Kotlin 在處理類似情況時具有更高的表現(xiàn)力和簡潔性,本文給大家介紹Kotlin apply 函數(shù)的用法,感興趣的朋友一起看看吧2024-03-03
Windows 安裝 Anaconda3+PyCharm的方法步驟
這篇文章主要介紹了Windows 安裝 Anaconda3+PyCharm的方法步驟，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2019-06-06
Python中for循環(huán)可迭代對象迭代器及生成器源碼學習
這篇文章主要為大家介紹了Python中for循環(huán)可迭代對象迭代器及生成器的源碼學習，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-05-05
Python數(shù)據(jù)分析之Numpy庫的使用詳解
NumPy（Numerical Python）是Python的一種開源的數(shù)值計算擴展。這種工具可用來存儲和處理大型矩陣，比Python自身的嵌套列表結構要高效的多（該結構也可以用來表示矩陣（matrix）），支持大量的維度數(shù)組與矩陣運算，此外也針對數(shù)組運算提供大量的數(shù)學函數(shù)庫2021-11-11