Сравнение объектов: __eq__ и __hash__

В уроке про __str__ и __repr__ объекты научились печататься — теперь научим их сравниваться. По умолчанию == для собственных классов отвечает так же, как is: «это один и тот же объект в памяти». Два счёта с одинаковым номером оказываются «не равны» — и это не то, что нужно бизнес-логике. Чинится определением __eq__, а для словарей и множеств добавляется __hash__.

== против is: равенство и идентичность

is сравнивает идентичность: лежат ли слева и справа один и тот же объект (совпадают ли их id). == вызывает метод __eq__ — метод равенства. По умолчанию __eq__ работает как is, поэтому два разных объекта с одинаковыми полями не равны:

class Account:
    def __init__(self, number):
        self.number = number

first = Account("4070")
second = first
third = Account("4070")

print(first is second)
print(first is third)
print(first == third)

True
False
False

Определим равенство по делу: счета равны, если совпадают номера. Сравнивать поля чужого объекта без проверки его класса опасно, поэтому сначала isinstance. Если other вообще не Account, вернём специальный объект NotImplemented: это сигнал «я такой тип не сравниваю», и Python попробует зеркальный вызов other.__eq__(a), а если и там неудача — вернёт False.

class Account:
    def __init__(self, number, owner):
        self.number = number
        self.owner = owner

    def __eq__(self, other):
        if not isinstance(other, Account):
            return NotImplemented
        return self.number == other.number

a = Account("4070", "Анна")
b = Account("4070", "Борис")
c = Account("4071", "Анна")

print(a == b)
print(a == c)
print(a != c)

True
False
True

__hash__: объект как ключ словаря

Словари и множества раскладывают объекты по ячейкам с помощью функции hash(). Инвариант железный: если a == b, то hash(a) обязан равняться hash(b). Как только вы определили __eq__, Python обнуляет __hash__ — класс становится нехешируемым, и его объекты перестают работать ключами и элементами множеств. Определите __hash__ по тем же полям, что и равенство:

class Coupon:
    def __init__(self, code):
        self.code = code

    def __eq__(self, other):
        if not isinstance(other, Coupon):
            return NotImplemented
        return self.code == other.code

    def __hash__(self):
        return hash(self.code)

promo = {Coupon("SUMMER"): 15, Coupon("WINTER"): 20}
print(promo[Coupon("SUMMER")])

codes = {Coupon("SUMMER"), Coupon("SUMMER"), Coupon("WINTER")}
print(len(codes))

15
2