Objekt vom benutzerdefinierten Typ als Wörterbuchschlüssel

Was muss ich tun, um meine Objekte eines benutzerdefinierten Typs als Schlüssel in einem Python-Wörterbuch zu verwenden (wobei ich nicht möchte, dass die "Objekt-ID" als Schlüssel fungiert), z

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

Ich möchte MyThing's als Schlüssel verwenden, die als gleich angesehen werden, wenn Name und Ort gleich sind. Von C # / Java bin ich es gewohnt, eine Methode für Gleichheit und Hashcode überschreiben und bereitstellen zu müssen, und verspreche, nichts zu mutieren, von dem der Hashcode abhängt.

Was muss ich in Python tun, um dies zu erreichen? Soll ich überhaupt?

(In einem einfachen Fall, wie hier, ist es vielleicht besser, einfach ein Tupel (Name, Ort) als Schlüssel zu platzieren - aber ich möchte, dass der Schlüssel ein Objekt ist.)

Sie müssen 2 Methoden hinzufügen , beachten Sie __hash__und __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)

In der Python- Diktatdokumentation werden diese Anforderungen für Schlüsselobjekte definiert, dh sie müssen hashbar sein .

Eine Alternative in Python 2.6 oder höher ist die Verwendung collections.namedtuple()- Sie können keine speziellen Methoden schreiben:

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

Sie überschreiben, __hash__wenn Sie eine spezielle Hash-Semantik wünschen und __cmp__oder __eq__um Ihre Klasse als Schlüssel verwendbar zu machen. Objekte, die gleich sind, müssen denselben Hashwert haben.

Python erwartet __hash__eine Ganzzahl, eine Rückgabe Banana()wird nicht empfohlen :)

Benutzerdefinierte Klassen haben __hash__standardmäßig Aufrufe id(self), wie Sie bemerkt haben.

Die Dokumentation enthält einige zusätzliche Tipps :

Klassen, die eine __hash__() Methode von einer übergeordneten Klasse erben, aber die Bedeutung von __cmp__()oder __eq__() so ändern, dass der zurückgegebene Hashwert nicht mehr angemessen ist (z. B. durch Umschalten auf ein wertbasiertes Gleichheitskonzept anstelle der identitätsbasierten Standardgleichheit), können sich explizit als kennzeichnen durch Festlegen __hash__ = None der Klassendefinition nicht verwischbar sein . Dies bedeutet, dass Instanzen der Klasse nicht nur einen geeigneten TypeError auslösen, wenn ein Programm versucht, ihren Hash-Wert abzurufen, sondern dass sie bei der Überprüfung auch korrekt als nicht verwischbar identifiziert werden isinstance(obj, collections.Hashable) (im Gegensatz zu Klassen, die ihre eigenen definieren __hash__(), um TypeError explizit auszulösen).