閱讀818 返回首頁    go 阿裏雲 go 技術社區[雲棲]


Python 單元測試:assertTrue 是真值,assertFalse 是假值

在這篇文章中,我們將介紹單元測試的布爾斷言方法 assertTrue 和 assertFalse 與身份斷言 assertIs 之間的區別。

定義

下麵是目前單元測試模塊文檔中關於 assertTrue 和 assertFalse 的說明,代碼進行了高亮:

assertTrue(expr, msg=None)

assertFalse(expr, msg=None)

測試該表達式是真值(或假值)。

注:這等價於

bool(expr) is True

而不等價於

expr is True

(後一種情況請使用 assertIs(expr, True))。

Mozilla 開發者網絡中定義 真值 如下:

在一個布爾值的上下文環境中能變成“真”的值

在 Python 中等價於:


  1. bool(expr) is True

這個和 assertTrue 的測試目的完全匹配。

因此該文檔中已經指出 assertTrue 返回真值,assertFalse 返回假值。這些斷言方法從接受到的值構造出一個布爾值,然後判斷它。同樣文檔中也建議我們根本不應該使用 assertTrue 和 assertFalse

在實踐中怎麼理解?

我們使用一個非常簡單的例子 - 一個名稱為 always_true 的函數,它返回 True。我們為它寫一些測試用例,然後改變代碼,看看測試用例的表現。

作為開始,我們先寫兩個測試用例。一個是“寬鬆的”:使用 assertTrue 來測試真值。另外一個是“嚴格的”:使用文檔中建議的 assertIs 函數。


  1. import unittest
  2. from func import always_true
  3. class TestAlwaysTrue(unittest.TestCase):
  4. def test_assertTrue(self):
  5. """
  6. always_true returns a truthy value
  7. """
  8. result = always_true()
  9. self.assertTrue(result)
  10. def test_assertIs(self):
  11. """
  12. always_true returns True
  13. """
  14. result = always_true()
  15. self.assertIs(result, True)

下麵是 func.py 中的非常簡單的函數代碼:


  1. def always_true():
  2. """
  3. I'm always True.
  4. Returns:
  5. bool: True
  6. """
  7. return True

當你運行時,所有測試都通過了:


  1. always_true returns True ... ok
  2. always_true returns a truthy value ... ok
  3. ----------------------------------------------------------------------
  4. Ran 2 tests in 0.004s
  5. OK

開心ing~

現在,某個人將 always_true 函數改變成下麵這樣:


  1. def always_true():
  2. """
  3. I'm always True.
  4. Returns:
  5. bool: True
  6. """
  7. return 'True'

它現在是用返回字符串 "True" 來替代之前反饋的 True (布爾值)。(當然,那個“某人”並沒有更新文檔 - 後麵我們會增加難度。)

這次結果並不如開心了:


  1. always_true returns True ... FAIL
  2. always_true returns a truthy value ... ok
  3. ======================================================================
  4. FAIL: always_true returns True
  5. ----------------------------------------------------------------------
  6. Traceback (most recent call last):
  7. File "/tmp/assertttt/test.py", line 22, in test_is_true
  8. self.assertIs(result, True)
  9. AssertionError: 'True' is not True
  10. ----------------------------------------------------------------------
  11. Ran 2 tests in 0.004s
  12. FAILED (failures=1)

隻有一個測試用例失敗了!這意味著 assertTrue 給了我們一個誤判false-positive。在它不應該通過測試時,它通過了。很幸運的是我們第二個測試是使用 assertIs 來寫的。

因此,跟手冊上了解到的信息一樣,為了保證 always_true 的功能和更嚴格測試的結果保持一致,應該使用assertIs 而不是 assertTrue

使用斷言的輔助方法

使用 assertIs 來測試返回 True 和 False 來冗長了。因此,如果你有個項目需要經常檢查是否是返回了True 或者 False,那們你可以自己編寫一些斷言的輔助方法。

這好像並沒有節省大量的代碼,但是我個人覺得提高了代碼的可讀性。


  1. def assertIsTrue(self, value):
  2. self.assertIs(value, True)
  3. def assertIsFalse(self, value):
  4. self.assertIs(value, False)

總結

一般來說,我的建議是讓測試越嚴格越好。如果你想測試 True 或者 False,聽從文檔的建議,使用assertIs。除非不得已,否則不要使用 assertTrue 和 assertFalse

如果你麵對的是一個可以返回多種類型的函數,例如,有時候返回布爾值,有時候返回整形,那麼考慮重構它。這是代碼的異味。在 Python 中,拋出一個異常比使用 False 表示錯誤更好。

此外,如果你確實想使用斷言來判斷函數的返回值是否是真,可能還存在第二個代碼異味 - 代碼是正確封裝了嗎?如果 assertTrue 和 assertFalse 是根據正確的 if 語句來執行,那麼值得檢查下你是否把所有你想要的東西都封裝在合適的位置。也許這些 if 語句應該封裝在測試的函數中。

測試開心!原文發布時間為:2017-10-31

本文來自雲棲社區合作夥伴“Linux中國”

最後更新:2017-06-05 14:32:22

  上一篇:go  《JavaScript開發框架權威指南》——2.7 小結
  下一篇:go  《JavaScript開發框架權威指南》——2.3 將Grunt添加到項目中