Если вы избегали написания тестов, потому что это кажется рутинной работой, это руководство по pytest должно изменить ваше мнение. Pytest устраняет большую часть церемоний: нет классов для наследования и специальных методов утверждения, которые нужно запомнить. Тест может состоять всего из двух строк.

Мы построим небольшую тележку для покупок и протестируем ее шаг за шагом. Мы запустили все на Python 3.13 с помощью pytest 9.2, и показанный результат является реальным, хотя мы сократили пути к файлам и детали синхронизации, которые могут отличаться на вашем компьютере.

Почему pytest?

Python поставляется с unittest, который работает хорошо, но обычно более удобным выбором является pytest. Вот одна и та же проверка в каждом:

Pytest также может запускать существующие тесты unittest, поэтому вы можете переключаться постепенно. Он также имеет большую экосистему плагинов, включая pytest-cov для покрытия и pytest-xdist для параллельных запусков.

Установить pytest

Сначала создайте виртуальную среду, как описано в нашем руководстве по виртуальной среде Python, а затем установите ее:

pip install pytest
pytest --version

# pytest 9.2.0

Создайте папку проекта, содержащую два файла: cart.py и test_cart.py. Pytest находит тесты автоматически по следующим правилам именования: файлы с именем test_*.py или *_test.py, функции, начинающиеся с test, и классы, начинающиеся с Test. Если тест не принимается, в первую очередь нужно проверить несоответствие имен.

Код для тестирования

# cart.py
class Cart:
    def __init__(self):
        self.items = []

    def add(self, name, price, qty=1):
        if qty < 1:
            raise ValueError("qty must be at least 1")
        self.items.append((name, price, qty))

    def total(self, discount=0):
        subtotal = sum(price * qty for _, price, qty in self.items)
        return round(subtotal * (1 - discount / 100), 2)

Ваши первые тесты

# test_cart.py
from cart import Cart

def test_empty_cart_is_free():
    assert Cart().total() == 0

Это полноценное испытание. Запустите pytest из папки проекта, и он сообщит об одном пройденном тесте. Если вы получите сообщение об ошибке импорта, запустите его как python -m pytest, при этом текущая папка будет добавлена ​​в путь импорта.

Сбои чтения

Именно здесь pytest действительно проявляет себя. Вот тест с заведомо неправильным ожидаемым значением:

def test_wrong_total():
    c = Cart()
    c.add("Keyboard", 1500)
    assert c.total() == 1400

И вот что он напечатал, когда мы его запустили:

    def test_wrong_total():
        c = Cart()
        c.add("Keyboard", 1500)
>       assert c.total() == 1400
E       assert 1500.0 == 1400
E        +  where 1500.0 = total()

FAILED fail_example.py::test_wrong_total - assert 1500.0 == 1400
============================== 1 failed in 0.12s ==============================

> обозначает линию сбоя, а строки E показывают фактические значения. Вам не нужно было добавлять собственное сообщение, поскольку pytest переписывает операторы assert, чтобы они могли сообщать о том, что они сравнивали. То же самое он делает со списками и словарями, точно указывая, какие элементы отличаются.

Исключения тестирования

Обработка ошибок — это тоже поведение, и оно заслуживает тестов. pytest.raises проходит, только если блок вызывает ожидаемое исключение:

import pytest

def test_rejects_zero_qty():
    with pytest.raises(ValueError, match="at least 1"):
        Cart().add("Pen", 10, qty=0)

Необязательный аргумент match проверяет сообщение с использованием регулярного выражения, поэтому другой аргумент ValueError не пройдет случайно. Чтобы узнать, как вызывать и обрабатывать подобные ошибки, прочитайте наше руководство по Обработке исключений Python.

Светильники: многоразовая установка

Для большинства тестов необходимо сначала что-то подготовить. фикстура — это функция, которая ее предоставляет. Украсьте его @pytest.fixture, и любой тест, который называет его аргументом, получит результат:

@pytest.fixture
def cart():
    c = Cart()
    c.add("Keyboard", 1500)
    c.add("Mouse", 500, qty=2)
    return c

def test_total(cart):
    assert cart.total() == 2500

По умолчанию каждый тест получает новую корзину, поэтому тесты не могут влиять друг на друга. Pytest сопоставляет имя аргумента с именем прибора, и вы никогда не вызываете его самостоятельно. @pytest.fixture — это декоратор, который мы объясним в Описание декораторов Python.

Очистка с выходом

Используйте yield вместо return, если вам нужно будет потом почистить. Код после yield запускается после завершения теста, даже если он не пройден:

@pytest.fixture
def temp_db():
    print("\nopen db")
    yield {"users": []}
    print("close db")

def test_db(temp_db):
    assert temp_db["users"] == []

Запуск с помощью -s для отображения распечатанных результатов подтвердил, что ордер открыт, проверьте, затем закройте.

Область действия фикстуры и conftest.py

По умолчанию прибор запускается один раз за тест. Для дорогостоящей установки, например базы данных или браузера, измените срок службы с помощью scope:

Поместите фикстуры, используемые несколькими файлами, в файл с именем conftest.py. Pytest загружает его автоматически, поэтому тесты могут использовать его фикстуры без импорта. Однако будьте осторожны с общими областями, поскольку изменения, внесенные в ходе одного теста, могут попасть в следующий.

Параметризация: один тест, много входных данных

Вместо того чтобы копировать тест для каждого значения, перечислите случаи:

@pytest.mark.parametrize("discount, expected", [
    (0, 2500),
    (10, 2250),
    (100, 0),
])
def test_discount(cart, discount, expected):
    assert cart.total(discount) == expected

Каждая строка становится отдельным тестом, и вы можете увидеть это в подробном выводе при запуске всего файла:

test_cart.py::test_total PASSED                        [ 16%]
test_cart.py::test_discount[0-2500] PASSED             [ 33%]
test_cart.py::test_discount[10-2250] PASSED            [ 50%]
test_cart.py::test_discount[100-0] PASSED              [ 66%]
test_cart.py::test_rejects_zero_qty PASSED             [ 83%]
test_cart.py::test_empty_cart_is_free PASSED           [100%]

============================== 6 passed in 0.05s ==============================

Если одна строка выходит из строя, остальные продолжают работать, и имя точно указывает, какие значения вызвали проблему. Обратите внимание, что мы объединили параметризацию с приспособлением cart. Чтобы выбрать значения, которые могут обнаружить ошибки, используйте анализ граничных значений.

Полезная встроенная фурнитура.

Pytest включает в себя несколько готовых приспособлений. Эти два особенно удобны, и оба прошли в нашем прогоне:

def test_write_report(tmp_path):
    report = tmp_path / "report.txt"
    report.write_text("passed")
    assert report.read_text() == "passed"

def read_mode():
    return os.environ.get("APP_MODE", "dev")

def test_mode(monkeypatch):
    monkeypatch.setenv("APP_MODE", "staging")
    assert read_mode() == "staging"

tmp_path предоставляет каждому тесту уникальную временную папку, поэтому тесты никогда не затрагивают реальные файлы. monkeypatch изменяет переменные или атрибуты среды и отменяет изменения после завершения теста. Еще один полезный вариант — capsys, который записывает распечатанные данные, чтобы вы могли их проверить.

Маркеры: пропустить и xfail

Маркеры добавляют метки и поведение к тестам:

@pytest.mark.skip(reason="payment sandbox is down")
def test_payment():
    assert False

@pytest.mark.xfail(reason="floating point")
def test_rounding():
    assert 0.1 + 0.2 == 0.3

skip вообще не запускает тест. xfail запускает его, но ожидает сбоя, поэтому известная проблема не нарушит вашу сборку. С учетом других дополнительных тестов в том же файле наш прогон суммировался как 3 passed, 1 skipped, 1 xfailed. Кстати, этот тест на округление действительно терпит неудачу: в арифметике с плавающей запятой 0,1 + 0,2 не совсем равно 0,3. Используйте pytest.approx(0.3) при сравнении десятичных дробей.

Вы также можете создать свои собственные маркеры, например @pytest.mark.slow, и запускать только те, у которых есть pytest -m slow, или исключить их с помощью -m "not slow". Зарегистрируйте собственные маркеры в файле конфигурации, чтобы избежать предупреждений.

Полезные флаги командной строки

Запуск pytest в CI

Тесты наиболее ценны, когда они запускаются автоматически при каждом изменении. Минимальное задание GitHub Actions выглядит так:

steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-python@v5
    with:
      python-version: "3.13"
  - run: pip install -r requirements.txt
  - run: python -m pytest

Pytest завершает работу с ненулевым кодом, когда тесты терпят неудачу, что приводит к остановке конвейера. Мы не выполняли этот файл рабочего процесса, поэтому адаптируйте его к своему проекту. Подробности объясняется в нашем руководстве по GitHub Actions CI/CD. Pytest также хорошо работает для браузерных тестов, как показывают наши руководство по Selenium Python и руководство по объектной модели страницы.

Итоги

Теперь у вас есть все, что нужно для большинства наборов тестов Python: простые утверждения, приспособления для настройки, параметризация для вариантов и несколько флагов для скорости. Начните с малого. Выберите одну функцию, в которой вы недавно исправили ошибку, и сначала напишите тест для этой ошибки. Если вы не знаете, что тестировать на каждом уровне, прочитайте о модульном и интеграционном тестировании.

Часто задаваемые вопросы

Продолжайте учиться