Конфигурация

pytest.toml

Файлы pytest.toml имеют приоритет над другими файлами, даже если они пусты.

В качестве альтернативы можно использовать скрытую версию .pytest.toml.

toml

# pytest.toml or .pytest.toml
[pytest]
minversion = "9.0"
addopts = ["-ra", "-q"]
testpaths = [
    "tests",
    "integration",
]

pytest.ini

Файлы pytest.ini имеют приоритет над другими файлами (кроме pytest.toml и .pytest.toml), даже если они пусты.

В качестве альтернативы можно использовать скрытую версию .pytest.ini.

ini

# pytest.ini or .pytest.ini
[pytest]
minversion = 6.0
addopts = -ra -q
testpaths =
    tests
    integration

pyproject.toml

Для конфигурации поддерживаются файлы pyproject.toml.

toml

Используйте [tool.pytest], чтобы задействовать встроенные типы TOML (поддерживается начиная с pytest 9.0):

# pyproject.toml
[tool.pytest]
minversion = "9.0"
addopts = ["-ra", "-q"]
testpaths = [
    "tests",
    "integration",
]

ini

Используйте [tool.pytest.ini_options] для конфигурации в стиле INI (поддерживается начиная с pytest 6.0):

# pyproject.toml
[tool.pytest.ini_options]
minversion = "6.0"
addopts = "-ra -q"
testpaths = [
    "tests",
    "integration",
]

Для проектов, в которых по-прежнему используются версии pytest старше 6.0, также храните minversion в pytest.ini или setup.cfg. Эти версии не читают pyproject.toml.

tox.ini

Файлы tox.ini являются файлами конфигурации проекта tox; их также можно использовать для хранения конфигурации pytest, если они содержат раздел [pytest].

ini

# tox.ini
[pytest]
minversion = 6.0
addopts = -ra -q
testpaths =
    tests
    integration

setup.cfg

Файлы setup.cfg — это файлы конфигурации общего назначения, первоначально использовавшиеся distutils (сейчас устарел) и setuptools; их также можно использовать для хранения конфигурации pytest, если они содержат раздел [tool:pytest].

ini

# setup.cfg
[tool:pytest]
minversion = 6.0
addopts = -ra -q
testpaths =
    tests
    integration

Определение rootdir

Ниже приведён алгоритм определения rootdir на основе args:

• Если в командной строке указан -c, использовать его как файл конфигурации, а его каталог — как rootdir.
• Определить общий родительский каталог для указанных args, распознанных как пути, существующие в файловой системе. Если такие пути не найдены, в качестве общего родительского каталога используется текущий рабочий каталог.
• Искать файлы pytest.toml, .pytest.toml, pytest.ini, .pytest.ini, pyproject.toml, tox.ini и setup.cfg в родительском каталоге и выше. Если найдено совпадение, этот файл становится configfile, а его каталог — rootdir.
• Если файл конфигурации не найден, искать setup.py, начиная с общего родительского каталога и двигаясь вверх, чтобы определить rootdir.
• Если setup.py не найден, искать pytest.toml, .pytest.toml, pytest.ini, .pytest.ini, pyproject.toml, tox.ini и setup.cfg в каждом из указанных args и выше. Если найдено совпадение, этот файл становится configfile, а его каталог — rootdir.
• Если configfile не найден и аргумент конфигурации не указан, использовать уже определённый общий родительский каталог в качестве корневого. Это позволяет использовать pytest в структурах, не являющихся пакетами и не имеющих специальных файлов конфигурации.

Если args не указаны, pytest собирает тесты в текущем рабочем каталоге и ниже, а также начинает определять rootdir с этого каталога.

Файлы будут рассматриваться как конфигурационные, только если:

• pytest.toml: всегда считается совпадением и имеет наивысший приоритет, даже если файл пуст.
• pytest.ini: всегда считается совпадением и имеет приоритет (после pytest.toml и .pytest.toml), даже если файл пуст.
• pyproject.toml: содержит таблицу [tool.pytest] или [tool.pytest.ini_options].
• tox.ini: содержит раздел [pytest].
• setup.cfg: содержит раздел [tool:pytest].

Наконец, файл pyproject.toml будет считаться configfile, если другие совпадения не найдены, даже если он не содержит таблицу [tool.pytest] (начиная с версии 9.0) или таблицу [tool.pytest.ini_options] (начиная с версии 8.1).

Файлы рассматриваются в указанном выше порядке. Параметры из нескольких кандидатов configfiles никогда не объединяются — используется первый найденный.

Файл конфигурации также определяет значение rootpath.

Объект Config (доступный через хуки или фикстуру pytestconfig) впоследствии будет содержать следующие атрибуты:

• config.rootpath: определённый корневой каталог, существование которого гарантировано. Он используется как базовый каталог для формирования адресов тестов («nodeid») и может также применяться плагинами для хранения данных о каждом запуске тестов.
• config.inipath: определённый configfile, может быть None (по историческим причинам называется inipath).

Пример:

pytest path/to/testdir path/other/

общим родительским каталогом будет path, после чего файлы конфигурации будут проверяться в следующем порядке:

# first look for path/pytest.toml
path/pytest.toml
path/pytest.ini
path/pyproject.toml  # must contain a [tool.pytest] table to match
path/tox.ini         # must contain [pytest] section to match
path/setup.cfg       # must contain [tool:pytest] section to match
pytest.toml
pytest.ini
... # all the way up to the root

# now look for setup.py
path/setup.py
setup.py
... # all the way up to the root