Objek jenis khusus sebagai kunci kamus

Apa yang harus saya lakukan untuk menggunakan objek saya dari jenis khusus sebagai kunci dalam kamus Python (di mana saya tidak ingin "objek id" untuk bertindak sebagai kunci), misalnya

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

Saya ingin menggunakan MyThing's sebagai kunci yang dianggap sama jika nama dan lokasinya sama. Dari C # / Java saya terbiasa harus menimpa dan memberikan metode kode hash dan sama, dan berjanji untuk tidak bermutasi apa pun tergantung kode hash.

Apa yang harus saya lakukan dengan Python untuk mencapai ini? Haruskah saya meratakan?

(Dalam kasus sederhana, seperti di sini, mungkin akan lebih baik untuk menempatkan tuple (nama, lokasi) sebagai kunci - tetapi pertimbangkan saya ingin kunci menjadi objek)

Anda perlu menambahkan 2 metode , perhatikan __hash__dan __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)

Dokumentasi dict Python mendefinisikan persyaratan ini pada objek kunci, yaitu mereka harus hashable .

Alternatif dengan Python 2.6 atau di atas adalah menggunakan collections.namedtuple()- menghemat Anda menulis metode khusus:

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

Anda menimpa __hash__jika Anda menginginkan semantik-hash khusus, dan __cmp__atau __eq__agar kelas Anda dapat digunakan sebagai kunci. Objek yang membandingkan kebutuhan yang sama untuk memiliki nilai hash yang sama.

Python mengharapkan __hash__untuk mengembalikan integer, pengembalian Banana()tidak dianjurkan :)

Kelas yang ditentukan pengguna __hash__secara default memanggil id(self), seperti yang Anda catat.

Ada beberapa tips tambahan dari dokumentasi :

Kelas-kelas yang mewarisi __hash__() metode dari kelas induk tetapi mengubah makna __cmp__()atau __eq__() sehingga nilai hash yang dikembalikan tidak lagi sesuai (misalnya dengan beralih ke konsep kesetaraan berbasis nilai alih-alih kesetaraan berbasis identitas standar) dapat secara eksplisit menandai diri mereka sebagai tidak bisa dihancurkan dengan menetapkan __hash__ = None dalam definisi kelas. Melakukannya berarti bahwa instance kelas tidak hanya akan meningkatkan TypeError yang sesuai ketika sebuah program mencoba untuk mengambil nilai hash mereka, tetapi mereka juga akan diidentifikasi dengan benar sebagai tidak dapat terluka ketika memeriksa isinstance(obj, collections.Hashable) (tidak seperti kelas yang menentukan kelasnya __hash__()untuk secara eksplisit meningkatkan TypeError).