Python中斷言Assertion的一些改進方案

更新時間：2016年10月27日 14:44:46 作者：Toby Qin

python中的斷言Assertion使用起來很方便，但是也不盡如人意的地方，所以這篇文章通過幾個方面對Python中的斷言進行了改進，感興趣的朋友們可以參考借鑒，下面來一起看看吧。

Python Assert 為何不盡如人意?

Python中的斷言用起來非常簡單，你可以在assert后面跟上任意判斷條件，如果斷言失敗則會拋出異常。

>>> assert 1 + 1 == 2
>>> assert isinstance('Hello', str)
>>> assert isinstance('Hello', int)

Traceback (most recent call last):
 File "<input>", line 1, in <module>
AssertionError

其實assert看上去不錯，然而用起來并不爽。就比如有人告訴你程序錯了，但是不告訴哪里錯了。很多時候這樣的assert還不如不寫，寫了我就想罵娘。直接拋一個異常來得更痛快一些。

改進方案 #1

一個稍微改進一丟丟的方案就是把必要的信息也放到assert語句后面，比如這樣。

>>> s = "nothin is impossible."
>>> key = "nothing"
>>> assert key in s, "Key: '{}' is not in Target: '{}'".format(key, s)

Traceback (most recent call last):
 File "<input>", line 1, in <module>
AssertionError: Key: 'nothing' is not in Target: 'nothin is impossible.'

看上去還行吧，但是其實寫的很蛋疼。假如你是一名測試汪，有成千上萬的測試案例需要做斷言做驗證，相信你面對以上做法，心中一定有千萬只那種馬奔騰而過。

改進方案 #2

不管你是你是搞測試還是開發(fā)的，想必聽過不少測試框架。你猜到我要說什么了吧？對，不用測試框架里的斷言機制，你是不是灑。

py.test

py.test 是一個輕量級的測試框架，所以它壓根就沒寫自己的斷言系統，但是它對Python自帶的斷言做了強化處理，如果斷言失敗，那么框架本身會盡可能多地提供斷言失敗的原因。那么也就意味著，用py.test實現測試，你一行代碼都不用改。

import pytest

def test_case():
  expected = "Hello"
  actual = "hello"
  assert expected == actual

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

"""
================================== FAILURES ===================================
__________________________________ test_case __________________________________

  def test_case():
    expected = "Hello"
    actual = "hello"
>    assert expected == actual
E    assert 'Hello' == 'hello'
E     - Hello
E     ? ^
E     + hello
E     ? ^

assertion_in_python.py:7: AssertionError
========================== 1 failed in 0.05 seconds ===========================
""""

unittest

Python自帶的unittest單元測試框架就有了自己的斷言方法self.assertXXX() ，而且不推薦使用assert XXX語句。

import unittest

class TestStringMethods(unittest.TestCase):

  def test_upper(self):
    self.assertEqual('foo'.upper(), 'FoO')

if __name__ == '__main__':
  unittest.main()
  
"""
Failure
Expected :'FOO'
Actual  :'FoO'

Traceback (most recent call last):
 File "assertion_in_python.py", line 6, in test_upper
  self.assertEqual('foo'.upper(), 'FoO')
AssertionError: 'FOO' != 'FoO'
"""

ptest

我非常喜歡ptest，感謝Karl大神寫了這么一個測試框架。ptest中的斷言可讀性很好，而且通過IDE的智能提示你能輕松完成各種斷言語句。

from ptest.decorator import *
from ptest.assertion import *

@TestClass()
class TestCases:
  @Test()
  def test1(self):
    actual = 'foo'
    expected = 'bar'
    assert_that(expected).is_equal_to(actual)

"""
Start to run following 1 tests:
------------------------------
...
[demo.assertion_in_python.TestCases.test1@Test] Failed with following message:
...
AssertionError: Unexpectedly that the str <bar> is not equal to str <foo>.
"""

改進方案 #3

不僅僅是你和我對Python中的斷言表示不滿足，所以大家都爭相發(fā)明自己的assert包。在這里我強烈推薦assertpy 這個包，它異常強大而且好評如潮。

pip install assertpy

看例子:

from assertpy import assert_that

def test_something():
  assert_that(1 + 2).is_equal_to(3)
  assert_that('foobar')\
    .is_length(6)\
    .starts_with('foo')\
    .ends_with('bar')
  assert_that(['a', 'b', 'c'])\
    .contains('a')\
    .does_not_contain('x')

從它的主頁文檔上你會發(fā)現它支持了幾乎你能想到的所有測試場景，包括但不限于以下列表。

Strings

Numbers

Lists

Tuples

Dicts

Sets

Booleans

Dates

Files

Objects

而且它的斷言信息簡潔明了，不多不少。

Expected <foo> to be of length <4>, but was <3>.
Expected <foo> to be empty string, but was not.
Expected <False>, but was not.
Expected <foo> to contain only digits, but did not.
Expected <123> to contain only alphabetic chars, but did not.
Expected <foo> to contain only uppercase chars, but did not.
Expected <FOO> to contain only lowercase chars, but did not.
Expected <foo> to be equal to <bar>, but was not.
Expected <foo> to be not equal to <foo>, but was.
Expected <foo> to be case-insensitive equal to <BAR>, but was not.

在發(fā)現assertpy之前我也想寫一個類似的包，盡可能通用一些。但是現在，我為毛要重新去造輪子？完全沒必要！

總結

斷言在軟件系統中有非常重要的作用，寫的好可以讓你的系統更穩(wěn)定。Python中默認的斷言語句其實還有一個作用，如果你寫了一個類型相關的斷言，IDE會把這個對象當成這種類型，這時候智能提示就有如神助。

要不要把內置的斷言語句換成可讀性更好功能更強大的第三方斷言，完全取決于實際情況。比如你真的需要驗證某個東西并且很關心驗證結果，那么必須不能用簡單的assert；如果你只是擔心某個點可能有坑或者讓IDE認識某個對象，用內置的assert既簡單又方便。

所以說，項目經驗還是蠻重要的。以上就是本文的全部內容，希望本文的內容對大家的學習或者工作能有所幫助，如果有疑問大家可以留言交流。

您可能感興趣的文章: