Pytest官方教程-11-模塊及測試文件中集成doctest測試

目錄:

  1. 安裝及入門
  2. 使用和調(diào)用方法
  3. 原有TestSuite使用方法
  4. 斷言的編寫和報(bào)告
  5. Pytest fixtures:清晰 模塊化 易擴(kuò)展
  6. 使用Marks標(biāo)記測試用例
  7. Monkeypatching/對(duì)模塊和環(huán)境進(jìn)行Mock
  8. 使用tmp目錄和文件
  9. 捕獲stdout及stderr輸出
  10. 捕獲警告信息
  11. 模塊及測試文件中集成doctest測試
  12. skip及xfail: 處理不能成功的測試用例
  13. Fixture方法及測試用例的參數(shù)化
  14. 緩存: 使用跨執(zhí)行狀態(tài)
  15. unittest.TestCase支持
  16. 運(yùn)行Nose用例
  17. 經(jīng)典xUnit風(fēng)格的setup/teardown
  18. 安裝和使用插件
  19. 插件編寫
  20. 編寫鉤子(hook)方法
  21. 運(yùn)行日志
  22. API參考
    1. 方法(Functions)
    2. 標(biāo)記(Marks)
    3. 鉤子(Hooks)
    4. 裝置(Fixtures)
    5. 對(duì)象(Objects)
    6. 特殊變量(Special Variables)
    7. 環(huán)境變量(Environment Variables)
    8. 配置選項(xiàng)(Configuration Options)
  23. 優(yōu)質(zhì)集成實(shí)踐
  24. 片狀測試
  25. Pytest導(dǎo)入機(jī)制及sys.path/PYTHONPATH
  26. 配置選項(xiàng)
  27. 示例及自定義技巧
  28. Bash自動(dòng)補(bǔ)全設(shè)置

模塊及測試文件中集成doctest測試

默認(rèn)情況下,Pytest按照python doctest模塊標(biāo)準(zhǔn)test*.txt模式進(jìn)行匹配。你也可以通過使用以下命令更改匹配模式:

pytest --doctest-glob='*.rst'

在命令行上。從版本開始2.9--doctest-glob 可以在命令行中多次使用。

3.1版中的新增功能:您可以使用doctest_encodingini選項(xiàng)指定將用于這些doctest文件的編碼:

# content of pytest.ini
[pytest]
doctest_encoding = latin1

默認(rèn)編碼為UTF-8。

您還可以在所有python模塊(包括常規(guī)python測試模塊)中從docstrings觸發(fā)doctests的運(yùn)行:

pytest --doctest-modules

您可以將這些更改永久保存在項(xiàng)目中,方法是將它們放入pytest.ini文件中,如下所示:

# content of pytest.ini
[pytest]
addopts = --doctest-modules

如果你有一個(gè)這樣的文本文件:

# content of example.rst

hello this is a doctest
>>> x = 3
>>> x
3

和另一個(gè)這樣的:

# content of mymodule.py
def something():
    """ a doctest in a docstring
 >>> something()
 42
 """
    return 42

那么你可以在pytest沒有命令行選項(xiàng)的情況下調(diào)用:

$ pytest
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
cachedir: $PYTHON_PREFIX/.pytest_cache
rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
collected 1 item

mymodule.py .                                                        [100%]

========================= 1 passed in 0.12 seconds =========================

可以使用getfixture幫助器使用Fixture方法:

# content of example.rst
>>> tmp = getfixture('tmpdir')
>>> ...
>>>

此外,在執(zhí)行文本doctest文件時(shí),支持使用類,模塊或項(xiàng)目中的FixtureAutouse Fixture(類上的xUnit設(shè)置)Fixture。

標(biāo)準(zhǔn)doctest模塊提供了一些設(shè)置標(biāo)志來配置doctest測試的嚴(yán)格性。在pytest中,您可以使用配置文件啟用這些標(biāo)志。要使pytest忽略尾隨空格并忽略冗長的異常堆棧跟蹤,您只需編寫:

[pytest]
doctest_optionflags= NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL

pytest還引入了新的選項(xiàng),允許doctests在Python 2和Python 3中運(yùn)行不變:

  • ALLOW_UNICODE:啟用時(shí),u前綴將從預(yù)期doctest輸出中的unicode字符串中刪除。
  • ALLOW_BYTES:啟用時(shí),b前綴將從預(yù)期doctest輸出中的字節(jié)字符串中刪除。

與任何其他選項(xiàng)標(biāo)志一樣,可以pytest.ini使用doctest_optionflagsini選項(xiàng)啟用這些標(biāo)志:

[pytest]
doctest_optionflags = ALLOW_UNICODE ALLOW_BYTES

或者,可以通過doc測試本身中的內(nèi)聯(lián)注釋啟用它:

# content of example.rst
>>> get_unicode_greeting()  # doctest: +ALLOW_UNICODE
'Hello'

默認(rèn)情況下,pytest僅報(bào)告給定doctest的第一次失敗。如果您想在即使遇到故障時(shí)繼續(xù)測試,請(qǐng)執(zhí)行以下操作:

pytest --doctest-modules --doctest-continue-on-failure

'doctest_namespace' Fixture方法

3.0版中的新功能。

doctest_namespace Fixture方法可用于注入到項(xiàng)目中,你的文檔測試運(yùn)行的命名空間。它旨在用于您自己的燈具中,以提供將它們與上下文一起使用的測試。

doctest_namespace是一個(gè)標(biāo)準(zhǔn)dict對(duì)象,您可以將要放置在doctest命名空間中的對(duì)象放入其中:

# content of conftest.py
import numpy
@pytest.fixture(autouse=True)
def add_np(doctest_namespace):
    doctest_namespace['np'] = numpy

然后可以直接在你的doctests中使用它:

# content of numpy.py
def arange():
    """
 >>> a = np.arange(10)
 >>> len(a)
 10
 """
    pass

請(qǐng)注意,與正常情況一樣conftest.py,在conftest所在的目錄樹中發(fā)現(xiàn)了fixture。意味著如果將doctest與源代碼放在一起,則相關(guān)的conftest.py需要位于同一目錄下。在同級(jí)目錄樹中不會(huì)發(fā)現(xiàn)Fixtures!

輸出格式

3.0版中的新功能。

您可以通過使用選項(xiàng)標(biāo)準(zhǔn)文檔測試模塊格式的一個(gè)更改失敗您的文檔測試diff的輸出格式(見doctest.REPORT_UDIFFdoctest.REPORT_CDIFFdoctest.REPORT_NDIFFdoctest.REPORT_ONLY_FIRST_FAILURE):

pytest --doctest-modules --doctest-report none
pytest --doctest-modules --doctest-report udiff
pytest --doctest-modules --doctest-report cdiff
pytest --doctest-modules --doctest-report ndiff
pytest --doctest-modules --doctest-report only_first_failure```
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,001評(píng)論 6 537
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,786評(píng)論 3 423
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,986評(píng)論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,204評(píng)論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,964評(píng)論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,354評(píng)論 1 324
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,410評(píng)論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,554評(píng)論 0 289
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,106評(píng)論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,918評(píng)論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,093評(píng)論 1 371
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,648評(píng)論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,342評(píng)論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,755評(píng)論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,009評(píng)論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,839評(píng)論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,107評(píng)論 2 375

推薦閱讀更多精彩內(nèi)容