快捷導(dǎo)航

Python單元測(cè)試模塊doctest的具體使用

更新時(shí)間：2020年02月10日 11:22:26 作者：MarsenSeven

這篇文章主要介紹了Python單元測(cè)試模塊doctest的具體使用，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

開發(fā)高質(zhì)量軟件的過(guò)程中，我們經(jīng)常會(huì)為每個(gè)函數(shù)編寫測(cè)試，這樣在開發(fā)過(guò)程中運(yùn)行這些測(cè)試的時(shí)候就比較方便，doctest是一個(gè)python標(biāo)準(zhǔn)庫(kù)自帶的輕量單元測(cè)試工具，適合實(shí)現(xiàn)一些簡(jiǎn)單的單元測(cè)試。

doctest模塊提供的這樣的工具，用于掃描模塊并驗(yàn)證程序文檔字符串中嵌入的測(cè)試，在docstring中尋找到測(cè)試用例并執(zhí)行，比較輸出結(jié)果與期望值是否符合。

我們?nèi)绾螛?gòu)造這些測(cè)試呢？很簡(jiǎn)單

在python的交互解釋器中創(chuàng)建測(cè)試用例，并復(fù)制到docstring中

tip:doctest在docstring中尋找測(cè)試用例的時(shí)候，認(rèn)為>>>是一個(gè)測(cè)試用例的開始，直到遇到空行或者下一個(gè)>>>，在兩個(gè)測(cè)試用例之間有其他內(nèi)容的話，會(huì)被doctest忽略（可以利用這個(gè)特性為測(cè)試用例編寫一些注釋）。

我先在我自己的項(xiàng)目下準(zhǔn)備一個(gè)測(cè)試腳本quality_q.py：

def average(values):
  """Computes the arithmetic mean of a list of numbers.

  >>> print(average([20, 30, 70]))
  40.0
  """
  return sum(values) / len(values)


#
if __name__ == '__main__':
  import doctest
  doctest.testmod(verbose=True) # automatically validate the embedded tests
  # 那個(gè)verbose參數(shù)，如果設(shè)置為True則在執(zhí)行測(cè)試的時(shí)候會(huì)輸出詳細(xì)信息。
  # 默認(rèn)是False，表示運(yùn)行測(cè)試時(shí)，只有失敗的用例會(huì)輸出詳細(xì)信息，成功的測(cè)試用例不會(huì)輸入任何信息。

啟動(dòng)測(cè)試的方法：

第一個(gè)是在__main__函數(shù)中調(diào)用了doctest.testmod()方法。
然后在交互解釋器中執(zhí)行運(yùn)行腳本 python3 doctest_q.py

如果__main__函數(shù)有其他用途，不方便調(diào)用doctest.testmod()方法，那么可以用另外一種執(zhí)行測(cè)試的方法：

在交互解釋器中執(zhí)行如下命令執(zhí)行測(cè)試： python3 -m doctest doctest_q.py -v
這里 -m 表示引用一個(gè)模塊，-v 等價(jià)于 verbose=True

因?yàn)槲沂窃赑ycharm中創(chuàng)建的文件，我就直接打開Pycharm的Terminal，然后在交互解釋器中切換一下腳本目錄，執(zhí)行的上面說(shuō)到的啟動(dòng)方式，（順便復(fù)習(xí)一下os模塊的常用操作）
ps:讀者在測(cè)試自己的例子時(shí)只需注意一下自己的當(dāng)前工作目錄即可

看一下最后的結(jié)果：

➜ ForF python3
Python 3.7.3 (default, Mar 27 2019, 09:23:15)
[Clang 10.0.1 (clang-1001.0.46.3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.

>>> import os

>>> os.getcwd()
'/Users/dengjiguang/PycharmProjects/ForF'
>>> os.chdir('/Users/dengjiguang/PycharmProjects/ForF'+'/python_sample/quality_control')

>>> os.system('python3 -m doctest doctest_q.py -v')
Trying:
  print(average([20, 30, 70]))
Expecting:
  40.0
ok
1 items had no tests:
  doctest_q
1 items passed all tests:
  1 tests in doctest_q.average
1 tests in 2 items.
1 passed and 0 failed.
Test passed.
0
>>>

os.getcwd()：返回當(dāng)前的工作目錄
os.chdir(‘path')：切換工作目錄
os.system(‘command'): 執(zhí)行系統(tǒng)shell命令

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: