python`__eq__'和`__hash___方法

在Python中自定义类需实现__eq__和__hash__以支持实例作为字典键或集合元素。1.__eq__用于判断对象是否相等，__hash__返回整数哈希值用于哈希表结构；2.二者必须基于相同属性实现以保持一致性；3.可变对象慎用__hash__，避免修改属性后无法定位对象；4.仅实现__eq__未定义__hash__时实例不可作为字典键或集合元素；5.Python 3.7 的dataclass可通过@dataclass(eq=True)自动生成这两个方法。正确实现能确保内容相同的实例被判定为相等且具有相同哈希值，从而在集合和字典中正常工作。

在 Python 中，当你自定义一个类，并且希望这个类的实例可以作为字典的键或者存储在集合中时，你就需要考虑实现 __eq__ 和 __hash__ 这两个方法。它们之间有着密切的关系，用错了可能会导致意想不到的问题。

什么时候需要用到 __eq__ 和 __hash__

如果你的类实例会被用来做比较（比如判断是否相等），或者你想把它们放进像 set 或 dict 这样的数据结构里，那就必须关注这两个方法。

• __eq__ 控制的是两个对象是否“等于”。
• __hash__ 返回的是对象的一个整数哈希值，用于快速识别对象，尤其是在哈希表结构中（如字典和集合）。

如果不重写这两个方法，默认行为是基于对象的身份（id），也就是两个不同的实例即使内容一样也不会被认为是相同的。

如何正确实现 __eq__ 和 __hash__

为了保证一致性，这两个方法应该基于相同的属性来实现。也就是说，如果 __eq__ 比较的是 a.name 和 a.age，那 __hash__ 也应该使用这两个字段来计算哈希值。

举个例子：

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def __eq__(self, other):
        if not isinstance(other, Person):
            return False
        return self.name == other.name and self.age == other.age

    def __hash__(self):
        return hash((self.name, self.age))

这样做的好处是：

• 两个拥有相同名字和年龄的 Person 实例会被认为是相等的；
• 它们也会有相同的哈希值，因此可以在集合或字典中正常工作。

需要注意：

• 如果你的类是可变对象（比如属性可以被修改），那实现 __hash__ 要小心，因为一旦对象被放进集合或作为字典键之后再修改属性，会导致哈希值变化，从而引发问题。
• 如果你只实现了 __eq__ 而不实现 __hash__，那你的实例将不能作为字典的键或放入集合中。

常见误区和注意事项

有时候新手会误以为只要写了 __eq__ 就够了，但其实这还不够。下面是一些容易踩坑的地方：

• 没有同时实现 __hash__：这样实例就不能作为字典键或集合元素；
• __eq__ 和 __hash__ 使用的属性不一致：会导致逻辑混乱，比如两个对象看起来是相等的，却有不同的哈希值；
• 对可变对象实现 __hash__：如果对象放入集合后改变了属性，就再也找不到了；
• 忘记返回整数：__hash__ 必须返回一个整数，否则会报错。

另外一个小细节是：如果你使用的是 Python 3.7 ，并且使用 dataclass，可以通过设置 @dataclass(eq=True) 来自动帮你生成 __eq__ 和 __hash__ 方法，省去手动编写的过程。

基本上就这些。这两个方法本身不复杂，但在实际使用中很容易忽略一些细节，尤其是当涉及到哈希结构的时候。只要记住：相等性与哈希值必须保持一致，就能避免大部分问题。

以上是python`__eq__'和`__hash___方法的详细内容。更多信息请关注PHP中文网其他相关文章！