为什么覆盖范围程序包无法命中 `eq` 实现的 False 分支？

2024-03-26 16:07:32

理解为什么覆盖范围程序包无法击中 __eq__ 实现的 False 分支

作为开发人员，我们在使用覆盖范围程序包时可能会遇到一个常见问题，即无法覆盖 __eq__ 方法的 False 分支。这可能会导致测试覆盖率结果不准确，并让我们难以全面了解代码的执行情况。

问题陈述

为了解决这个问题，让我们回顾一下 Python 中相等操作的机制。在 Python 中，相等操作（==）使用 __eq__ 方法进行评估。此方法返回一个布尔值，指示两个对象是否相等。如果未定义 __eq__ 方法，Python 将回退到 object 类的默认实现，该实现只检查对象标识（即，它们是否是同一个对象）。

现在，让我们来看一个具体的例子。假设我们有一个类 myClass，如下所示：

class myClass(object):

    def __init__(self, number: int):
        self.number = number

    def __eq__(self, other):
        if isinstance(other, myClass):
            return self.number == other.number
        return False

如果我们使用 unittest 对此类进行测试，如下所示：

import unittest
from myClass import myClass


class TestMyClass(unittest.TestCase):
    def test_equality(self):
        self.assertEqual(myClass(1), myClass(1))

    def test_inequality(self):
        self.assertNotEqual(myClass(1), myClass(2))

if __name__ == '__main__':
    unittest.main()

你会发现一切正常。但是，当你使用 coverage -m 运行该测试类时，它总是报告 __eq__ 方法的 return False 行没有被覆盖。这是为什么？

为什么覆盖范围程序包未击中 False 分支？

原因是 Python 为没有明确定义 __ne__ 方法的类自动生成了一个 __ne__ 方法，该方法只是 __eq__ 方法的否定。这意味着对于任何 other 对象，myClass 实例的 __eq__ 方法要么返回 True（如果 other 是 myClass 实例并且具有相同的值），要么返回 False（否则）。因此，return False 行永远不会被覆盖，即使两个对象不相等也是如此。

解决方案

要解决此问题，你可以采取以下两种方法之一：

定义一个显式的 __ne__ 方法： 你可以定义一个 __ne__ 方法，该方法简单地返回 not self.__eq__(other)。这将确保 return False 行在两个对象不相等时被覆盖。
覆盖 object 类的 __ne__ 方法： 你还可以覆盖 object 类的 __ne__ 方法，该方法只检查对象标识。这将覆盖所有没有明确定义 __ne__ 方法的类。