Первый тест на pytest: assert, запуск и первый отчёт

Функция написана, и надо убедиться, что она работает. Знакомый ритуал: в конец файла лепится print, запускаешь скрипт, глазами сверяешь вывод с тем, что в голове. Одна функция — один print, и всё терпимо. Пять функций — пять print'ов, вывод перемешивается, и сверять уже утомительно. А пятьдесят функций — это стена текста, в которой любая ошибка тонет так же надёжно, как тонула бы без единого print.

Автотесты — это когда сверку с ожиданием берёт на себя программа. Ты один раз записываешь, что должна вернуть функция, а дальше при каждом запуске машина отвечает коротким вердиктом: работает или сломалось. Сегодня пишем первый такой тест на pytest — самом популярном тест-фреймворке Python — и научимся читать его первый отчёт.

Почему print-отладка не масштабируется

Ручная проверка устроена одинаково всегда: запустил код, посмотрел на печать, сам решил, совпало ли ожидание с реальностью. Посмотрим на этот ритуал вблизи — на примере функции сложения из будущего тестового файла.

def add(a, b):
    return a + b

print(add(2, 3))    # ждём 5
print(add(-1, 1))   # ждём 0
print(add(0, 0))    # ждём 0

У этого подхода три системные беды, и все три растут с размером проекта:

• вывод растёт вместе с кодом: пятьдесят функций — пятьдесят печатных строк, и ошибка теряется в потоке;
• сверка на человеке: правильное значение надо помнить и каждый раз сравнивать вручную — устал, отвлёкся, пропустил;
• вердикта нет: по пачке print'ов не видно общий статус — всё зелёное или что-то уже сломалось.

Автотест меняет роли: человек один раз записывает ожидание, а сверкой занимается машина при каждом запуске. Инструмент, который делает это удобно, — pytest.

assert: проверка, которая молчит

В сердце теста лежит обычный оператор Python — assert. Он принимает условие: если условие истинно, assert молчит, а если ложно — роняет программу с исключением AssertionError. Проверим молчание честно.

def add(a, b):
    return a + b

assert add(2, 3) == 5
assert add(-1, 1) == 0

print("Обе проверки прошли молча: ни одной строки вывода")

Обе проверки прошли молча: ни одной строки вывода

Ни точки, ни слова «ок» после каждой проверки — assert не болтает, а констатирует. Это свойство и делает его идеальным материалом для тестов: шум не печатается, а сбой невозможно пропустить. Посмотрим, как выглядит сбой.

def add(a, b):
    return a + b

assert add(2, 2) == 5

Traceback (most recent call last):
  File "check.py", line 5, in <module>
    assert add(2, 2) == 5
AssertionError

def add(a, b):
    return a + b

assert add(2, 2) = 5

    assert add(2, 2) = 5
                     ^
SyntaxError: invalid syntax

Первый тест: функция test_add

Тест на pytest — это обычная функция, которая подчиняется двум правилам: имя начинается с test_ и внутри есть проверки. Никаких обязательных классов, наследований и импортов фреймворка для базового сценария — вот полный тестовый файл:

def add(a, b):
    return a + b

def test_add():
    assert add(2, 3) == 5

Разбираем. add — та самая функция, которую проверяем; здесь она лежит в одном файле с тестом для простоты, а в настоящем проекте тест импортирует её из модуля. test_add — тест: имя начинается с test_, внутри одна проверка через assert. Больше ничего не нужно: ни регистрации, ни списка тестов — pytest найдёт функцию по имени сам.

Как его запустить? Дома — командой pytest в терминале из папки проекта. На этой странице работает песочница: код исполняется в браузерном интерпретаторе, и тестовый файл создаёт сам код блока, а запускать тесты вызывает pytest программно.

from pathlib import Path

Path("test_calc.py").write_text("""def add(a, b):
    return a + b

def test_add():
    assert add(2, 3) == 5
""", encoding="utf-8")

import pytest

rc = pytest.main(["test_calc.py", "-q", "--no-header", "-p", "no:cacheprovider"])
print("exit:", int(rc))

.                                                                        [100%]
1 passed in 0.02s
exit: 0

Разбираем построчно, потому что этот паттерн будет в каждом запускаемом блоке курса. Path("test_calc.py").write_text(...) — пишет тестовый файл на диск песочницы: у блока нет рук, чтобы создать файл в редакторе, поэтому он создаёт его кодом. import pytest — подключает фреймворк; в песочнице он уже установлен. pytest.main([...]) — программный запуск: список строк внутри — те же аргументы, что ты дал бы команде pytest в терминале. -q просит краткий отчёт, --no-header убирает шапку, -p no:cacheprovider — не создавать кэш-папку. Результат возвращается кодом, и print("exit:", int(rc)) печатает его последней строкой.

Код выхода — деталь, которая кажется мелочью, пока не встретишься с автоматизацией. Сервер непрерывной сборки, редактор и командные скрипты не читают человеческий отчёт — они смотрят на код возврата: ноль значит «всё зелёное, заливай», единица значит «стоп, сломалось». pytest ставит этот код автоматически, тебе ничего дописывать не нужно.

Тихий случай: тестов нет

А что увидит pytest, если в файле нет ни одной функции с именем test_? Проверим честно: положим рядом файл calc.py с обычной функцией и укажем его pytest'у.

from pathlib import Path

Path("calc.py").write_text("""def add(a, b):
    return a + b
""", encoding="utf-8")

import pytest

rc = pytest.main(["calc.py", "-q", "--no-header", "-p", "no:cacheprovider"])
print("exit:", int(rc))

no tests ran in 0.01s
exit: 5

Ни одной точки, сообщение no tests ran — и код выхода 5, а не ноль. У pytest есть целый словарь кодов возврата, и пятёрка означает «собрал ноль тестов». Это не сбой фреймворка, а честный ответ: проверить было нечего. Запомни его — он часто всплывает после опечатки в имени.

pip install pytest
pytest -q

.                                                                        [100%]
1 passed in 0.01s

Что дальше

Первый тест написан и прошёл: функция с именем test_, внутри assert, запуск через pytest.main — и понятный отчёт с точкой, сводкой и кодом выхода. Дальше по курсу: конвенции имён — какие файлы и функции pytest считает тестами и как выполнить один тест из файла; разбор падения — что pytest показывает, когда ожидание не совпало с реальностью. С каждым уроком набор растёт, а ручной пересчёт print'ов остаётся в прошлом.

Точка в отчёте pytest — это проверка, которую выполнила машина: молчаливый assert сказал больше, чем стена print'ов.