辞書キーとしてのカスタムタイプのオブジェクト

カスタムタイプのオブジェクトをPython辞書のキーとして使用するにはどうすればよいですか（「オブジェクトID」をキーとして機能させたくない場合）。例：

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

MyThingを、名前と場所が同じであれば同じと見なされるキーとして使用したいと思います。C＃/ Javaから、equalsおよびhashcodeメソッドをオーバーライドして提供する必要があり、ハッシュコードが依存するものを変更しないことを約束しました。

これを行うには、Pythonで何をする必要がありますか？私もすべきですか？

（ここのような単純なケースでは、おそらく（name、location）タプルをキーとして配置するほうが良いでしょう-しかし、キーをオブジェクトにしたいと考えてください）

2つのメソッドを追加する必要があります。メモ__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のドキュメントでは、キーオブジェクトに関するこれらの要件を定義しています。つまり、それらはハッシュ可能でなければなりません。

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

__hash__特別なハッシュセマンティクスが必要な場合、__cmp__または__eq__クラスをキーとして使用できるようにするためにオーバーライドします。等しいオブジェクトは、同じハッシュ値を持つ必要があります。

Pythonは__hash__整数を返すことを期待しているため、返すことBanana()はお勧めしません:)

既に述べたように、ユーザー定義のクラスは__hash__デフォルトでを呼び出しid(self)ます。

ドキュメントからいくつかの追加のヒントがあります。

__hash__() 親クラスからメソッドを継承するが、 返されるハッシュ値の意味が変更され__cmp__()たり__eq__()（デフォルトのIDベースの等価ではなく、値ベースの等価の概念に切り替えるなど）したクラスは、次のように明示的にフラグを立てることができます。__hash__ = None クラス定義で設定することでハッシュ化できません。そうすることで、プログラムがハッシュ値を取得しようとしたときにクラスのインスタンスが適切なTypeErrorを発生させるだけでなく、チェック時にハッシュ不可として正しく識別されることになります isinstance(obj, collections.Hashable) （__hash__()TypeErrorを明示的に発生させるクラスを定義するクラスとは異なります ）。