Python中的測試工具

  當咱們在寫程序的時候，咱們須要經過測試來驗證程序是否出錯或者存在問題，可是，編寫大量的測試來確保程序的每一個細節都沒問題會顯得很繁瑣。在Python中，咱們能夠藉助一些標準模塊來幫助咱們自動完成測試過程，好比：

• unittest: 一個通用的測試框架；
• doctest: 一個更簡單的模塊，是爲檢查文檔而設計的，但也很是適合用來編寫單元測試。

  下面，筆者將會簡單介紹這兩個模塊在測試中的應用。

doctest

  doctest模塊會搜索那些看起來像是python交互式會話中的代碼片斷，而後嘗試執行並驗證結果。下面咱們以doctest.testmod爲例，函數doctest.testmod會讀取模塊中的全部文檔字符串，查找看起來像是從交互式解釋器中摘取的示例，再檢查這些示例是否反映了實際狀況。
  咱們先建立示例代碼文件test_string_lower.py，完整代碼以下：

# -*- coding: utf-8 -*-

def string_lower(string):
    '''
    返回一個字符串的小寫
    :param string: type: str
    :return: the lower of input string
    >>> string_lower('AbC')
    'abc'
    >>> string_lower('ABC')
    'abc'
    >>> string_lower('abc')
    'abc'
    '''
    return string.lower()

if __name__ == '__main__':
    import doctest, test_string_lower
    doctest.testmod(test_string_lower)

首先先對程序進行說明，函數string_lower用於返回輸入字符串的小寫，函數中的註釋中，一共包含了3個測試實例，指望儘量地包含各類測試狀況，接着在主函數中導入doctest, test_string_lower，再運行doctest中的testmod函數便可進行測試。
  接着，咱們開始測試。首先，在命令行中輸入python test_string_lower.py，運行後會發現什麼都沒有輸出，但這實際上是件好事，它代表程序中的全部測試都經過了！那麼，若是咱們想要得到更多的輸出呢？可在運行腳本的時候增長參數-v，這時候命令變成python test_string_lower.py -v，輸出的結果以下：

Trying:
    string_lower('AbC')
Expecting:
    'abc'
ok
Trying:
    string_lower('ABC')
Expecting:
    'abc'
ok
Trying:
    string_lower('abc')
Expecting:
    'abc'
ok
1 items had no tests:
    test_string_lower
1 items passed all tests:
   3 tests in test_string_lower.string_lower
3 tests in 2 items.
3 passed and 0 failed.
Test passed.

能夠看到，程序測試的背後仍是發生了不少事。接着，咱們嘗試着程序出錯的狀況，好比咱們不當心把函數的返回寫成了：

return string.upper()

這實際上是返回輸入字符串的大寫了，而咱們測試的實例卻返回了輸入字符串的小寫，再運行該腳本（加上參數-v），輸出的結果以下：

Failed example:
    string_lower('abc')
Expected:
    'abc'
Got:
    'ABC'
1 items had no tests:
    test_string_lower
**********************************************************************
1 items had failures:
   3 of   3 in test_string_lower.string_lower
3 tests in 2 items.
0 passed and 3 failed.
***Test Failed*** 3 failures.

這時候，程序測試失敗，它不只捕捉到了bug，還清楚地指出錯誤出在什麼地方。咱們不難把這個程序修改過來。
  關於doctest模塊的更詳細的使用說明，能夠參考網址：https://docs.python.org/2/lib... 。

unittest

   unittest相似於流行的Java測試框架JUnit，它比doctest更靈活，更強大，可以幫助你以結構化的方式來編寫龐大而詳盡的測試集。
  咱們以一個簡單的示例入手，首先咱們編寫my_math.py腳本，代碼以下：

# -*- coding: utf-8 -*-
def product(x, y):
    '''
    :param x: int, float
    :param y: int, float
    :return:  x * y
    '''
    return x * y

該函數實現的功能爲：輸入兩個數x, y， 返回這兩個數的乘積。接着是test_my_math.py腳本，完整的代碼以下：

import unittest, my_math

class ProductTestcase(unittest.TestCase):

    def setUp(self):
        print('begin test')

    def test_integers(self):
        for x in range(-10, 10):
            for y in range(-10, 10):
                p = my_math.product(x, y)
                self.assertEqual(p, x*y, 'integer multiplication failed')

    def test_floats(self):
        for x in range(-10, 10):
            for y in range(-10, 10):
                x = x/10
                y = y/10
                p = my_math.product(x, y)
                self.assertEqual(p, x * y, 'integer multiplication failed')

if __name__ == '__main__':
    unittest.main()

函數unittest.main負責替你運行測試：在測試方法前執行setUp方法，示例化全部的TestCase子類，並運行全部名稱以test打頭的方法。assertEqual方法檢車指定的條件（這裏是相等），以判斷指定的測試是成功了仍是失敗了。
  接着，咱們運行前面的測試，輸出的結果以下：

begin test
.begin test
.
----------------------------------------------------------------------
Ran 2 tests in 0.001s

OK

能夠看到，該程序運行了兩個測試，每一個測試前都會輸出'begin test'，.表示測試成功，若測試失敗，則返回的是F。
  接着模擬測試出錯的情形，將my_math函數中的product方法改爲返回：

return x + y

再運行測試腳本，輸出的結果以下：

begin test
Fbegin test
F
======================================================================
FAIL: test_floats (__main__.ProductTestcase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "test_my_math.py", line 20, in test_floats
    self.assertEqual(p, x * y, 'integer multiplication failed')
AssertionError: -2.0 != 1.0 : integer multiplication failed

======================================================================
FAIL: test_integers (__main__.ProductTestcase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "test_my_math.py", line 12, in test_integers
    self.assertEqual(p, x*y, 'integer multiplication failed')
AssertionError: -20 != 100 : integer multiplication failed

----------------------------------------------------------------------
Ran 2 tests in 0.001s

FAILED (failures=2)

兩條測試都未經過，返回的是F，並幫助你指出了錯誤的地方，接下來，你應該能快速地修復這個bug。
  關於unittest模塊的更加詳細的說明，能夠參考網址： https://docs.python.org/3/lib... 。

總結

  本文介紹了兩個Python中的測試工具： doctest和unittest，並配以簡單的例子來講明這兩個測試模塊的使用方法，但願能對讀者有所幫助～

注意：不妨瞭解下筆者的微信公衆號： Python爬蟲與算法（微信號爲：easy_web_scrape）， 歡迎你們關注~