Ответ.

Оператор in в Python определяет, содержится ли элемент в коллекции. Для пользовательских объектов, чтобы поддерживалась конструкция x in your_obj, необходимо реализовать метод __contains__. Если его нет, интерпретатор попытается итерировать объект с помощью __iter__ или __getitem__, но поведение и эффективность могут отличаться.

Пример:

class MyBag:
    def __init__(self, items):
        self.items = items

    def __contains__(self, value):
        return value in self.items

bag = MyBag([1,2,3])
print(2 in bag)     # True
print(5 in bag)     # False

Если реализовать только __iter__ (или даже только __getitem__), то in будет работать, но менее эффективно и иногда совсем не так, как ожидается.

Обратите внимание: если коллекция огромная, а проверка реализована наивно (например, через цикл по всему списку), возможны проблемы с производительностью. Для быстрых проверок используют, например, множества.

Вопрос с подвохом.

Достаточно ли реализовать только __iter__ или только __getitem__ для корректной работы оператора in? Как изменится поведение?

Ответ:

Если нет __contains__, Python попытается перебрать элементы, используя __iter__ (если есть) или __getitem__ (начиная с индекса 0, пока не выпадет исключение IndexError).
Такое поведение менее эффективно и может вызвать бесконечные циклы или исключения, если методы реализованы с опечатками.

Пример:

class Weird:
    def __getitem__(self, idx):
        if idx < 3:
            return idx
        raise IndexError

w = Weird()
print(2 in w)  # True
print(5 in w)  # False

Примеры реальных ошибок из-за незнания тонкостей темы.

История

В одном проекте пользовательский контейнер для хранения сущностей перезаписал только __iter__, забыв реализовать __contains__. Оператор in начал работать не только медленно (для больших коллекций были заметны лаги), но и внезапно падать с загадочными ошибками, когда итератор ошибочно выбрасывал исключения не типа StopIteration.

История

Для класса, где элементы рассчитывались "на лету" по индексу, разработчик реализовал лишь __getitem__. При попытке проверки x in obj с большим x возникали долгие циклы и даже Out Of Memory — ведь in проверяет все индексы по возрастанию, пока не встретит IndexError.

История

В одном из проектов был реализован кастомный словарь, который для in полагался только на __iter__. Это привело к тому, что для 100 000 ключей поиск занимал секунды против миллисекунд у стандартного dict (где __contains__ реализован эффективно).