Markers有啥用？

當(dāng)使用 Pytest 運行測試時，可以通過標(biāo)記（Markers）來為測試函數(shù)或類添加自定義的元數(shù)據(jù)。標(biāo)記可以用于對測試進行分類、過濾和定制化。

查看所有Markers

pytest --markers

常用的內(nèi)置標(biāo)記

內(nèi)置標(biāo)記（Built-in Markers）： Pytest 提供了一些內(nèi)置的標(biāo)記，用于常見的測試場景。一些常用的內(nèi)置標(biāo)記包括：

• @pytest.mark.skip: 標(biāo)記該測試為跳過；
• @pytest.mark.parametrize: 標(biāo)記該測試使用參數(shù)化，可以為測試函數(shù)指定多組參數(shù)；
• @pytest.mark.xfail: 標(biāo)記該測試為預(yù)期失??；
• @pytest.mark.skipif: 根據(jù)條件動態(tài)地跳過某個測試。
• @pytest.mark.timeout：為測試用例設(shè)置運行超時時間。

@pytest.mark.skip

可以設(shè)置一個可選參數(shù)reason，表明跳過的原因

import pytest
?
@pytest.mark.skip()
def test_01():
 ? ?pass

未增加跳過原因，輸出內(nèi)容為

test_demo.py::test_01 SKIPPED (unconditional skip)                       [100%]
Skipped: unconditional skip

我們增加跳過原因，看看輸出結(jié)果

import pytest
?
@pytest.mark.skip(reason='skip reason')
def test_01():
 ? ?pass

執(zhí)行輸出結(jié)果如下

test_demo.py::test_01 SKIPPED (skip reason) [100%] Skipped: skip reason

可以看到會直接顯示具體原因。

pytest.skip方法

這里我們順帶提一下這個方法。可以在測試執(zhí)行期間強制跳過

def test_01():
 ? ?pytest.skip(reason="skip reason")

另外，還可以為其設(shè)置一個布爾型的參數(shù)allow_module_level（默認(rèn)為False），表明是否允許在模塊中調(diào)用這種方法，如果置為True，則跳過模塊中剩余的部分，也就是說其值為True時這個模塊中所有測試方法都被跳過。

import sys
import pytest
?
if not sys.platform.startswith("darwin"):
 ?pytest.skip("如果不是mac,跳過"，allow_module_level = True)

注意：如果是在用例中設(shè)置allow_module_level為True，并不會跳過模塊中剩余的用例

@pytest.mark.skipif

帶條件的跳過執(zhí)行：滿足條件就跳過，不滿足條件就不跳過

import pytest
?
env = 'iOS'
?
@pytest.mark.skipif('env == "iOS"', reason="iOS不支持")
def test_01():
 ? ?pass

當(dāng)然也可以使用多條標(biāo)記

import pytest
import sys
?
env = 'iOS1'
?
?
@pytest.mark.skipif('env == "iOS"', reason="iOS不支持")
@pytest.mark.skipif(sys.version_info<(3,12), reason="3.12以下版本不支持")
def test_01():
 ? ?pass

可以看到第一個條件不滿足，我電腦的版本為3.8，第二個條件滿足，最終case跳過。

注意：當(dāng)一個用例指定了多個skipif條件時，只需滿足其中一個，就可以跳過這個用例的執(zhí)行。

當(dāng)然也可以在一個文件中定義所有的條件，需要時引入即可

import pytest
import sys
?
version = pytest.mark.skipif(sys.version_info<(3,12), reason="3.12以下版本不支持")
?
@version
def test_01():
 ? ?pass

這里不存在pytest.skipif()方法

@pytest.mark.xfail

表示期望這個用例執(zhí)行失敗。用例會正常執(zhí)行，只是失敗時不再顯示堆棧信息，最終的結(jié)果有兩個：用例執(zhí)行失?。╔FAIL：符合預(yù)期的失?。⒂美龍?zhí)行成功（XPASS：不符合預(yù)期的成功）。也就是說執(zhí)行成功反倒不正確了。

import pytest
?
@pytest.mark.xfail(reason = '預(yù)期失敗')
def test_01():
 ? ?assert 1 == 2

運行結(jié)果

test_demo.py::test_01 XFAIL (預(yù)期失敗) ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? [100%]
@pytest.mark.xfail(reason = '預(yù)期失敗')
 ?  def test_01():
> ? ? ? assert 1 == 2
E ? ? ? assert 1 == 2
?
test_demo.py:5: AssertionError
?

如果斷言改成1 != 2,該用例會執(zhí)行成功，本來標(biāo)記該功能有bug，但是斷言成功了，說明斷言或者功能有問題，此時會標(biāo)記為XPASS

當(dāng)然也可以增加條件

import pytest
import sys
?
@pytest.mark.xfail(sys.version_info<(3,12), reason = '預(yù)期失敗')
def test_01():
 ? ?assert 1 != 2

如果我們想要將XPASS標(biāo)記的記為失敗，可以使用strict參數(shù)

strict為關(guān)鍵字參數(shù)，默認(rèn)值為False。當(dāng)strict=False時，如果用例執(zhí)行失敗，則結(jié)果標(biāo)記為XFAIL，表示符合預(yù)期的失敗。如果用例執(zhí)行成功，則結(jié)果標(biāo)記為XPASS，表示不符合預(yù)期的成功。當(dāng)strict=True時，如果用例執(zhí)行成功，則結(jié)果將標(biāo)記為FAILED，而不再標(biāo)記為XPASS。

也可以直接在pytest.ini文件中配置

[pytest]
xfail_strict = true

如果想要將標(biāo)記為XFAIL的用例不再執(zhí)行，包含run參數(shù)。run為關(guān)鍵字參數(shù)，默認(rèn)值為True。當(dāng)run=False時，pytest不會再執(zhí)行測試用例，而直接將結(jié)果標(biāo)記為XFAIL。

import pytest
?
@pytest.mark.xfail(reason = '預(yù)期失敗', run=False)
def test_01():
 ? ?assert 1 == 2

執(zhí)行發(fā)現(xiàn)，會帶[NOTRUN]

raises為關(guān)鍵字參數(shù)，默認(rèn)值為None?？梢灾付橐粋€異常類或者多個異常類的元組，表明我們期望用例上報指定的異常。pytest.mark.xfail()也可以接收一個raises參數(shù)，用來判斷用例是否因為一個具體的異常而導(dǎo)致失敗

xfail標(biāo)記如何失效

通過--runxfail參數(shù)讓xfail標(biāo)記失效。通過命令行選項pytest --runxfail讓xfail標(biāo)記失效，使這些用例變成正常執(zhí)行的用例，仿佛沒有被標(biāo)記過一樣。同樣，pytest.xfail()方法也將失效。

@pytest.mark.parametrize

參數(shù)化內(nèi)容比較多，準(zhǔn)備專門寫一篇來介紹。

自定義標(biāo)記

標(biāo)記用例，在命令行通過-m運行指定標(biāo)記的用例

test_demo.py

import pytest
?
@pytest.mark.p0
def test_01():
 ? ?assert 1 != 2
?
?
@pytest.mark.p1
def test_02():
 ? ?assert 1 != 2

運行所有：pytest -v test_demo.py

運行p0：pytest -v -m 'p0' test_demo.py

運行p0/p1：pytest -v -m 'p0 and p1' test_demo.py

執(zhí)行后，會發(fā)現(xiàn)有警告信息PytestUnknownMarkWarning，你可以忽略。想要解決的話，也可以在配置文件中配置自定義的標(biāo)記，配置后警告信息會消失。

pytest.ini

[pytest]
markers =
 ? ?p0: 冒煙
 ? ?p1: 功能

再次執(zhí)行，會發(fā)現(xiàn)已經(jīng)沒有警告信息了。

當(dāng)然也可以像這樣反向運行，運行不是p0的測試用例：pytest -v -m 'not p0' test_demo.py

自定義標(biāo)記可以通過 pytest_configure(config)鉤子 函數(shù)在配置階段添加。下面是一個自定義標(biāo)記的例子：

def pytest_configure(config):
 ? ?config.addinivalue_line(
 ? ? ? ?'markers',
 ? ? ? ?'repeat(n): run the given test function `n` times.')
?

在上面的例子中，我們定義了一個自定義標(biāo)記 repeat，并將其添加到 pytest_configure() 函數(shù)中。然后，我們可以在測試函數(shù)上使用 @pytest.mark.repeat 標(biāo)記來標(biāo)記需要重復(fù)執(zhí)行的測試用例。

最后

通過使用標(biāo)記，我們可以更靈活地控制測試的行為，并根據(jù)需要對不同類型的測試進行分類、過濾和定制化處理。

以上就是深入了解Python中Pytest Markers的使用方法的詳細(xì)內(nèi)容，更多關(guān)于Python Pytest Markers使用的資料請關(guān)注腳本之家其它相關(guān)文章！

最新評論