Знаете это чувство, когда вы копируете блок кода из одного теста в другой, а потом еще десять раз? А потом меняете имя переменной или способ создания объекта, и вам приходится править все эти копии, рискуя что-то упустить. Это боль. Именно для этого существуют фикстуры в pytest. Это механизм, который позволяет вынести подготовку окружения за пределы самих тестов, сделать код чище и не повторять себя.
Если вы только начинаете работать с pytest, фикстуры могут показаться магией. Но на самом деле всё логично до предела. Фикстура - это функция, которая подготавливает данные или ресурсы перед запуском теста и, если нужно, убирает их после. Никаких сложных классов setUp/tearDown, никаких наследований ради наследования. Просто функции.
Что такое фикстура и зачем она нужна
Представьте, что у вас есть приложение для управления задачами. В каждом тесте вам нужен объект пользователя и список задач для него. Без фикстур вы будете каждый раз писать:
- Создать пользователя.
- Сохранить его в базу данных (или мок).
- Создать несколько задач.
- Привязать задачи к пользователю.
Это скучно и хрупко. С фикстурой вы пишете эту логику один раз, называете её понятным именем, например, `user_with_tasks`, и просто вызываете её в параметрах теста. Pytest сам поймет, что вы хотите использовать эту фикстуру, выполнит её и передаст результат в ваш тест.
| Критерий | Без фикстур | С фикстурами |
|---|---|---|
| Читаемость кода | Низкая, много boilerplate-кода | Высокая, тест фокусируется на проверке |
| Поддержка изменений | Приходится менять во всех тестах | Меняем только фикстуру |
| Переиспользование | Копипаста или сложные классы | Простое вызов по имени |
| Изоляция | Зависит от дисциплины автора | Гарантируется механизмом scope |
Как создать первую фикстуру
Давайте напишем простую фикстуру. Допустим, нам нужен временный файл для тестов записи логов. Мы создадим функцию, decorated декоратором `@pytest.fixture`.
import pytest
import tempfile
import os
@pytest.fixture
def temp_log_file():
# Подготовка: создаем временный файл
fd, path = tempfile.mkstemp(suffix='.log')
yield path # Передаем путь в тест
# Очистка: удаляем файл после теста
os.close(fd)
os.remove(path)
def test_write_to_log(temp_log_file):
with open(temp_log_file, 'w') as f:
f.write('Test message')
assert os.path.exists(temp_log_file)
Обратите внимание на ключевое слово `yield`. Всё, что написано до `yield`, выполняется перед тестом. То, что после - после завершения теста, даже если тест упал с ошибкой. Это идеально для очистки ресурсов: закрытия соединений, удаления файлов, отката транзакций в базе данных.
Если вам не нужна очистка, можно просто вернуть значение через `return`. Но лучше привыкнуть к паттерну setup-teardown через `yield`. Это спасает нервы, когда тесты начинают падать из-за "грязного" состояния системы.
Где хранить фикстуры: сила conftest.py
По умолчанию фикстура видна только в том файле, где она объявлена. Если вы захотите использовать её в другом модуле, придется импортировать. Импортировать фикстуры можно, но это лишает код части elegance. Есть лучший способ.
Pytest автоматически подхватывает фикстуры из файла `conftest.py`. Этот файл должен лежать в той же директории, что и ваши тесты, или выше по иерархии папок. Что происходит дальше? Магия области видимости. Любая фикстура из `conftest.py` становится доступной всем тестам в этой директории и ее поддиректориях.
Например, у вас такая структура проекта:
project/
├── tests/
│ ├── unit/
│ │ ├── test_math.py
│ │ └── conftest.py <-- здесь фикстура math_data
│ └── integration/
│ ├── test_db.py
│ └── conftest.py <-- здесь фикстура db_connection
└── src/
В `test_math.py` вы можете спокойно использовать фикстуру `math_data`, определенную в соседнем `conftest.py`, без всяких импортов. А фикстуру `db_connection` из интеграционных тестов вы там не увидите, потому что она лежит в другой ветке дерева. Это дает отличную изоляцию и порядок.
Scope фикстур: от function до session
Одна из самых мощных, но часто недооцененных возможностей - это контроль жизненного цикла фикстуры через параметр `scope`. По умолчанию фикстура создается заново для каждого теста (`function`). Но иногда это избыточно.
Допустим, вы тестируете API. Создание нового клиента HTTP для каждого из 100 тестов - это дорого и медленно. Вы хотите создать клиент один раз для всего запуска тестов. Для этого используйте `scope='session'`.
@pytest.fixture(scope='session')
def api_client():
client = APIClient(base_url='http://localhost:8000')
yield client
client.close()
Вот основные уровни scope, которые стоит знать:
- function (по умолчанию): Новая фикстура для каждого теста. Максимальная изоляция.
- class: Одна фикстура на все методы внутри класса-теста. Полезно, если тесты в классе сильно связаны.
- module: Одна фикстура на весь Python-файл с тестами. Хорошо для общих моков или статических данных.
- package: Одна фикстура на пакет (директорию с `__init__.py`). Редко используется, но полезно для групповой подготовки.
- session: Одна фикстура на весь запуск pytest. Идеально для дорогих ресурсов: подключения к БД, запуска Docker-контейнеров, загрузки больших датасетов.
Выбор scope влияет на скорость и стабильность. Слишком широкий scope может привести к тому, что один тест испортит состояние для других. Например, если вы используете `scope='session'` для базы данных, но не очищаете таблицы между тестами, результаты станут непредсказуемыми. Правило простое: используйте самый узкий возможный scope, который обеспечивает корректную работу.
Параметризация фикстур
Иногда одна фикстура должна возвращать разные значения в зависимости от контекста. Здесь помогает параметризация самой фикстуры. Представьте, что вы тестируете парсер CSV-файлов. У вас есть три разных формата файлов, которые нужно проверить.
Вместо того чтобы писать три отдельных теста, вы можете параметризовать фикстуру, которая предоставляет содержимое файла.
@pytest.fixture(params=['csv', 'json', 'xml'])
def data_format(request):
return request.param
def test_parser(data_format):
parser = get_parser(data_format)
assert parser is not None
Pytest запустит `test_parser` три раза: один раз с `'csv'`, один с `'json'` и один с `'xml'`. В отчете о результатах вы увидите три отдельные проверки. Это делает тесты более информативными и гибкими.
Есть также возможность комбинировать фикстуры. Одна фикстура может зависеть от другой. Например, фикстура `authenticated_user` может вызывать фикстуру `api_client` и фикстуру `valid_credentials`. Pytest сам разберется с порядком выполнения зависимостей.
Типичные ошибки и как их избежать
Новички часто сталкиваются с несколькими проблемами при работе с фикстурами. Вот самые частые грабли.
Забыли про очистку. Если вы создаете файлы или соединения, но не закрываете их в блоке после `yield`, ресурсы утекают. При большом количестве тестов это может забить память или исчерпать лимит открытых файлов в ОС.
Слишком широкие scope. Как уже говорилось, использование `scope='session'` для чего-то, что должно быть изолированным, приводит к флейкивым (нестабильным) тестам. Тест проходит сегодня, а завтра падает, потому что предыдущий тест оставил мусор.
Имена-однозначности. Называйте фикстуры понятно. `fixture_1` или `data` - плохие имена. `mock_payment_gateway` или `sample_user_payload` - хорошие. Читаемость тестов напрямую зависит от читаемости имен фикстур.
Игнорирование автоматического обнаружения. Не пытайтесь вручную вызывать фикстуры как обычные функции, если они нужны только для инъекции в тесты. Пусть pytest управляет их жизненным циклом. Исключение - если вы используете фикстуру внутри другой фикстуры, тогда да, вы вызываете её явно.
Практические советы для продакшена
Когда проект растет, количество фикстур увеличивается. Чтобы не превратить `conftest.py` в свалку, следуйте нескольким принципам.
Разделяйте фикстуры по уровням абстракции. Низкоуровневые фикстуры (подключение к БД, создание клиента) должны быть общими и находиться в корневом `conftest.py`. Высокоуровневые фикстуры (например, `admin_user_with_orders`) специфичны для конкретных модулей и должны лежать рядом с соответствующими тестами.
Используйте фикстуры для моков. Библиотека `unittest.mock` отлично интегрируется с pytest. Можно создать фикстуру, которая патчит внешние сервисы, и гарантировать, что все тесты используют одинаковые заглушки.
Не бойтесь длинных цепочек фикстур. Если фикстура A зависит от B, а B от C - это нормально. Главное, чтобы каждая фикстура делала одну конкретную вещь. Принцип единственной ответственности работает и здесь.
И последнее: документируйте свои фикстуры. Добавьте docstring к каждой фикстуре. Объясните, что она возвращает, какого типа данные и есть ли у нее побочные эффекты. Через полгода вы скажете себе спасибо.
Можно ли использовать фикстуры без pytest?
Нет, фикстуры - это специфическая концепция фреймворка pytest. В стандартном unittest используются методы setUp и tearDown, которые работают иначе и требуют наследования от TestCase. Однако многие возможности фикстур можно частично воспроизвести с помощью контекстных менеджеров или фабрик объектов, но это будет менее удобно.
Как отладить фикстуру, если она падает?
Запустите тесты с флагом `-s`, чтобы увидеть print-вывод, и `-v` для подробного вывода. Если фикстура падает на этапе настройки, pytest сообщит об этом отдельно от самого теста. Также полезно временно добавить try-except блоки внутри фикстуры для логирования ошибок, хотя в финальной версии кода их обычно убирают.
Что делать, если фикстура нужна в нескольких проектах?
Создайте отдельный Python-пакет с общими фикстурами и опубликуйте его в вашем внутреннем репозитории или PyPI. Затем установите этот пакет в ваших проектах. В conftest.py вы сможете импортировать фикстуры из этого пакета, используя синтаксис `from my_fixtures import common_fixture`. Или используйте плагин `pytest-plugins`, который позволяет регистрировать фикстуры глобально.
Можно ли передавать параметры в фикстуру из командной строки?
Да, через опцию `--fixtures` или используя пользовательские аргументы. Вы можете определить свой аргумент в `conftest.py` с помощью `parser.addoption('--env', default='dev')`, а затем создать фикстуру, которая читает это значение: `def env(request): return request.config.getoption('--env')`. Это позволяет запускать одни и те же тесты против разных окружений.
Как избежать дублирования кода между фикстурами?
Используйте композицию. Если две фикстуры имеют общую часть логики, вынесите эту часть в обычную вспомогательную функцию (не фикстуру) и вызывайте её из обеих фикстур. Или сделайте одну фикстуру зависимой от другой. Избегайте копипасты внутри тел фикстур.