pytest文檔 - 1.安裝及入門(mén)

Pythons:python 3.5拦坠, 3.6锭魔, 3.7梁厉, PyPy3

平臺(tái):Linux和Windows

PyPI包名:pytest

PDF文檔:最新下載

pytest是一個(gè)方便構(gòu)建簡(jiǎn)單的和可擴(kuò)展的測(cè)試用例的測(cè)試框架滑废。其測(cè)試用例不再需要冗余的代碼,它們更直觀寂屏,可讀性更好慌洪。

1.1 pytest安裝

pytest安裝非常簡(jiǎn)單,只要用python自帶的安裝工具pip凑保,在命令行中執(zhí)行如下命令即可:

```python

$ pip install -U pytest

```

安裝完成之后,使用下面的命令可以查看安裝的pytest的版本信息涌攻。你可以看到你所安裝的pytest版本是否是你所需要的版本欧引。

```

$ pytest --version

This is pytest version 5.x.y, imported from $PYTHON_PREFIX/lib/python3.6/site-packages/pytest.py

```

1.2 創(chuàng)建你的第一個(gè)用例

用4行代碼寫(xiě)一個(gè)簡(jiǎn)單的測(cè)試用例

```python

# content of test_sample.py

def func(x):

??? return x + 1

def test_answer():

??? assert func(3) == 5

```

然后我們來(lái)運(yùn)行這個(gè)用例

```python

$ pytest

=========================== test session starts ============================

platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y

cachedir: $PYTHON_PREFIX/.pytest_cache

rootdir: $REGENDOC_TMPDIR

collected 1 item

test_sample.py F [100%]

================================= FAILURES =================================

_______________________________ test_answer ________________________________

def test_answer():

> assert func(3) == 5

E assert 4 == 5

E + where 4 = func(3)

test_sample.py:6: AssertionError

============================ 1 failed in 0.05s =============================

```

運(yùn)行結(jié)果會(huì)生成一個(gè)失敗的報(bào)告,因?yàn)楹苊黠@恳谎,func(3)返回的是4芝此,而不是5。

說(shuō)明:您可以使用assert語(yǔ)句來(lái)驗(yàn)證測(cè)試的預(yù)期結(jié)果因痛。pytest的高級(jí)斷言自省功能會(huì)自動(dòng)幫助您打印出assert語(yǔ)句的中間值婚苹,這樣您就可以不需要像JUnit一樣,使用大量的不同的assert語(yǔ)句鸵膏。

1.3 運(yùn)行多個(gè)用例

pytest會(huì)運(yùn)行當(dāng)前目錄以及其子目錄下的所有以test_*.py或*_test.py的文件膊升,例如:在當(dāng)前目錄下或其子目錄下有test_sampy.py或者sampy_test.py文件,pytest就可以找出這個(gè)文件谭企,并運(yùn)行這個(gè)文件里的測(cè)試用例廓译。如果想要了解更詳細(xì)的查找test的規(guī)則评肆,可以參看23.2節(jié)。

1.4 如何對(duì)拋出的異常進(jìn)行斷言

有時(shí)候程序會(huì)拋出一些異常來(lái)表示程序執(zhí)行到了某些非正常的流程非区,這時(shí)候瓜挽,我們?nèi)绾螌?shí)現(xiàn)用例來(lái)預(yù)期或斷言這些拋出的異常呢?

pytest中可以使用raises來(lái)做到這點(diǎn)征绸。

```python

# content of test_sysexit.py

import pytest

# 功能函數(shù)久橙,拋出一個(gè)SystemExit的異常

def f():

??? raise SystemExit(1)

# 測(cè)試用例,用ptest.raises期盼SystemExit異常

def test_mytest():

??? with pytest.raises(SystemExit):

???????? f()

```

以"quiet"模式運(yùn)行以上用例管怠,得到如下結(jié)果:

```python

$ pytest -q test_sysexit.py

. [100%]

1 passed in 0.01s

1.5 用類(lèi)來(lái)分組多個(gè)用例

在我們?yōu)槟硞€(gè)場(chǎng)景寫(xiě)了多個(gè)測(cè)試用例的時(shí)候淆衷,我們也許會(huì)覺(jué)得給這些測(cè)試用例分個(gè)組會(huì)更好些。用類(lèi)來(lái)進(jìn)行分組也許是一個(gè)好的選擇排惨。pytest可以很容易的建一個(gè)類(lèi)并包含多個(gè)測(cè)試用例:

```python

# content of test_class.py

class TestClass:

??? def test_one(self):

??????? x = "this"

??????? assert "h" in x

??? def test_two(self):

??????? x = "hello"

??????? assert hasattr(x, "check")

```

根據(jù)pytest用例收集規(guī)則吭敢,如下命令就可以執(zhí)行前面類(lèi)里面的兩個(gè)用例。

```python

$ pytest -q test_class.py

.F [100%]

================================= FAILURES =================================

____________________________ TestClass.test_two ____________________________

self = <test_class.TestClass object at 0xdeadbeef>

def test_two(self):

x = "hello"

> assert hasattr(x, "check")

E AssertionError: assert False

E + where False = hasattr('hello', 'check')

test_class.py:8: AssertionError

1 failed, 1 passed in 0.05s

```

第一個(gè)用例過(guò)了暮芭,但第二個(gè)失敗了鹿驼。從assert給出的中間值可以看出,我們預(yù)期的是"check"辕宏, 但實(shí)際的確是"hello"畜晰,實(shí)際與預(yù)期不符,所以失敗了瑞筐。

1.6 為測(cè)試用例申請(qǐng)一個(gè)其專(zhuān)用的臨時(shí)目錄

pytest提供了一些內(nèi)建的fixture/function參數(shù)作為測(cè)試用例專(zhuān)用的資源凄鼻,專(zhuān)用臨時(shí)目錄(tmpdir)就是其中之一 。

```python

# content of test_tmpdir.py

def test_needsfiles(tmpdir):

??? print(tmpdir)

??? assert 0

```

pytest一旦檢測(cè)到測(cè)試用例的參數(shù)列表中帶有tmpdir這個(gè)關(guān)鍵字聚假,就會(huì)去建一個(gè)相應(yīng)的專(zhuān)用目錄块蚌,并將這個(gè)目錄的路徑通過(guò)tmpdir這個(gè)參數(shù)傳給用例。當(dāng)測(cè)試用例執(zhí)行完之后膘格,這個(gè)目錄就會(huì)被刪除峭范。

```python

$ pytest -q test_tmpdir.py

F [100%]

================================= FAILURES =================================

_____________________________ test_needsfiles ______________________________

tmpdir = local('PYTEST_TMPDIR/test_needsfiles0')

def test_needsfiles(tmpdir):

print(tmpdir)

> assert 0

E assert 0

test_tmpdir.py:3: AssertionError

--------------------------- Captured stdout call ---------------------------

PYTEST_TMPDIR/test_needsfiles0

1 failed in 0.05s

```

想要對(duì)tmpdir有更多的了解,可以參看《第8章 臨時(shí)目錄和文件》瘪贱。

下面這條命令可以查看pytest所有的內(nèi)置的固有(fixtures)參數(shù):

```python

pytest --fixtures # shows builtin and custom fixtures

```

如果想要查看下劃線(xiàn)(_)開(kāi)頭的fixtures參數(shù)纱控,需要在上面命令后面加上-v。


附一:pytest用例收集規(guī)則


1. 如果沒(méi)有指定文件菜秦,pytest會(huì)從當(dāng)前目錄及其子目錄收集所有的test_*.py或*_test.py文件甜害;

2. 如果指定文件,pytest從指定文件中去收集用例球昨,文件名的格式需要遵循test_*.py或*_test.py尔店;

3. 類(lèi)名需要以Test作為前綴;

4. 用例名需要以test_作為前綴。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末闹获,一起剝皮案震驚了整個(gè)濱河市期犬,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌避诽,老刑警劉巖龟虎,帶你破解...
    沈念sama閱讀 217,406評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異沙庐,居然都是意外死亡鲤妥,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,732評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門(mén)拱雏,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)棉安,“玉大人,你說(shuō)我怎么就攤上這事铸抑」钡ⅲ” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 163,711評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵鹊汛,是天一觀的道長(zhǎng)蒲赂。 經(jīng)常有香客問(wèn)我,道長(zhǎng)刁憋,這世上最難降的妖魔是什么滥嘴? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,380評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮至耻,結(jié)果婚禮上若皱,老公的妹妹穿的比我還像新娘。我一直安慰自己尘颓,他們只是感情好走触,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,432評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著疤苹,像睡著了一般互广。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上痰催,一...
    開(kāi)封第一講書(shū)人閱讀 51,301評(píng)論 1 301
  • 那天,我揣著相機(jī)與錄音迎瞧,去河邊找鬼夸溶。 笑死,一個(gè)胖子當(dāng)著我的面吹牛凶硅,可吹牛的內(nèi)容都是我干的缝裁。 我是一名探鬼主播,決...
    沈念sama閱讀 40,145評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼捷绑!你這毒婦竟也來(lái)了韩脑?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,008評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤粹污,失蹤者是張志新(化名)和其女友劉穎段多,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體壮吩,經(jīng)...
    沈念sama閱讀 45,443評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡进苍,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,649評(píng)論 3 334
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了鸭叙。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片觉啊。...
    茶點(diǎn)故事閱讀 39,795評(píng)論 1 347
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖沈贝,靈堂內(nèi)的尸體忽然破棺而出杠人,到底是詐尸還是另有隱情,我是刑警寧澤宋下,帶...
    沈念sama閱讀 35,501評(píng)論 5 345
  • 正文 年R本政府宣布嗡善,位于F島的核電站,受9級(jí)特大地震影響杨凑,放射性物質(zhì)發(fā)生泄漏滤奈。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,119評(píng)論 3 328
  • 文/蒙蒙 一撩满、第九天 我趴在偏房一處隱蔽的房頂上張望蜒程。 院中可真熱鬧,春花似錦伺帘、人聲如沸昭躺。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,731評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)领炫。三九已至,卻和暖如春张咳,著一層夾襖步出監(jiān)牢的瞬間帝洪,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,865評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工脚猾, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留葱峡,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,899評(píng)論 2 370
  • 正文 我出身青樓龙助,卻偏偏與公主長(zhǎng)得像砰奕,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,724評(píng)論 2 354