如何在Python unittest中使用assert方法比较两个DataFrame

ValueError: The truth value of a DataFrame is ambiguous. Use a.empty, a.bool(), a.item(), a.any() or a.all().

这个报错触发的原因是self.assertEquals(mock_df, result)会尝试对两个DataFrame执行等值判断，而pandas中两个DataFrame用==比较会返回逐元素的布尔值矩阵，不是单个布尔值，unittest的默认断言方法无法处理这种结果，就会触发真值判断歧义的报错。

Pandas官方已经提供了专门用于单元测试的DataFrame断言工具，直接用即可：

1. 首选：pandas.testing.assert_frame_equal #

这是官方推荐的标准方案，会自动校验DataFrame的索引、列名、所有单元格的值、字段数据类型，出现差异时会输出详细的差异位置和内容，比手动逐列校验覆盖率更高，也更便捷。
使用示例：

import pandas as pd

# 单元测试中直接调用即可
pd.testing.assert_frame_equal(mock_df, result)

常用可调参数 #

• check_index=False：不需要校验索引一致性时添加，比如索引是自动生成的自增序列，业务上不要求对齐的场景
• check_dtype=False：不需要校验字段数据类型一致性时添加，比如只要求值相等，不要求int32和int64严格对齐的场景
• check_like=True：不需要校验列的顺序，只要列名和对应值一致即可通过校验

2. 其他补充场景 #

如果只需要校验两个DataFrame的值完全相等，不需要官方断言的详细报错信息，也可以调用DataFrame自带的方法：

# 先判断形状一致，再判断所有值相等
self.assertTrue(mock_df.shape == result.shape and mock_df.equals(result))

要注意equals方法会严格校验索引、列名、值、数据类型，所有维度都一致才会返回True。

你目前的临时方案可以满足当前场景，但存在几个明显的缺陷：

• 后续新增字段时如果忘记添加对应的断言，会出现测试漏覆盖
• 无法校验索引、字段数据类型的一致性，比如1（int类型）和"1"（字符串类型）会被判定为不一致，容易出现误判
• 列顺序变更时无法感知，要是业务上要求列顺序固定的话会漏测

内容的提问来源于stack exchange，提问作者AkshayJain