tox

tox configuration for automating Python testing and task management

Type object
File match tox.toml
Schema URL https://catalog.lintel.tools/schemas/schemastore/tox/latest.json
Source https://raw.githubusercontent.com/tox-dev/tox/main/src/tox/tox.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

tox configuration file (tox.toml or [tool.tox] in pyproject.toml)

Properties

tox_root string

the root directory (where the configuration file is found)

toxinidir string

the root directory (where the configuration file is found)

work_dir string

working directory

toxworkdir string

working directory

temp_dir string

a folder for temporary files (is not cleaned at start)

env_list subs | object[]

define environments to automatically run

envlist subs | object[]

define environments to automatically run

base subs[]

inherit missing keys from these sections

min_version string

Define the minimal tox version required to run

minversion string

Define the minimal tox version required to run

provision_tox_env string

Name of the virtual environment used to provision a tox.

requires subs[]

Name of the virtual environment used to provision a tox.

labels Record<string, subs | object[]>

core labels

ignore_base_python_conflict boolean

do not raise error if the environment name conflicts with base python

ignore_basepython_conflict boolean

do not raise error if the environment name conflicts with base python

skip_missing_interpreters boolean

skip running missing interpreters

no_package boolean

is there any packaging involved in this project

skipsdist boolean

is there any packaging involved in this project

package_env string

tox environment used to package

isolated_build_env string

tox environment used to package

package_root string

indicates where the packaging root file exists (historically setup.py file or pyproject.toml now)

setupdir string

indicates where the packaging root file exists (historically setup.py file or pyproject.toml now)

env_run_base object

base configuration for run environments

62 nested properties
set_env Record<string, string | object | object>

environment variables to set when running commands in the tox environment

setenv Record<string, string | object | object>

environment variables to set when running commands in the tox environment

base subs[]

inherit missing keys from these sections

runner string

the tox execute used to evaluate this environment

description string

description attached to the tox environment

depends subs | object[]

tox environments that this environment depends on (must be run after those)

labels subs[]

labels attached to the tox environment

env_dir string

directory assigned to the tox environment

envdir string

directory assigned to the tox environment

env_tmp_dir string

a folder that is always reset at the start of the run

envtmpdir string

a folder that is always reset at the start of the run

env_log_dir string

a folder for logging where tox will put logs of tool invocation

envlogdir string

a folder for logging where tox will put logs of tool invocation

suicide_timeout number

timeout to allow process to exit before sending SIGINT

interrupt_timeout number

timeout before sending SIGTERM after SIGINT

terminate_timeout number

timeout before sending SIGKILL after SIGTERM

platform string

run on platforms that match this regular expression (empty means any platform)

pass_env subs[]

environment variables to pass on to the tox environment

passenv subs[]

environment variables to pass on to the tox environment

disallow_pass_env subs[]

environment variable patterns to exclude after pass_env glob expansion

parallel_show_output boolean

if set to True the content of the output will always be shown when running in parallel mode

recreate boolean

always recreate virtual environment if this option is true, otherwise leave it up to tox

allowlist_externals subs[]

external command glob to allow calling

list_dependencies_command subs[]

command used to list installed packages

pip_pre boolean

install the latest available pre-release (alpha/beta/rc) of dependencies without a specified version

install_command subs[]

command used to install packages

constraints string

constraints to apply to installed python dependencies

constrain_package_deps boolean

If true, apply constraints during install_package_deps.

use_frozen_constraints boolean

Use the exact versions of installed deps as constraints, otherwise use the listed deps.

commands_pre subs[][]

the commands to be called before testing

commands subs[][]

the commands to be called for testing

commands_post subs[][]

the commands to be called after testing

interrupt_post_commands boolean

run commands_post even after interrupt (SIGINT), allow second interrupt to cancel

recreate_commands subs[][]

commands to run before the environment is removed during recreation (e.g. cache cleanup)

change_dir string

change to this working directory when executing the test command

changedir string

change to this working directory when executing the test command

args_are_paths boolean

if True rewrite relative posargs paths from cwd to change_dir

ignore_errors boolean

when executing the commands keep going even if a sub-command exits with non-zero exit code

commands_retry integer

number of times to retry a failed command (0 means no retries)

min=0
ignore_outcome boolean

if set to true a failing result of this testenv will not make tox fail (instead just warn)

fail_fast boolean

if set to true, tox will stop executing remaining environments when this environment fails

default_base_python subs[] | string

fallback python interpreter used when no factor or explicit base_python is defined

base_python_file subs[] | string

file(s) containing the Python version to use (e.g. .python-version), first one found wins; used when base_python is not explicitly set and the env name has no Python factor

base_python subs[] | string

environment identifier for python, first one found wins

basepython subs[] | string

environment identifier for python, first one found wins

deps string

python dependencies with optional version specifiers, as specified by PEP-440

dependency_groups subs[]

dependency groups to install of the target package

extras subs[]

extras to install of the target package

pylock string

PEP 751 pylock.toml lock file path to install locked dependencies from

extra_setup_commands subs[][]

commands to execute after setup (deps and package install) but before test commands

skip_missing_interpreters boolean

override core skip_missing_interpreters for this environment

system_site_packages boolean

create virtual environments that also have access to globally installed packages.

sitepackages boolean

create virtual environments that also have access to globally installed packages.

always_copy boolean

force virtualenv to always copy rather than symlink

alwayscopy boolean

force virtualenv to always copy rather than symlink

download boolean

true if you want virtualenv to upgrade pip/wheel/setuptools to the latest version

virtualenv_spec string

PEP 440 version spec for virtualenv (e.g. virtualenv<20.22.0). When set, tox bootstraps this version in an isolated environment and runs it via subprocess, enabling Python versions incompatible with the installed virtualenv.

skip_install boolean

skip installation

use_develop boolean

use develop mode

usedevelop boolean

use develop mode

package string

package installation mode - wheel | sdist | sdist-wheel | editable | editable-legacy | deps-only | skip | external

package_env string

tox environment used to package

env_pkg_base object

base configuration for run environments

62 nested properties
set_env Record<string, string | object | object>

environment variables to set when running commands in the tox environment

setenv Record<string, string | object | object>

environment variables to set when running commands in the tox environment

base subs[]

inherit missing keys from these sections

runner string

the tox execute used to evaluate this environment

description string

description attached to the tox environment

depends subs | object[]

tox environments that this environment depends on (must be run after those)

labels subs[]

labels attached to the tox environment

env_dir string

directory assigned to the tox environment

envdir string

directory assigned to the tox environment

env_tmp_dir string

a folder that is always reset at the start of the run

envtmpdir string

a folder that is always reset at the start of the run

env_log_dir string

a folder for logging where tox will put logs of tool invocation

envlogdir string

a folder for logging where tox will put logs of tool invocation

suicide_timeout number

timeout to allow process to exit before sending SIGINT

interrupt_timeout number

timeout before sending SIGTERM after SIGINT

terminate_timeout number

timeout before sending SIGKILL after SIGTERM

platform string

run on platforms that match this regular expression (empty means any platform)

pass_env subs[]

environment variables to pass on to the tox environment

passenv subs[]

environment variables to pass on to the tox environment

disallow_pass_env subs[]

environment variable patterns to exclude after pass_env glob expansion

parallel_show_output boolean

if set to True the content of the output will always be shown when running in parallel mode

recreate boolean

always recreate virtual environment if this option is true, otherwise leave it up to tox

allowlist_externals subs[]

external command glob to allow calling

list_dependencies_command subs[]

command used to list installed packages

pip_pre boolean

install the latest available pre-release (alpha/beta/rc) of dependencies without a specified version

install_command subs[]

command used to install packages

constraints string

constraints to apply to installed python dependencies

constrain_package_deps boolean

If true, apply constraints during install_package_deps.

use_frozen_constraints boolean

Use the exact versions of installed deps as constraints, otherwise use the listed deps.

commands_pre subs[][]

the commands to be called before testing

commands subs[][]

the commands to be called for testing

commands_post subs[][]

the commands to be called after testing

interrupt_post_commands boolean

run commands_post even after interrupt (SIGINT), allow second interrupt to cancel

recreate_commands subs[][]

commands to run before the environment is removed during recreation (e.g. cache cleanup)

change_dir string

change to this working directory when executing the test command

changedir string

change to this working directory when executing the test command

args_are_paths boolean

if True rewrite relative posargs paths from cwd to change_dir

ignore_errors boolean

when executing the commands keep going even if a sub-command exits with non-zero exit code

commands_retry integer

number of times to retry a failed command (0 means no retries)

min=0
ignore_outcome boolean

if set to true a failing result of this testenv will not make tox fail (instead just warn)

fail_fast boolean

if set to true, tox will stop executing remaining environments when this environment fails

default_base_python subs[] | string

fallback python interpreter used when no factor or explicit base_python is defined

base_python_file subs[] | string

file(s) containing the Python version to use (e.g. .python-version), first one found wins; used when base_python is not explicitly set and the env name has no Python factor

base_python subs[] | string

environment identifier for python, first one found wins

basepython subs[] | string

environment identifier for python, first one found wins

deps string

python dependencies with optional version specifiers, as specified by PEP-440

dependency_groups subs[]

dependency groups to install of the target package

extras subs[]

extras to install of the target package

pylock string

PEP 751 pylock.toml lock file path to install locked dependencies from

extra_setup_commands subs[][]

commands to execute after setup (deps and package install) but before test commands

skip_missing_interpreters boolean

override core skip_missing_interpreters for this environment

system_site_packages boolean

create virtual environments that also have access to globally installed packages.

sitepackages boolean

create virtual environments that also have access to globally installed packages.

always_copy boolean

force virtualenv to always copy rather than symlink

alwayscopy boolean

force virtualenv to always copy rather than symlink

download boolean

true if you want virtualenv to upgrade pip/wheel/setuptools to the latest version

virtualenv_spec string

PEP 440 version spec for virtualenv (e.g. virtualenv<20.22.0). When set, tox bootstraps this version in an isolated environment and runs it via subprocess, enabling Python versions incompatible with the installed virtualenv.

skip_install boolean

skip installation

use_develop boolean

use develop mode

usedevelop boolean

use develop mode

package string

package installation mode - wheel | sdist | sdist-wheel | editable | editable-legacy | deps-only | skip | external

package_env string

tox environment used to package

env object

per-environment overrides (keyed by environment name)

legacy_tox_ini string

tox configuration in INI format embedded in a TOML file

Definitions

subs string | object | object