Об'єкт користувацького типу як ключ словника

Що я повинен зробити, щоб використовувати свої об'єкти користувальницького типу як ключі в словнику Python (де я не хочу, щоб "ідентифікатор об'єкта" виконував роль ключа), наприклад

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

Я б хотів використовувати MyThing як ключі, які вважаються однаковими, якщо ім’я та місце розташування однакові. З C # / Java я звик переосмислювати та надавати метод рівних та хеш-кодів, і обіцяю не мутувати нічого, від чого залежить хеш-код.

Що я повинен зробити в Python для цього? Чи повинен я навіть?

(У простому випадку, як, наприклад, тут, можливо, було б краще просто вказати кордон (ім’я, місцезнаходження) як ключ - але врахуйте, що я хочу, щоб ключ був об’єктом)

Вам потрібно додати 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 диктує документація визначає ці вимоги до ключових об'єктів, тобто вони повинні бути hashable .

Альтернативою в 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__() таке, що повернене хеш-значення більше не підходить (наприклад, шляхом переходу на концепцію рівності на основі значення замість рівності, заснованої на ідентичності за замовчуванням) можуть явно позначати себе як бути незручним, встановивши __hash__ = None у класі визначення. Це означає, що не тільки екземпляри класу піднімають відповідний TypeError, коли програма намагається отримати їх хеш-значення, але вони також будуть правильно ідентифіковані як нездатні під час перевірки isinstance(obj, collections.Hashable) (на відміну від класів, які визначають їх власні, __hash__()щоб явно підвищити TypeError).