Рекомендации по интеграции

Установка пакета с помощью pip

Для разработки рекомендуем использовать venv для виртуальных окружений и pip для установки приложения и всех его зависимостей, а также самого пакета pytest. Это позволит изолировать ваш код и его зависимости от системной установки Python.

Создайте файл pyproject.toml в корне репозитория, как описано в Упаковка проектов Python. Первые строки должны выглядеть так:

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "PACKAGENAME"
version = "PACKAGEVERSION"

где PACKAGENAME и PACKAGEVERSION — название и версия вашего пакета соответственно.

Затем можно установить пакет в режиме «редактирования», выполнив команду из того же каталога:

pip install -e .

это позволит изменять исходный код (как тестов, так и приложения) и запускать тесты повторно в любое время.

Соглашения об обнаружении тестов Python

pytest реализует следующие стандартные правила обнаружения тестов:

• Если аргументы не указаны, сбор начинается с testpaths (если задан) или из текущего каталога. Также можно передавать в командной строке любые сочетания каталогов, имён файлов или идентификаторов узлов.
• Рекурсивно обходить каталоги, кроме тех, которые соответствуют norecursedirs.
• В этих каталогах искать файлы test_*.py или *_test.py, импортируемые по их имени тестового пакета.

• Из этих файлов собирать тестовые элементы:

  • функции или методы тестов с префиксом test, находящиеся вне класса.
  • функции или методы тестов с префиксом test, находящиеся в классах тестов с префиксом Test (без метода __init__). Также учитываются методы, декорированные с помощью @staticmethod и @classmethods.

Примеры настройки обнаружения тестов см. в разделе Изменение стандартного обнаружения тестов Python.

В модулях Python pytest также обнаруживает тесты с помощью стандартного способа наследования от unittest.TestCase.

Выбор структуры тестов

pytest поддерживает две распространённые структуры тестов:

pyproject.toml
src/
    mypkg/
        __init__.py
        app.py
        view.py
tests/
    test_app.py
    test_view.py
    ...

# content of pytest.toml
[pytest]
addopts = ["--import-mode=importlib"]

PYTHONPATH=src pytest

[pytest]
pythonpath = ["src"]

[pytest]
pythonpath = src

pyproject.toml
[src/]mypkg/
    __init__.py
    app.py
    view.py
    tests/
        __init__.py
        test_app.py
        test_view.py
        ...

pytest --pyargs mypkg

pyproject.toml
mypkg/
    ...
tests/
    __init__.py
    foo/
        __init__.py
        test_view.py
    bar/
        __init__.py
        test_view.py

tox

Когда работа завершена и нужно убедиться, что ваш пакет проходит все тесты, стоит обратить внимание на tox — инструмент автоматизации тестирования в virtualenv. tox помогает настроить окружения virtualenv с предварительно заданными зависимостями, а затем выполнить предварительно настроенную команду тестирования с параметрами. Тесты будут запускаться для установленного пакета, а не для его исходного кода в рабочей копии, что помогает обнаружить проблемы с упаковкой.

Не запускайте через setuptools

Интеграция с setuptools не рекомендуется: не следует использовать python setup.py test или pytest-runner, и в будущем они могут перестать работать.

Этот способ объявлен устаревшим, поскольку зависит от устаревших функций setuptools и опирается на функции, нарушающие механизмы безопасности pip. Например, «setup_requires» и «tests_require» обходят pip --require-hashes. Дополнительную информацию и инструкции по миграции см. в уведомлении pytest-runner. См. также pypa/setuptools#1684.

setuptools намерен удалить команду test.

Проверка с помощью flake8-pytest-style

Чтобы убедиться, что pytest правильно используется в вашем проекте, может быть полезно воспользоваться плагином flake8 flake8-pytest-style.

flake8-pytest-style выявляет распространённые ошибки и нарушения стиля кода в тестах pytest, например неправильное использование фикстур, имён тестовых функций и маркеров. С помощью этого плагина можно обнаружить такие ошибки на ранних этапах разработки и обеспечить единообразие и удобство сопровождения тестового кода pytest.

Список проверок, выполняемых flake8-pytest-style, можно найти на его странице PyPI.

Использование строгого режима pytest

В pytest есть набор параметров конфигурации, которые делают его работу более строгой. По умолчанию эти параметры отключены для обеспечения совместимости или по другим причинам, но, если возможно, их следует включить.

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

toml

[pytest]
strict = true

ini

[pytest]
strict = true

Описание параметров, включаемых этим параметром, и их воздействия см. в документации strict.

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

toml

[pytest]
strict_config = true
strict_markers = true
strict_parametrization_ids = true
strict_xfail = true

ini

[pytest]
strict_config = true
strict_markers = true
strict_parametrization_ids = true
strict_xfail = true

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

toml

[pytest]
strict = true
strict_parametrization_ids = false

ini

[pytest]
strict = true
strict_parametrization_ids = false