Что такое side_effect в моках и зачем он нужен?

Question

side_effect задаёт “поведение” мока при вызове: он может выбрасывать исключение, возвращать разные значения по очереди или вызывать функцию. Это нужно, чтобы в тестах воспроизводить реальные сценарии: временные сбои, ретраи, разные ответы. Такой контроль делает тесты ближе к реальности и помогает покрывать негативные ветки.

YeaHub · Accepted Answer

Определениеside_effect — это механизм в unittest.mock (и совместимых инструментах), который определяет, что произойдёт при вызове мока: возврат значения, исключение, последовательность значений или выполнение функции.Зачем нужен side_effectПеред примерами важно разделить два понятия:return_value — всегда возвращает одно и то жеside_effect — позволяет моделировать динамическое поведениеЭто критично, когда код зависит от:последовательности вызововвременных ошибокразных ответов внешнего сервисаТиповые сценарии использования1) Сымитировать исключениеНапример, внешний клиент падает, и вы проверяете обработку ошибки.from unittest.mock import Mock
import pytest

def call_service(client):
    return client.fetch()

def test_call_service_raises():
    client = Mock()
    client.fetch.side_effect = TimeoutError("timeout")

with pytest.raises(TimeoutError, match="timeout"):
        call_service(client)
2) Вернуть разные значения по очередиПолезно для ретраев: сначала ошибка, потом успех.from unittest.mock import Mock

def get_with_retry(client):
    try:
        return client.fetch()
    except TimeoutError:
        return client.fetch()

def test_retry_success_after_failure():
    client = Mock()
    client.fetch.side_effect = [TimeoutError(), {"ok": True}]

assert get_with_retry(client) == {"ok": True}
    assert client.fetch.call_count == 2
3) Выполнить функцию вместо мокаЭто удобно, когда хотите сохранить логику вычисления, но контролировать окружение.from unittest.mock import Mock

def test_side_effect_function():
    def fake_fetch(x):
        return {"id": x}

client = Mock()
    client.fetch.side_effect = fake_fetch

assert client.fetch(10) == {"id": 10}
Где часто ошибаются1) Слишком сложная логика в side_effectЕсли side_effect превращается в мини-сервис, тест становится тяжёлым. Лучше:держать side_effect короткимвыносить сложное в helper-функциюоставлять смысл теста очевидным2) Не проверяют количество вызововЕсли вы моделируете ретраи, важно фиксировать контракт:assert client.fetch.call_count == 2
3) Путают с return_valueЕсли нужно всегда одно значение — используйте return_value, это проще и читабельнее.Как выбирать между return_value и side_effectПеред коротким списком важно обозначить правило выбора:если поведение статичное → return_valueесли поведение меняется или нужно исключение → side_effectОдно значение всегда → return_valueИсключение → side_effect = SomeError(...)Последовательность значений → side_effect = [.., ..]Логика на аргументах → side_effect = functionКраткий выводside_effect — инструмент для моделирования “реальной жизни” в тестах: ошибок, последовательных ответов и вычисляемого поведения. Он делает тесты точнее, особенно для ретраев и обработки исключений, но его стоит держать простым и проверяемым.