2.3.5 为失败断言添加自定义的说明

有时需要在断言时显示自定义的说明,可以直接在断言后面添加提示信息,代码如下:

执行的结果如下:

上述代码是比较两个基本数据,当比较两个对象实例时,可通过重写它的__eq__()方法比对实现。

代码如下:

但当执行这个用例时其结果并不能直观地从中看出来失败的原因assert <test_fail_cus.Foo object at 0x109a7de10>==<test_fail_cus.Foo object at 0x109a7dc88>。

在这种情况下,如何比较两个实例呢?

通常有两种方式:第一种是重写__repr__()方法,第二种是用钩子的方法。下面将详细说明具体如何实现。

第一种方法:通过重写Foo的__repr__()方法,把详细信息显示出来。

在上述代码中添加下面的方法,代码如下:

当执行用例时,能看到失败的原因,其原因是因为1==2不成立。

代码如下:

第二种方法:使用钩子的方法加断言的详细信息。

在当前目录下新建conftest.py文件,在conftest.py文件中使用pytest _assertrepr_compare这个钩子方法添加自定义的失败说明,在本目录下创建conftest.py文件(这个文件中的内容会供本目录中的所有文件共享,pytest执行时先执行这个文件中的内容再执行测试用例,在3.2节和5.4节将分别详细讲解conftest.py和钩子的用法),在文件中输入下面代码。自定义失败说明后再执行test_fail_cus.py。

代码如下:

执行后的结果如下,此时会看到一个更友好的失败说明,在出现错的代码行下面有具体的自定义的提示信息。

代码如下: