自定义类型的对象作为字典键

Question

我必须怎么做才能将自定义类型的对象用作 Python 字典中的键（我不希望“对象 id”充当键），例如

class MyThing:
    def __init__(self,name,location,length):
            self.name = name
            self.location = location
            self.length = length

如果名称和位置相同，我想将 MyThing 用作被视为相同的键。 从 C#/Java 开始，我习惯于重写并提供 equals 和 hashcode 方法，并承诺不会改变 hashcode 所依赖的任何内容。

我必须在 Python 中做什么才能完成此任务？我什至应该吗？

（在一个简单的情况下，比如这里，最好只放置一个 (name,location) 元组作为键 - 但考虑我希望键是一个对象）

Answer 1

我知道其他人可能会像我一样在这里结束，今天的答案是在 python >3.7 中使用数据类。它同时具有 hash 和 eq 函数。

Answer 2

我注意到在 python 3.8.8（可能更早）中，您不再需要明确声明 __eq__() 和 __hash__() 就必须有机会使用自己的类作为 dict 中的键。

class Apple:
    def __init__(self, weight):
        self.weight = weight
        
    def __repr__(self):
        return f'Apple({self.weight})'

apple_a = Apple(1)
apple_b = Apple(1)
apple_c = Apple(2)

apple_dictionary = {apple_a : 3, apple_b : 4, apple_c : 5}

print(apple_dictionary[apple_a])  # 3
print(apple_dictionary)  # {Apple(1): 3, Apple(1): 4, Apple(2): 5}

我假设有一段时间 Python 会自行管理它，但我可能错了。

Answer 3

需要添加2 methods，注意__hash__和__eq__：

class MyThing:
    def __init__(self,name,location,length):
        self.name = name
        self.location = location
        self.length = length

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

    def __eq__(self, other):
        return (self.name, self.location) == (other.name, other.location)

    def __ne__(self, other):
        # Not strictly necessary, but to avoid having both x==y and x!=y
        # True at the same time
        return not(self == other)

Python dict documentation 定义了对关键对象的这些要求，即它们必须是 hashable。

Answer 4

在 Python 2.6 或更高版本中的替代方法是使用 collections.namedtuple() -- 它可以节省您编写任何特殊方法的时间：

from collections import namedtuple
MyThingBase = namedtuple("MyThingBase", ["name", "location"])
class MyThing(MyThingBase):
    def __new__(cls, name, location, length):
        obj = MyThingBase.__new__(cls, name, location)
        obj.length = length
        return obj

a = MyThing("a", "here", 10)
b = MyThing("a", "here", 20)
c = MyThing("c", "there", 10)
a == b
# True
hash(a) == hash(b)
# True
a == c
# False

Answer 5

如果你想要特殊的哈希语义，你覆盖 __hash__，并覆盖 __cmp__ 或 __eq__ 以使你的类可用作键。比较相等的对象需要具有相同的哈希值。

Python 期望 __hash__ 返回一个整数，不推荐返回 Banana() :)

用户定义的类默认有__hash__，它调用id(self)，正如你所提到的。

documentation 提供了一些额外的提示：

继承 __hash__() 的类 来自父类的方法，但改变 __cmp__() 或 __eq__() 的含义 这样返回的哈希值为 不再合适（例如，通过 转向基于价值的概念 平等而不是默认 基于身份的平等）可以 明确地将自己标记为 通过设置 __hash__ = None 不可散列 在类定义中。这样做 意味着不仅将实例 班级提出适当的 TypeError 当程序尝试 检索他们的哈希值，但他们 也将被正确识别为 检查时不可散列 isinstance(obj, collections.Hashable) （与定义自己的类不同 __hash__() 显式引发 TypeError）。