Pytest如何重写断言assert语句的报错信息

已于 2022-10-13 09:44:21 修改
阅读量1.8k 收藏 11
点赞数 1
分类专栏： Pytest 文章标签： python pytest 自动化测试
于 2021-06-26 17:36:32 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/redrose2100/article/details/118252233
版权

【原文链接】Pytest如何重写断言assert语句的报错信息

文章目录

一、默认的报错信息

首先观察如下测试代码，这里面有两个测试用例，一个是判断1是否等于2，第二个是判断字符串“hello”是否等于整数10.

def test_demo01():
    assert 1==2

def test_demo02():
    assert "hello" == 10

执行结果如下

$ pytest
========================================================================= test session starts ==========================================================================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0
rootdir: D:\redrose2100-book\ebooks\Pytest企业级应用实战\src
collected 2 items

test_demo.py FF                                                                                                                                                   [100%]

=============================================================================== FAILURES =============================================================================== 

test_demo.py:2: AssertionError
_____________________________________________________________________________ test_demo02 ______________________________________________________________________________ 

    def test_demo02():
>       assert "hello" == 10
E       AssertionError: assert 'hello' == 10

test_demo.py:5: AssertionError
======================================================================= short test summary info ======================================================================== 
FAILED test_demo.py::test_demo01 - assert 1 == 2
FAILED test_demo.py::test_demo02 - AssertionError: assert 'hello' == 10
========================================================================== 2 failed in 2.24s ===========================================================================

对于许多测试人员，可能习惯于看中文描述或者更加准确的中文描述，而当看到上述报错时，虽说从报错描述来说已经很清晰了，但是从多年的自动化测试经历中发现，其实很多测试人员或者编写自动化测试脚本的测试人员，调试或者执行自动化用例的时候看到上述报错的时候仍然是一脸茫然，他们更加的希望看到中文描述，甚至是更加人性化的中文描述，当然pytest的断言也提供了在脚本中自定义报错信息的方式，比如如下的方式。

def test_demo01():
    assert 1==2,"期望值与实际值不一致，期望值为2，实际值为1"

但是在实际测试开发中发现，虽然这种方式给自动化脚本开发人员自己定义的权利，但是在进行脚本开发的过程中如果每个断言都按照这种方式增加断言报错信息，又很占用时间，感觉不方便，甚至有很多断言报错信息其实都是类似的，比如判断两个变量是否相等，其实断言信息都是类似的，而在脚本中每次断言都加断言报错信息又会显得很冗余，因此，另外一种在conftest.py中重写断言报错信息的处理方式就显得非常好用了。

二、重写判断是否相等的断言的报错信息

这里先需要使用一个conftest.py文件，这个文件的详细的作用以及使用在后面继续展开，这里仅仅需要知道当conftest.py文件和测试用例文件放在同一个目录时，在执行测试用例文件之前会自动先加载执行conftest.py，因此本小节正是利用这一点，在conftest.py文件中重写pytest_assertrepr_compare方法。
conftest.py文件中代码如下，即在进行判断两个变量是否相等时，这里首先判断一下这两个变量是否为同一类型，如果不是同一类型，直接报错，并在报错中提示类型错误，这种情况比较常见的是比如在判断两个变量是否相等时，期望值为数字1，而实际值为字符串1，当打印调试的时候，会发现完全一样，但是结果就是报错，这种情况很是困扰人，因此可以在pytest_assertrepr_compare直接重写并判断，当类型一致时，在进行是否相等的判断，如果不相等，则采用中文描述详细的描述清楚。

def pytest_assertrepr_compare(op, left, right):
    if op == "==":
        if not isinstance(right,type(left)):
            return [
                f"断言错误，期望值与实际值的数据类型不一致，期望值数据类型为：{type(right)}， 实际值为：{type(left)}",
                f"期望值为：{right}， 实际值为：{left}",
            ]
        else:
            return [
                f"断言错误，期望值与实际值不一致，期望值为：{right}， 实际值为：{left}",
            ]

然后在同一目录下创建test_demo.py文件，测试脚本如下：

def test_demo01():
    assert 1==2

def test_demo02():
    assert "10" == 10

执行结果如下，可以看到此时错误描述非常简单清晰明了，一目了然。

$ pytest
========================================================================= test session starts ==========================================================================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0 
rootdir: D:\redrose2100-book\ebooks\Pytest企业级应用实战\src
collected 2 items

test_demo.py FF                                                                                                                                                   [100%]

=============================================================================== FAILURES =============================================================================== 
_____________________________________________________________________________ test_demo01 ______________________________________________________________________________ 

    def test_demo01():
>       assert 1==2
E       assert 断言错误，期望值与实际值不一致，期望值为：2， 实际值为：1

test_demo.py:2: AssertionError
_____________________________________________________________________________ test_demo02 ______________________________________________________________________________ 

    def test_demo02():
>       assert "10" == 10
E       AssertionError: assert 断言错误，期望值与实际值的数据类型不一致，期望值数据类型为：<class 'int'>， 实际值为：<class 'str'>
E         期望值为：10， 实际值为：10

test_demo.py:5: AssertionError
======================================================================= short test summary info ======================================================================== 
FAILED test_demo.py::test_demo01 - assert 断言错误，期望值与实际值不一致，期望值为：2， 实际值为：1
FAILED test_demo.py::test_demo02 - AssertionError: assert 断言错误，期望值与实际值的数据类型不一致，期望值数据类型为：<class 'int'>， 实际值为：<class 'str'>
========================================================================== 2 failed in 0.15s ===========================================================================

像这种细节的处理，就能显示出自动化测试的专业性了，一个资深的自动化测试专家设计出的自动化测试框架，很多时候都是体现在这些细节上。

三、重写常见的判断逻辑报错信息

如下，这里重写了 ==，in，not in 的断言报错信息，其他的比如 >， <，>=，<=，!= 等运算符重写方法类似，在企业级实战中，在设计自动化测试框架的时候，需要尽量重写全面，这里不在一一列举，有兴趣的可以自己尝试将这些运算符补全，conftest.py中编写如下代码

def pytest_assertrepr_compare(op, left, right):
    if op == "==":
        if not isinstance(right,type(left)):
            return [
                f"断言错误，期望值与实际值的数据类型不一致，期望值数据类型为：{type(right)}， 实际值为：{type(left)}",
                f"期望值为：{right}， 实际值为：{left}",
            ]
        else:
            return [
                f"断言错误，期望值与实际值不一致，期望值为：{right}， 实际值为：{left}",
            ]
    if op == "in":
        if isinstance(left,str) and isinstance(right,str):
            return [
                f"期望 {left} 是 {right} 的子串，实际 {left} 不是 {right} 的子串,"
            ]
        elif isinstance(right,list) or isinstance(right,set) or isinstance(right,tuple):
            return [
                f"期望 {left} 是集合 {right} 中的一个元素，实际集合 {right} 中没有 {left} 元素"
            ]
        elif isinstance(right,dict):
            return [
                f"期望 {left} 是字典 {right} 中的一个key，实际字典 {right} 中没有值为 {left} 的key"
            ]
        else:
            return [
                f"期望 {left} 是 {right} 中的一部分，实际上 {left} 并不是 {right} 的一部分"
            ]
    if op == "not in":
        if isinstance(left, str) and isinstance(right, str):
            return [
                f"期望 {left} 不是 {right} 的子串，实际 {left} 是 {right} 的子串,"
            ]
        elif isinstance(right, list) or isinstance(right, set) or isinstance(right, tuple):
            return [
                f"期望 {left} 不是集合 {right} 中的一个元素，实际集合 {right} 中有 {left} 元素"
            ]
        elif isinstance(right, dict):
            return [
                f"期望 {left} 不是字典 {right} 中的一个key，实际字典{right}中有值为 {left} 的key"
            ]
        else:
            return [
                f"期望 {left} 不是 {right} 中的一部分，实际上 {left} 是 {right} 的一部分"
            ]

下面在同级目录下编写了几个测试用例，用于演示上述重写的效果，具体代码如下

def test_01():
    assert 1==1
def test_02():
    assert 1==2
def test_03():
    assert "1"==1
def test_04():
    assert "aa" in "bbaa"
def test_05():
    assert "aa" in "bba"
def test_06():
    assert "aa" in ["aa","bb"]
def test_07():
    assert "aa" in ("aa","bb")
def test_08():
    assert "aa" in {"aa","bb"}
def test_09():
    assert "ab" in ["aa", "bb"]
def test_10():
    assert "ab" in ("aa", "bb")
def test_11():
    assert "ab" in {"aa", "bb"}
def test_12():
    assert "name" in {"name":"张三丰","age":100}
def test_13():
    assert "gender" in {"name":"张三丰","age":100}
def test_14():
    assert "aa" not in "bbaa"
def test_15():
    assert "aa" not in "bba"
def test_16():
    assert "aa" not in ["aa","bb"]
def test_17():
    assert "aa" not in ("aa","bb")
def test_18():
    assert "aa" not in {"aa","bb"}
def test_19():
    assert "ab" not in ["aa", "bb"]
def test_20():
    assert "ab" not in ("aa", "bb")
def test_21():
    assert "ab" not in {"aa", "bb"}
def test_22():
    assert "name" not in {"name":"张三丰","age":100}
def test_23():
    assert "gender" not in {"name":"张三丰","age":100}

执行结果如下，可以看出，经过这么重写之后，断言报错信息基本就能一眼就看出是什么问题，当然这里只是举了个例子，在设计自动化测试框架的时候，完全根据具体业务进行自定义，力求做到让团队或项目成员能最快最简单最容易的定位出错误。

$ pytest
========================================================================= test session starts ==========================================================================
platform win32 -- Python 3.9.13, pytest-7.1.2, pluggy-1.0.0
rootdir: D:\redrose2100-book\ebooks\Pytest企业级应用实战\src
collected 23 items

test_demo.py .FF.F...FFF.FF.FFF...F.                                                                                                                              [100%]

=============================================================================== FAILURES =============================================================================== 
_______________________________________________________________________________ test_02 ________________________________________________________________________________ 

    def test_02():
>       assert 1==2
E       assert 断言错误，期望值与实际值不一致，期望值为：2， 实际值为：1

test_demo.py:4: AssertionError
_______________________________________________________________________________ test_03 ________________________________________________________________________________ 

    def test_03():
>       assert "1"==1
E       AssertionError: assert 断言错误，期望值与实际值的数据类型不一致，期望值数据类型为：<class 'int'>， 实际值为：<class 'str'>
E         期望值为：1， 实际值为：1

test_demo.py:6: AssertionError
_______________________________________________________________________________ test_05 ________________________________________________________________________________ 

    def test_05():
>       assert "aa" in "bba"
E       assert 期望 aa 是 bba 的子串，实际 aa 不是 bba 的子串,

test_demo.py:10: AssertionError
_______________________________________________________________________________ test_09 ________________________________________________________________________________ 

    def test_09():
>       assert "ab" in ["aa", "bb"]
E       AssertionError: assert 期望 ab 是集合 ['aa', 'bb'] 中的一个元素，实际集合 ['aa', 'bb'] 中没有 ab 元素

test_demo.py:18: AssertionError
_______________________________________________________________________________ test_10 ________________________________________________________________________________ 

    def test_10():
>       assert "ab" in ("aa", "bb")
E       AssertionError: assert 期望 ab 是集合 ('aa', 'bb') 中的一个元素，实际集合 ('aa', 'bb') 中没有 ab 元素

test_demo.py:20: AssertionError
_______________________________________________________________________________ test_11 ________________________________________________________________________________ 

    def test_11():
>       assert "ab" in {"aa", "bb"}
E       AssertionError: assert 期望 ab 是集合 {'bb', 'aa'} 中的一个元素，实际集合 {'bb', 'aa'} 中没有 ab 元素

test_demo.py:22: AssertionError
_______________________________________________________________________________ test_13 ________________________________________________________________________________ 

    def test_13():
>       assert "gender" in {"name":"张三丰","age":100}
E       AssertionError: assert 期望 gender 是字典 {'name': '张三丰', 'age': 100} 中的一个key，实际字典 {'name': '张三丰', 'age': 100} 中没有值为 gender 的key

test_demo.py:26: AssertionError
_______________________________________________________________________________ test_14 ________________________________________________________________________________ 

    def test_14():
>       assert "aa" not in "bbaa"
E       assert 期望 aa 不是 bbaa 的子串，实际 aa 是 bbaa 的子串,

test_demo.py:28: AssertionError
_______________________________________________________________________________ test_16 ________________________________________________________________________________ 

    def test_16():
>       assert "aa" not in ["aa","bb"]
E       AssertionError: assert 期望 aa 不是集合 ['aa', 'bb'] 中的一个元素，实际集合 ['aa', 'bb'] 中有 aa 元素

test_demo.py:32: AssertionError
_______________________________________________________________________________ test_17 ________________________________________________________________________________ 

    def test_17():
>       assert "aa" not in ("aa","bb")
E       AssertionError: assert 期望 aa 不是集合 ('aa', 'bb') 中的一个元素，实际集合 ('aa', 'bb') 中有 aa 元素

test_demo.py:34: AssertionError
_______________________________________________________________________________ test_18 ________________________________________________________________________________ 

    def test_18():
>       assert "aa" not in {"aa","bb"}
E       AssertionError: assert 期望 aa 不是集合 {'bb', 'aa'} 中的一个元素，实际集合 {'bb', 'aa'} 中有 aa 元素

test_demo.py:36: AssertionError
_______________________________________________________________________________ test_22 ________________________________________________________________________________ 

    def test_22():
>       assert "name" not in {"name":"张三丰","age":100}
E       AssertionError: assert 期望 name 不是字典 {'name': '张三丰', 'age': 100} 中的一个key，实际字典{'name': '张三丰', 'age': 100}中有值为 name 的key

test_demo.py:44: AssertionError
======================================================================= short test summary info ======================================================================== 
FAILED test_demo.py::test_02 - assert 断言错误，期望值与实际值不一致，期望值为：2， 实际值为：1
FAILED test_demo.py::test_03 - AssertionError: assert 断言错误，期望值与实际值的数据类型不一致，期望值数据类型为：<class 'int'>， 实际值为：<class 'str'>
FAILED test_demo.py::test_05 - assert 期望 aa 是 bba 的子串，实际 aa 不是 bba 的子串,
FAILED test_demo.py::test_09 - AssertionError: assert 期望 ab 是集合 ['aa', 'bb'] 中的一个元素，实际集合 ['aa', 'bb'] 中没有 ab 元素
FAILED test_demo.py::test_10 - AssertionError: assert 期望 ab 是集合 ('aa', 'bb') 中的一个元素，实际集合 ('aa', 'bb') 中没有 ab 元素
FAILED test_demo.py::test_11 - AssertionError: assert 期望 ab 是集合 {'bb', 'aa'} 中的一个元素，实际集合 {'bb', 'aa'} 中没有 ab 元素
FAILED test_demo.py::test_13 - AssertionError: assert 期望 gender 是字典 {'name': '张三丰', 'age': 100} 中的一个key，实际字典 {'name': '张三丰', 'age': 100} 中没有值... 
FAILED test_demo.py::test_14 - assert 期望 aa 不是 bbaa 的子串，实际 aa 是 bbaa 的子串,
FAILED test_demo.py::test_16 - AssertionError: assert 期望 aa 不是集合 ['aa', 'bb'] 中的一个元素，实际集合 ['aa', 'bb'] 中有 aa 元素
FAILED test_demo.py::test_17 - AssertionError: assert 期望 aa 不是集合 ('aa', 'bb') 中的一个元素，实际集合 ('aa', 'bb') 中有 aa 元素
FAILED test_demo.py::test_18 - AssertionError: assert 期望 aa 不是集合 {'bb', 'aa'} 中的一个元素，实际集合 {'bb', 'aa'} 中有 aa 元素
FAILED test_demo.py::test_22 - AssertionError: assert 期望 name 不是字典 {'name': '张三丰', 'age': 100} 中的一个key，实际字典{'name': '张三丰', 'age': 100}中有值为 na...
==================================================================== 12 failed, 11 passed in 0.23s =====================================================================
redrose2100
关注
  • 1
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
pytest文档11-assert断言
qq_27371025的博客
06-25 332
前言 命令行参数是根据命令行选项将不同的值传递给测试函数，比如平常在cmd执行"pytest --html=report.html",这里面的”–html=report.html“就是从命令行传入的参数 对应的参数名称是html，参数值是report.html conftest配置参数 1.首先需要在conftest.py添加命令行选项,命令行传入参数”–cmdopt“, 用例如果需要用到从命令行传入的参数，就调用cmdopt函数： # content of conftest.py import pytes
python 重写断言_Pytest官方教程-04-断言的编写和报告
weixin_29468871的博客
01-14 582
目录：断言的编写和报告使用assert语句进行断言pytest允许你使用标准的Pythonassert断言语句来验证测试中的期望结果和实际结果。 例如，你可以编写以下内容：# test_assert1.py文件内容def f():return 3def test_function():assert f() == 4来断言你的函数返回一个特定的值。 如果此断言失败，你将看到函数调用的返回值：$ py...
大一python考试知识点_Python自动化框架之pytest，从入门到精通知识点全收录
weixin_39738115的博客
11-24 277
Pytest是成熟的功能齐全的Python测试工具，有助于编写更好的程序。一、Pytest基本知识参考官方文档翻译过来，了解一下Pytest知识点。1、Pytest中可以按节点ID运行测试。在命令行中指定测试方法的另一个示例：pytest test_mod.py::TestClass::test_method2、通过标记表达式运行测试pytest -m slow将运行用@Pytest.mark.s...
Pytest精通指南（21）钩子函数-失败重试（pytest-rerunfailures）
最新发布
weixin_54217348的博客
04-20 670
想要深入了解pytest，成为Python测试领域的大佬吗？本教程系列将带你从零开始，逐步掌握pytest的核心知识和高级技巧。无论你是初学者还是进阶者，都能在这里找到适合自己的突破点。开启pytest学习之旅，为自动化测试工作扬帆起航！
Python 运行pytest用例时业务断言失败，用例统计是pass的问题，已解决
qq_41845402的博客
03-09 860
Python 运行pytest用例时业务断言失败，用例统计是pass的问题，已解决
python 重写断言_如何让pytest重写非测试模块中的断言
weixin_39639286的博客
01-14 182
我们在一个单独的python文件中定义了所有的自定义断言，这个文件不是一个测试模块。在例如：custom_asserts.pyclass CustomAsserts(object):def silly_assert(self, foo, bar):assert foo == bar , 'some error message'如果我们在测试中直接使用assert，我们将获得关于断言错误的额外信息，...
pytest中文文档之编写断言
12-31
pytest允许你使用python标准的assert表达式写断言； 例如，你可以这样做： # test_sample.py def func(x): return x + 1 def test_sample(): assert func(3) == 5 如果这个断言失败，你会看到func(3)实际的返回值...
pytest-assert-utils-0.2.1.tar.gz
08-05
pytest-assert-utils-0.2.1.tar.gz
pytest-ast-back-to-python：pytest开发人员的插件，用于查看断言重写如何重新编码AST
02-21
pytest-ast回到python pytest开发人员的插件，用于查看断言重写如何重新编码AST特征Pytest重写测试的AST（抽象语法树），目的是显示assert语句中涉及的子表达式。 此插件将重写的AST转换回Python源，并显示它。安装...
Python接口测试结果集实现封装比较
12-20
　接口测试执行完后，我们需要进行断言，断言的主要目的是用代码来判断实际结果和预期结果是否一致，这跟手工测试中用肉眼去判断是一样的思路。既然这样，我们可以将已知的预期结果和未知的实际结果简单的封装成一个...
TestNG 断言类重写
weixin_30273931的博客
03-19 138
断言失败截图，且不退出用例，提供结算方法结算断言 public class SoftAssert extends Assertion { private WebDriver driver; private final String SCREENSHOT_PATH =System.getProperty("user.dir")+"/target/testreport...
Pytest框架 —— Pytest预期失败
myh919的博客
05-12 224
Pytest预期失败需要使用@pytest.mark.xfail()标记。（1）@pytest.mark.xfail()标记的作用：期望测试用例是失败的，但是会运行此测试用例，并且也不会影响其他测试用例的的执行。（即xfail标记并不会影响用例的运行） 如果预期失败的测试用例执行失败的则结果是xfail（不会额外显示出错误信息）如果测试用例执行成功的则结果是xpass。 在报告中会将这些用例列在“预期失败XFAIL或意外传递XPASS部分。
Pytest权威教程-04断言的编写和报告
weixin_30539625的博客
09-03 113
断言的编写和报告 使用assert语句进行断言 pytest允许你使用标准的Pythonassert断言语句来验证测试中的期望结果和实际结果。 例如,你可以编写以下内容： # test_assert1.py文件内容 def f(): return 3 def test_function(): assert f() == 4 来断言你的函数返回一个特定的值。 如果此断言失...
单元测试教程（二）：Assert验证的重写
雨水的早晨的博客
02-17 1634
new verifyAssert().verifyEquals(result, 2, remark, “com.bjcj.OS.JB”, “testJBu”, “testJuBu2”); 这句代码是做什么的呢？其实是重新封装了assert断言import static org.junit.Assert.*;import com.bjcj.excel.ExcelJunitReport;/**
Python中assert断言添加错误提示信息
思念殇千寻的博客
09-04 1775
　　参考资料： 　　https://www.cnblogs.com/meina/p/13848090.html 　　当我们使用Python写代码的时候，可以多用assert断言语句来让代码变得更加鲁棒。但是如果单纯用assert的话，是不会输出任何错误信息的，如下图所示： 　　此时我们只需要用下面的语法就可以填充错误信息，让用户一眼就能看到错误出在哪： "assert" expression...
【Python】Python 测试框架 Pytest 的所有断言及其示例
田辛_DensinTian的专栏
03-26 658
在 Pytest 中，断言是测试用例中的关键部分。本文介绍了 Pytest 的所有断言，并且为每个断言提供了示例，以帮助读者更好地理解如何在 Pytest 中使用它们。我们从简单的 assert 表达式开始，然后深入探讨了比较运算符、类型检查以及成员检查等更多断言。读者可以通过本文快速了解 Pytest 中的断言及其用法，以便更好地编写测试用例。
pytest_assertrepr_compare 自定义失败的断言解释
词穷墨尽博客
08-12 728
test_login.py conftest.py
Python测试框架pytest入门基础
Python_xiaowu的博客
12-17 1000
Pytest简介 Pytest is a mature full-featured Python testing tool that helps you write better programs. Thepytestframework makes it easy to write small tests, yet scales to support complex functional testing for applications and libraries. 通过官方网站介绍我们可以了解..
pytest入门
lemonquan的博客
04-26 219
一、pytest入门？ pytest框架使编写小型测试变得容易，但可以扩展以支持应用程序和库的复杂功能测试。 特点： 失败的assert语句的详细信息 自动发现测试模块和方法 二、使用步骤 1.引入库 代码如下（示例）： ''' 只执行pytest，会查找当前目录及子目录下test_*.py和*_test.py文件 如果想只执行某个文件，可以pytest start.py 加上-q就是显示简单的结果pytest -q start.py ''' def func(x): return x+1 de
pytest assert断言怎么用
03-16
pytest中的assert断言可以用于判断测试结果是否符合预期。使用方法如下： 1. 在测试用例中使用assert语句，将测试结果与预期结果进行比较。 2. 如果测试结果与预期结果不一致，则assert语句会抛出AssertionError...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

redrose2100

您的鼓励是我最大的创作动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值