Какие методы Python нужно переопределить для использования объекта класса в качестве ключа словаря?

Ответ

Для использования экземпляра класса в качестве ключа словаря в Python необходимо переопределить два специальных метода:

  1. __hash__(self): Должен возвращать целочисленное значение (хеш объекта). Этот хеш используется для быстрого поиска объекта в хеш-таблицах (словарях, множествах).
  2. __eq__(self, other): Определяет логику сравнения объектов на равенство. Если два объекта имеют одинаковый хеш, __eq__ используется для разрешения коллизий и окончательного определения их равенства.

Почему это важно:

  • __hash__ обеспечивает эффективность: Python сначала вычисляет хеш ключа, чтобы быстро найти соответствующий "бакет" в словаре.
  • __eq__ обеспечивает корректность: Если в одном "бакете" несколько элементов (из-за коллизий хешей), __eq__ используется для точного сравнения ключей.

Пример:

class Person:
    def __init__(self, name: str, age: int):
        self.name = name
        self.age = age

    def __hash__(self) -> int:
        # Хеш должен быть основан на неизменяемых атрибутах
        return hash((self.name, self.age))

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, Person):
            return NotImplemented # Или False, в зависимости от желаемого поведения
        return self.name == other.name and self.age == other.age

# Создание экземпляров класса
p1 = Person("Alice", 30)
p2 = Person("Bob", 25)
p3 = Person("Alice", 30) # Объект с теми же данными, что и p1

# Использование объектов в качестве ключей словаря
d = {p1: "Alice's data", p2: "Bob's data"}

print(d[p1]) # Выведет: Alice's data
print(d[p3]) # Выведет: Alice's data (потому что p1 и p3 считаются равными)
print(p1 == p3) # Выведет: True

Важное замечание: Объекты, используемые в качестве ключей словаря, должны быть неизменяемыми (immutable) или их хешируемые атрибуты не должны меняться после добавления в словарь. Изменение хешируемых атрибутов объекта после его использования в качестве ключа приведет к тому, что объект не будет найден в словаре, так как его хеш изменится.