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

pytest.ini¶

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

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

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

pyproject.toml¶

pyproject.toml рассматриваются для конфигурации, если они содержат таблицу tool.pytest.ini_options.

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

tox.ini¶

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

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

setup.cfg¶

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

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

Нахождение rootdir¶

Вот алгоритм, который находит rootdir из args:

• Если в командной строке передано -c, используйте его как конфигурационный файл, а его каталог как rootdir.

• Определить общий каталог-предок для указанных args, которые распознаются как пути, существующие в файловой системе. Если таких путей не найдено, общий каталог-предок устанавливается в текущий рабочий каталог.

• Ищите файлы pytest.ini, pyproject.toml, tox.ini и setup.cfg в каталоге-предке и выше. Если один из них найден, он становится configfile, а его каталог становится rootdir.

• Если конфигурационный файл не найден, ищите setup.py вверх по каталогу общего предка, чтобы определить rootdir.

• Если не найдено ни одного setup.py, ищите pytest.ini, pyproject.toml, tox.ini и setup.cfg в каждом из указанных args и выше. Если один из них найден, он становится configfile, а его каталог становится rootdir.

• Если не найдено configfile и не передан аргумент конфигурации, то в качестве корневого каталога используется уже определенный общий предок. Это позволяет использовать pytest в структурах, которые не являются частью пакета и не имеют определенного конфигурационного файла.

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

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

• pytest.ini: всегда будет соответствовать и иметь приоритет, даже если он пуст.

• pyproject.toml: содержит таблицу [tool.pytest.ini_options].

• tox.ini: содержит раздел [pytest].

• setup.cfg: содержит раздел [tool:pytest].

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

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

• config.rootpath: определенный корневой каталог, гарантированно существующий.

• config.inipath: определенный configfile, может быть None (он назван inipath по историческим причинам).

Каталог rootdir используется в качестве справочного каталога для построения адресов тестов («nodeids») и может также использоваться плагинами для хранения информации о каждом запуске теста.

Пример:

pytest path/to/testdir path/other/

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

# first look for pytest.ini files
path/pytest.ini
path/pyproject.toml  # must contain a [tool.pytest.ini_options] table to match
path/tox.ini         # must contain [pytest] section to match
path/setup.cfg       # must contain [tool:pytest] section to match
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