numpy.testing.assert_equal#

testing.assert_equal(actual, desired, err_msg='', verbose=True, *, strict=False)[source]#

如果两个对象不相等,则引发 AssertionError。

给定两个对象(标量、列表、元组、字典或 NumPy 数组),检查这些对象的所有元素是否相等。在第一个冲突的值处引发异常。

此函数处理 NaN 比较,就像 NaN 是一个“正常”数字一样。也就是说,如果两个对象在相同的位置都有 NaN,则不会引发 AssertionError。这与关于 NaN 的 IEEE 标准形成对比,该标准指出 NaN 与任何东西进行比较都必须返回 False。

参数:
actualarray_like

要检查的对象。

desiredarray_like

预期对象。

err_msgstr,可选

如果失败,则打印的错误消息。

verbosebool,可选

如果为 True,则将冲突的值附加到错误消息中。

strictbool,可选

如果为 True 并且 actualdesired 参数之一是数组,则当参数的形状或数据类型不匹配时,引发 AssertionError。如果两个参数都不是数组,则此参数无效。

版本 2.0.0 中的新功能。

引发:
AssertionError

如果 actual 和 desired 不相等。

备注

默认情况下,当 actualdesired 之一为标量,另一个为数组时,该函数检查数组的每个元素是否等于标量。可以通过设置 strict==True 来禁用此行为。

示例

>>> np.testing.assert_equal([4, 5], [4, 6])
Traceback (most recent call last):
    ...
AssertionError:
Items are not equal:
item=1
 ACTUAL: 5
 DESIRED: 6

以下比较不会引发异常。输入中存在 NaN,但它们位于相同的位置。

>>> np.testing.assert_equal(np.array([1.0, 2.0, np.nan]), [1, 2, np.nan])

如“备注”部分所述,assert_equal 在其中一个参数为数组时对标量有特殊处理。在这里,测试检查 x 中的每个值是否为 3

>>> x = np.full((2, 5), fill_value=3)
>>> np.testing.assert_equal(x, 3)

使用 strict 在将标量与不同形状的数组进行比较时引发 AssertionError

>>> np.testing.assert_equal(x, 3, strict=True)
Traceback (most recent call last):
    ...
AssertionError:
Arrays are not equal

(shapes (2, 5), () mismatch)
 ACTUAL: array([[3, 3, 3, 3, 3],
       [3, 3, 3, 3, 3]])
 DESIRED: array(3)

strict 参数还确保数组数据类型匹配

>>> x = np.array([2, 2, 2])
>>> y = np.array([2., 2., 2.], dtype=np.float32)
>>> np.testing.assert_equal(x, y, strict=True)
Traceback (most recent call last):
    ...
AssertionError:
Arrays are not equal

(dtypes int64, float32 mismatch)
 ACTUAL: array([2, 2, 2])
 DESIRED: array([2., 2., 2.], dtype=float32)