目錄 | 上一節 (7.5 裝飾方法 | 下一節 (8.2 日誌)
8.1 測試
多測試，少除錯（Testing Rocks, Debugging Sucks）
Python 的動態性質使得測試對大多數程式而言至關重要。編譯器不會發現你的 bug，發現 bug 的唯一方式是執行程式碼，並確保嘗試了所有的特性。
斷言（Assertions）
assert 語句用於程式的內部檢查。如果表示式不為真，則會觸發 AssertionError 異常。
assert 語句語法：
assert <expression> [, 'Diagnostic message']
示例：
assert isinstance(10, int), 'Expected int'
assert 語句不應用於檢查使用者的輸入（例如，在網頁表單輸入的資料）。 assert 語句旨在用於內部檢查或者用於不變數（invariant，始終為 True 的條件）。
契約式程式設計
契約式程式設計（contract programming）也稱為契約式設計（Design By Contract），自由使用斷言是一種軟體設計方法。契約式程式設計規定軟體設計人員應該為軟體元件定義精確的介面規範。
例如，你可以在所有的函式輸入中使用斷言：
def add(x, y):
assert isinstance(x, int), 'Expected int'
assert isinstance(y, int), 'Expected int'
return x + y
如果函式呼叫者沒有使用正確的引數，那麼檢查輸入可以立即捕捉到。
>>> add(2, 3)
5
>>> add('2', '3')
Traceback (most recent call last):
...
AssertionError: Expected int
>>>
內聯測試
斷言也可以用於簡單的測試。
def add(x, y):
return x + y
assert add(2,2) == 4
這樣，你就可以將測試與程式碼包含在同一模組中。
好處：如果程式碼明顯被破壞，那麼嘗試匯入模組將會導致程式崩潰。
對於詳盡的測試，不推薦這樣做。這種做法更像是基本的“冒煙測試（smoke test）”。函式是否可以在所有的用例上正常工作？如果不可以，那麼肯定是有問題的。
unittest 模組
假設你有下面這樣一段程式碼：
# simple.py
def add(x, y):
return x + y
現在，你想對這些程式碼進行測試，請建立一個單獨的測試檔案，如下所示：
# test_simple.py
import simple
import unittest
然後定義一個測試類：
# test_simple.py
import simple
import unittest
# Notice that it inherits from unittest.TestCase
class TestAdd(unittest.TestCase):
...
測試類必須繼承自unittest.TestCase。
在測試類中，定義測試方法：
# test_simple.py
import simple
import unittest
# Notice that it inherits from unittest.TestCase
class TestAdd(unittest.TestCase):
def test_simple(self):
# Test with simple integer arguments
r = simple.add(2, 2)
self.assertEqual(r, 5)
def test_str(self):
# Test with strings
r = simple.add('hello', 'world')
self.assertEqual(r, 'helloworld')
重要提示：每個方法的名稱必須以 test 開頭。
使用 unittest
unittest 中內建了一些斷言，每種斷言對不同的事情進行診斷。
# Assert that expr is True
self.assertTrue(expr)
# Assert that x == y
self.assertEqual(x,y)
# Assert that x != y
self.assertNotEqual(x,y)
# Assert that x is near y
self.assertAlmostEqual(x,y,places)
# Assert that callable(arg1,arg2,...) raises exc
self.assertRaises(exc, callable, arg1, arg2, ...)
上述列表並不是一個完整的列表，unittest 模組還有其它斷言。
執行 unittest
要執行測試，請把程式碼轉換為指令碼。
# test_simple.py
...
if __name__ == '__main__':
unittest.main()
然後使用 Python 執行測試檔案：
bash % python3 test_simple.py
F.
========================================================
FAIL: test_simple (__main__.TestAdd)
--------------------------------------------------------
Traceback (most recent call last):
File "testsimple.py", line 8, in test_simple
self.assertEqual(r, 5)
AssertionError: 4 != 5
--------------------------------------------------------
Ran 2 tests in 0.000s
FAILED (failures=1)
說明
高效的單元測試是一種藝術。對於大型應用而言，單元測試可能會變得非常複雜。
unittest 模組具有大量與測試執行器（test runners），測試結果集（collection of results）以及測試其他方面相關的選項。相關詳細資訊，請查閱文件。
第三方測試工具
雖然內建 unittest 模組的優勢是可以隨處使用——因為它是 Python 的一部分，但是許多程式設計師也覺得 unittest 非常繁瑣。另一個流行的的測試工具是 pytest。使用 pytest，測試檔案可以簡化為以下形式：
# test_simple.py
import simple
def test_simple():
assert simple.add(2,2) == 4
def test_str():
assert simple.add('hello','world') == 'helloworld'
要執行測試，只需要輸入一個命令即可，例如：python -m pytest 。它將會發現所有的測試並執行這些測試。
除了這個示例之外，pytest 還有很多內容。如果你決定嘗試一下，通常很容易上手。
練習
在本次練習中，我們將探索使用 Python unittest 模組的基本機制（mechanics）。
在前面的練習中，我們編寫了一個包含 Stock 類的 stock.py 檔案。對於本次練習，假設我們使用的是 練習7.9 中編寫的與型別化屬性相關的程式碼（譯註：typedproperty.py）。如果因為某些原因，練習 7.9 的程式碼無法正常工作，你可以從 Solutions/7_9 中複製 typedproperty.py 到工作目錄中。
練習 8.1：編寫單元測試
請建立一個單獨的 test_stock.py 檔案，為 Stock 編寫單元測試集。為了讓你入門，這裡有一小段測試例項建立的程式碼：
# test_stock.py
import unittest
import stock
class TestStock(unittest.TestCase):
def test_create(self):
s = stock.Stock('GOOG', 100, 490.1)
self.assertEqual(s.name, 'GOOG')
self.assertEqual(s.shares, 100)
self.assertEqual(s.price, 490.1)
if __name__ == '__main__':
unittest.main()
執行單元測試，你應該可以獲得一些像下面這有的輸出：
.
----------------------------------------------------------------------
Ran 1 tests in 0.000s
OK
然後，編寫其它單元測試來檢查以下各項內容：
- 確保
s.cost屬性返回正確的值（49010.0）。 - 確保
s.sell()方法正常工作。它應該相應地減小s.shares。 - 確保
s.shares屬性只能設定為整數值。
對於最後一部分，你需要檢查異常的觸發。要做到這些，一種簡單的方法是使用如下程式碼：
class TestStock(unittest.TestCase):
...
def test_bad_shares(self):
s = stock.Stock('GOOG', 100, 490.1)
with self.assertRaises(TypeError):
s.shares = '100'