Python中断言Assertion的一些改进方案


Posted in Python onOctober 27, 2016

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

不管你是你是搞测试还是开发的,想必听过不少测试框架。你猜到我要说什么了吧?对,不用测试框架里的断言机制,你是不是洒。

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中的断言表示不满足,所以大家都争相发明自己的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')

从它的主页文档上你会发现它支持了几乎你能想到的所有测试场景,包括但不限于以下列表。

      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.

在发现assertpy之前我也想写一个类似的包,尽可能通用一些。但是现在,我为毛要重新去造轮子?完全没必要!

总结

断言在软件系统中有非常重要的作用,写的好可以让你的系统更稳定。Python中默认的断言语句其实还有一个作用,如果你写了一个类型相关的断言,IDE会把这个对象当成这种类型,这时候智能提示就有如神助。

要不要把内置的断言语句换成可读性更好功能更强大的第三方断言,完全取决于实际情况。比如你真的需要验证某个东西并且很关心验证结果,那么必须不能用简单的assert;如果你只是担心某个点可能有坑或者让IDE认识某个对象,用内置的assert既简单又方便。

所以说,项目经验还是蛮重要的。以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能有所帮助,如果有疑问大家可以留言交流。

Python 相关文章推荐
PHP webshell检查工具 python实现代码
Sep 15 Python
python连接MySQL、MongoDB、Redis、memcache等数据库的方法
Nov 15 Python
分析用Python脚本关闭文件操作的机制
Jun 28 Python
python sys.argv[]用法实例详解
May 25 Python
Python进阶之全面解读高级特性之切片
Feb 19 Python
python zip()函数使用方法解析
Oct 31 Python
python将图片转base64,实现前端显示
Jan 09 Python
浅谈PyTorch的可重复性问题(如何使实验结果可复现)
Feb 20 Python
Python调用C/C++的方法解析
Aug 05 Python
selenium如何定位span元素的实现
Jan 13 Python
Python带你从浅入深探究Tuple(基础篇)
May 15 Python
Matplotlib绘制条形图的方法你知道吗
Mar 21 Python
利用Python实现颜色色值转换的小工具
Oct 27 #Python
Python实现批量检测HTTP服务的状态
Oct 27 #Python
python解决网站的反爬虫策略总结
Oct 26 #Python
Python控制多进程与多线程并发数总结
Oct 26 #Python
Python网络爬虫项目:内容提取器的定义
Oct 25 #Python
Python实现ssh批量登录并执行命令
Oct 25 #Python
详解Python的Lambda函数与排序
Oct 25 #Python
You might like
php返回json数据函数实例
2014/10/09 PHP
php单例模式的简单实现方法
2016/06/10 PHP
laravel框架的安装与路由实例分析
2019/10/11 PHP
javascript实现的listview效果
2007/04/28 Javascript
extjs中grid中嵌入动态combobox的应用
2011/01/01 Javascript
关于COOKIE个数与大小的问题
2011/01/17 Javascript
纯Javascript实现Windows 8 Metro风格实现
2013/10/15 Javascript
JS判断两个时间大小的示例代码
2014/01/28 Javascript
JavaScript indexOf方法入门实例(计算指定字符在字符串中首次出现的位置)
2014/10/17 Javascript
NodeJS制作爬虫全过程
2014/12/22 NodeJs
js图片跟随鼠标移动代码
2015/11/26 Javascript
js实现简单排列组合的方法
2016/01/27 Javascript
简单封装js的dom查询实例代码
2016/07/08 Javascript
jQuery 插件实现随机自由弹跳气泡样式
2017/01/12 Javascript
jQuery 点击获取验证码按钮及倒计时功能
2018/09/20 jQuery
Angular2使用SVG自定义图表(条形图、折线图)组件示例
2019/05/10 Javascript
vue点击自增和求和的实例代码
2019/11/06 Javascript
linux 下以二进制的方式安装 nodejs
2020/02/12 NodeJs
[00:32]DOTA2上海特级锦标赛 Ehome战队宣传片
2016/03/03 DOTA
python使用锁访问共享变量实例解析
2018/02/08 Python
Python numpy 点数组去重的实例
2018/04/18 Python
python实现QQ批量登录功能
2019/06/19 Python
python按照list中字典的某key去重的示例代码
2020/10/13 Python
用 Django 开发一个 Python Web API的方法步骤
2020/12/03 Python
python基于selenium爬取斗鱼弹幕
2021/02/20 Python
CSS3+HTML5+JS 实现一个块的收缩与展开动画效果
2020/11/17 HTML / CSS
美国全球旅游运营商:Pacific Holidays
2018/06/18 全球购物
世界各地的当地人的食物体验:Eatwith
2019/07/26 全球购物
暑期实习鉴定
2013/12/16 职场文书
目标责任书范文
2014/04/14 职场文书
学生打架检讨书
2014/10/20 职场文书
值班管理制度范本
2015/08/06 职场文书
如何书写邀请函?
2019/06/24 职场文书
mysql 带多个条件的查询方式
2021/06/05 MySQL
分享mysql的current_timestamp小坑及解决
2021/11/27 MySQL
vue.js 使用原生js实现轮播图
2022/04/26 Vue.js