這篇文章將為大家詳細(xì)講解有關(guān)pytest如何編寫斷言，小編覺得挺實用的，因此分享給大家做個參考，希望大家閱讀完這篇文章后可以有所收獲。
編寫斷言
使用assert編寫斷言
pytest允許你使用python標(biāo)準(zhǔn)的assert表達(dá)式寫斷言；
例如，你可以這樣做：
# 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子表達(dá)式的值，包括：調(diào)用、屬性、比較、二進(jìn)制和一元運算符等（參考pytest支持的python失敗時報告的演示）;
這允許你在沒有模版代碼參考的情況下，可以使用的python的數(shù)據(jù)結(jié)構(gòu)，而無須擔(dān)心丟失自省的問題；
同時，你也可以為斷言指定了一條說明信息，用于失敗時的情況說明：
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()當(dāng)用例沒有返回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)
則測試將永遠(yuǎn)成功，因為assert '456' in str(excinfo.value)并不會執(zhí)行；
你也可以給pytest.raises()傳遞一個關(guān)鍵字參數(shù)match，來測試異常的字符串表示str(excinfo.value)是否符合給定的正則表達(dá)式（和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實際調(diào)用的是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，一個關(guān)鍵字參數(shù)match和一組關(guān)鍵字參數(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ù)必須是一個可調(diào)用的對象，否則會報TypeError異常；同時，它會把剩余的args參數(shù)和所有kwargs參數(shù)傳遞給這個可調(diào)用對象，然后檢查這個對象執(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ù)，來判斷用例是否因為一個具體的異常而導(dǎo)致失?。?/p>
@pytest.mark.xfail(raises=IndexError) def test_f(): f()
如果f()觸發(fā)一個IndexError異常，則用例標(biāo)記為xfailed；如果沒有，則正常執(zhí)行f()；
注意：如果f()測試成功，用例的結(jié)果是xpassed，而不是passed；
pytest.raises適用于檢查由代碼故意引發(fā)的異常；而@pytest.mark.xfail()更適合用于記錄一些未修復(fù)的Bug；
特殊數(shù)據(jù)結(jié)構(gòu)比較時的優(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ù)結(jié)構(gòu)的比較：集合、字符串和字典；
/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ù)結(jié)構(gòu)間的比較，pytest對結(jié)果的顯示做了一些優(yōu)化：
集合、列表等：標(biāo)記出第一個不同的元素；
字符串：標(biāo)記出不同的部分；
字典：標(biāo)記出不同的條目；
更多例子參考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對象，也復(fù)寫了它的__eq__()方法，但當(dāng)我們執(zhí)行這個用例時：
