Obiekt typu niestandardowego jako klucz słownika

Co muszę zrobić, aby użyć obiektów niestandardowego typu jako kluczy w słowniku Pythona (gdzie nie chcę, aby „identyfikator obiektu” działał jako klucz), np.

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

Chciałbym użyć MyThing jako kluczy, które są uważane za takie same, jeśli nazwa i lokalizacja są takie same. Od C # / Java jestem przyzwyczajony do przesłonięcia i podania metody equals i hashcode, i obiecuję, że nie będę mutować niczego, od czego zależy hashcode.

Co muszę zrobić w Pythonie, aby to osiągnąć? Powinienem w ogóle?

(W prostym przypadku, tak jak tutaj, być może lepiej byłoby po prostu wstawić krotkę (nazwa, lokalizacja) jako klucz - ale weź pod uwagę, że chcę, aby klucz był obiektem)

Musisz dodać 2 metody , uwagę __hash__i __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)

Dokumentacja języka Python definiuje te wymagania dotyczące kluczowych obiektów, tzn. Muszą być możliwe do skrócenia .

Alternatywą w Pythonie 2.6 lub nowszym jest użycie collections.namedtuple()- oszczędza ci to pisania specjalnych metod:

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

Zastępujesz, __hash__jeśli chcesz specjalnej semantyki mieszania i / __cmp__lub __eq__aby twoja klasa była użyteczna jako klucz. Obiekty, które porównują równe, muszą mieć tę samą wartość skrótu.

Python spodziewa __hash__się zwrócić liczbę całkowitą, zwracanie Banana()nie jest zalecane :)

Jak zauważyłeś, klasy zdefiniowane __hash__przez użytkownika mają domyślnie te wywołania id(self).

Dokumentacja zawiera dodatkowe wskazówki :

Klasy, które dziedziczą __hash__() metodę z klasy nadrzędnej, ale zmieniają znaczenie __cmp__()lub __eq__() takie, że zwracana wartość skrótu nie jest już odpowiednia (np. Przez przejście do koncepcji równości opartej na wartości zamiast domyślnej równości opartej na tożsamości) mogą jawnie oznaczać się jako jest nie do powstrzymania przez ustawienie __hash__ = None w definicji klasy. Takie postępowanie oznacza, że ​​instancje klasy nie tylko zgłoszą odpowiedni błąd TypeError, gdy program próbuje odzyskać wartość skrótu, ale zostaną również poprawnie zidentyfikowane jako nieuczesane podczas sprawdzania isinstance(obj, collections.Hashable) (w przeciwieństwie do klas, które definiują własne, __hash__()aby jawnie wywoływać błąd TypeError).