Pytest系列- assert断言详细使用（4）

简介

• 在断言方面，pytest框架比其他类似的框架（比如unittest）更加简洁，易用，我想这是选择pytest作为自动化测试框架之一的原因之一。
• pytest的assert断言关键字支持使用python内置的assert表达式。可以理解为pytest的断言就是直接使用python自带的assert关键字。
• assert关键字后面可以接一个表达式，只要表达式的最终结果为True，那么断言通过，用例执行成功，否则用例执行失败。

Assert 常用断言

pytest 里面断言实际上就是 python 里面的 assert 断言方法，常用的有以下几种

• assert xx ：判断 xx 为真
• assert not xx ：判断 xx 不为真
• assert a in b ：判断 b 包含 a
• assert a == b ：判断 a 等于 b
• assert a != b ：判断 a 不等于 b

作用：判断预期结果与实际结果是否相等，同时可在抛出异常之后输出一些提示信息，执行之后就方便查看是什么原因了。

异常断言Excepiton

除了支持对代码正常运行的结果断言之外，Pytest也能够对 Exception 和 Warnning 进行断言，来断定某种条件下，一定会出现某种异常或者警告。在功能测试和集成测试中，这两类断言用的不多，这里简单介绍一下。

可以使用 with pytest.raises（异常类型） 作为上下文管理器，当抛出异常时可以获取到对应的异常实例

def test_zero_division():
    with pytest.raises(ZeroDivisionError):
        1 / 0
1
2
3

断言场景：断言它抛的异常是不是预期想要的
代码执行：1/0
预期结果：抛的异常是ZeroDivisionError: division by zero
如何断言：通常是断言异常的 type 和 value 值了
具体方式：这里 1/0 的异常类型是 ZeroDivisionError，异常的 value 值是 divisionby zero

import pytest

def test_zero_division():
    """断言异常"""
    with pytest.raises(ZeroDivisionError) as excinfo:
        1 / 0

    # 断言异常类型type
    assert excinfo.type == ZeroDivisionError
    # 断言异常value值
    assert "division by zero" in str(excinfo.value)
1
2
3
4
5
6
7
8
9
10
11

执行结果：

excinfo ：是一个异常信息实例
主要属性： .type 、 .value 、 .traceback
注意：断言 type 的时候，异常类型是不需要加引号的，断言 value值的时候需转 str
这个测试用例，就断言了excinfo.value的内容中包含division by zero这个字符串，这在需要断言具体的异常信息时非常有用。

关于更多的Exception和Warnning的断言可以参考Pytest的官方文档：
[Exception和Warnning的断言 Pytest的官方文档]

优化断言提示信息

可在terminal输入：pytest -s 断言文件名.py

拓展一：match

可以将 match 关键字参数传递给上下文管理器，以测试正则表达式与异常的字符串表示形式是否匹配
注意：这种方法只能断言value，不能断言type

# 自定义消息
def test_zero_division_long():
    with pytest.raises(ZeroDivisionError, match=".*zero.*") as excinfo:
        1 / 0
1
2
3
4

该 match 方法的regexp参数与 re.search 函数匹配，因此在上面的示例中 match=‘zero’ 也可以使用

# 自定义消息
def test_zero_division_long():
    with pytest.raises(ZeroDivisionError, match=".*zero.*") as excinfo:
        1 / 0

def test_zero_division_long2():
    with pytest.raises(ZeroDivisionError, match="zero") as excinfo:
        1 / 0
1
2
3
4
5
6
7
8

拓展二：检查断言装饰器

# 断言装饰器
@pytest.mark.xfail(raises=ZeroDivisionError)
def test_f():
    1 / 0
1
2
3
4

执行结果

知识点

• 代码抛出异常，但是和raises指定的异常类相匹配，所以不会断言失败
• 它相当于一个检查异常装饰器，功能：检查是否有异常，不确定是否有异常
• with pytest.raise(ZeroDivisionError) 对于故意测试异常代码的情况，使用可能会更好
• 而 @pytest.mark.xfail(raises=ZeroDivisionError) 对于检查未修复的错误（即，可能会发生异常），使用检查断言可能会更好

参考文章地址