Release History#

v4.0.2 (2022-12-07)#

Bugfixes - 4.0.2#

  • Unescaped comma in substitution should not be replaced during INI expansion - by @gaborbernat. (#2616)

  • tox --showconfig -e py311 reports tox section, though it should not - by @gaborbernat. (#2624)

v4.0.1 (2022-12-07)#

Bugfixes - 4.0.1#

v4.0.0 (2022-12-07)#

Bugfixes - 4.0.0#

  • The temporary folder within the tox environment was named .temp instead of .tmp - by @gaborbernat. (#2608)

Improved Documentation - 4.0.0#

  • Enumerate breaking changes of tox 4 in the FAQ, and also list major new improvements - by @gaborbernat. (#2587)

  • Document in the FAQ that tox 4 will raise a warning when finding conflicting environment names - by @gaborbernat. (#2602)

v4.0.0rc4 (2022-12-06)#

Bugfixes - 4.0.0rc4#

Deprecations and Removals - 4.0.0rc4#

  • Remove deprecated configuration option whitelist_externals which was replaced by allowlist_externals - by @jugmac00. (#2599)

v4.0.0rc3 (2022-12-05)#

Features - 4.0.0rc3#

  • Add --exit-and-dump-after flag that allows automatically killing tox if does not finish within the passed seconds, and dump the thread stacks (useful to debug tox when it seemingly hangs) - by @gaborbernat. (#2595)

Bugfixes - 4.0.0rc3#

  • Ensure that two parallel tox instance invocations on different tox environment targets will work by holding a file lock onto the packaging operations (e.g., in bash tox4 r -e py311 &; tox4 r -e py310) - by @gaborbernat. (#2594)

  • Fix leaking backend processes when the build backend does not support editable wheels and fix failure when multiple environments exist that have a build backend that does not support editable wheels - by @gaborbernat. (#2595)

v4.0.0rc2 (2022-12-04)#

Features - 4.0.0rc2#

  • Support for recursive extras in Python package dependencies - by @gaborbernat. (#2567)

Bugfixes - 4.0.0rc2#

  • Support in INI files for ignore exit code marker the - without a subsequent space too - by @gaborbernat. (#2561)

  • Ensure paths constructed by tox are stable by resolving relative paths to fully qualified one, this insures that running tox from a different folder than project root still generates meaningful paths - by @gaborbernat. (#2562)

  • Ensure only on run environment operates at a time on a packaging environment (fixes unexpected failures when running in parallel mode) - by @gaborbernat. (#2564)

  • Fallback to editable-legacy if package target is editable but the build backend does not have build_editable hook - by @gaborbernat. (#2567)

  • Allow reference replacement in INI configuration via keys that contain the - character - by @gaborbernat. (#2569)

  • Resolve symlinks when saving Python executable path - by @ssbarnea. (#2574)

  • Do not set COLUMNS or LINES environment to the current TTY size if already set by the user - by @gaborbernat. (#2575)

  • Add missing build[virtualenv] test dependency - by @ssbarnea. (#2576)

v4.0.0rc1 (2022-11-29)#

Features - 4.0.0rc1#

Bugfixes - 4.0.0rc1#

  • Allow installing relative paths that go outside tox root folder. - by @ssbarnea. (#2366)

v4.0.0b3 (2022-11-27)#

Features - 4.0.0b3#

  • Improve coloring of logged commands - by @ssbarnea. (#2356)

  • Pass PROGRAMDATA, PROGRAMFILES(x86), PROGRAMFILES environments on Windows by default as it is needed for discovering the VS C++ compiler and start testing against 3.11 - by @gaborbernat. (#2492)

  • Support PEP-621 static metadata for getting package dependencies - by @gaborbernat. (#2499)

  • Add support for editable wheels, make it the default development mode and rename dev-legacy mode to editable-legacy - by @gaborbernat. (#2502)

Bugfixes - 4.0.0b3#

  • Recognize TERM=dumb or NO_COLOR environment variables. - by @ssbarnea. (#1290)

  • Allow passing config directory without filename. - by @ssbarnea. (#2340)

  • Avoid ignored explicit argument ‘re’ console message. - by @ssbarnea. (#2342)

  • Display registered plugins with tox --version - by @mxd4. (#2358)

  • Allow --hash to be specified in requirements.txt files. - by @masenf. (#2373)

  • Avoid impossible minversion version requirements. - by @ssbarnea. (#2414)

Improved Documentation - 4.0.0b3#

v4.0.0b2 (2022-04-11)#

Features - 4.0.0b2#

Bugfixes - 4.0.0b2#

  • Fix CLI raises an error for -va with ignored explicit argument 'a' - by @gaborbernat. (#2343)

  • Do not interpolate values when parsing tox.ini configuration files - by @gaborbernat. (#2350)

Improved Documentation - 4.0.0b2#

v4.0.0b1 (2022-02-05)#

Features - 4.0.0b1#

  • Display a hint for unrecognized argument CLI parse failures to use -- separator to pass arguments to commands - by @gaborbernat. (#2183)

  • Do not allow extending the config set beyond setup to ensures that all configuration values are visible via the config sub-command. - by @gaborbernat. (#2243)

  • Print a message when ignoring outcome of commands - by @gaborbernat. (#2315)

Bugfixes - 4.0.0b1#

  • Fix type annotation is broken for tox.config.sets.ConfigSet.add_config() when adding a container type - by @gaborbernat. (#2233)

  • Insert TOX_WORK_DIR, TOX_ENV_NAME, TOX_ENV_DIR and VIRTUAL_ENV into the environment variables for all tox environments to keep contract with tox version 3 - by @gaborbernat. (#2259)

  • Fix plugin initialization order - core plugins first, then 3rd party and finally inline - by @gaborbernat. (#2264)

  • Legacy parallel mode should accept -p flag without arguments - by @gaborbernat. (#2299)

  • Sequential run fails because the packaging environment is deleted twice for sequential runs with recreate flag on - by @gaborbernat. (#2300)

  • Require Python 3.10 to generate docs - by @jugmac00. (#2321)

  • Environment assignment for output breaks when using -rv (when we cannot guess upfront the verbosity level from the CLI arguments) - by @gaborbernat. (#2324)

  • devenv command does not respect specified path - by @gaborbernat. (#2325)

Improved Documentation - 4.0.0b1#

v4.0.0a10 (2022-01-04)#

Features - 4.0.0a10#

Bugfixes - 4.0.0a10#

  • Fix CTRL+C is not stopping the process on Windows - by @gaborbernat. (#2159)

  • Fix list/depends commands can create tox package environment as runtime environment and display an error message - by @gaborbernat. (PR #2234)

Deprecations and Removals - 4.0.0a10#

  • tox_add_core_config and tox_add_env_config now take a state: State argument instead of a configuration one, and Config not longer provides the envs property (instead users should migrate to State.envs) - by @gaborbernat. (PR #2275)

v4.0.0a9 (2021-09-16)#

Features - 4.0.0a9#

  • Expose the parsed CLI arguments on the main configuration object for plugins and allow plugins to define their own configuration section – by @gaborbernat. (PR #2191)

  • Let tox run fail when all envs are skipped – by @jugmac00. (#2195)

  • Expose the configuration loading mechanism to plugins to define and load their own sections. Add tox_add_env_config plugin hook called after the configuration environment is created for a tox environment and removed tox_configure. Add the main configuration object as argument to tox_add_core_config. Move the environment list method from the state to the main configuration object to allow its use within plugins – by @gaborbernat. (#2200)

  • Allow running code in plugins before and after commands via tox_before_run_commands and tox_after_run_commands plugin points – by @gaborbernat. (#2201)

  • Allow plugins to update the set_env and change the pass_env configurations – by @gaborbernat. (#2215)

Bugfixes - 4.0.0a9#

  • Fix env variable substitutions with defaults containing colon (e.g. URL) – by @comabrewer. (#2182)

  • Do not allow constructing ConfigSet directly and implement __contains__ for Loader – by @gaborbernat. (PR #2209)

  • Fix old-new value on recreate cache miss-match are swapped – by @gaborbernat. (#2211)

  • Report fails when report does not support Unicode characters – by @gaborbernat. (#2213)

Improved Documentation - 4.0.0a9#

  • Adopt furo theme, update our state diagram and description in user docs (SVG + light/dark variant), split the Python API into its own page from under the plugin page, and document plugin adoption under the tox-dev organization - by @gaborbernat. (#1881)

v4.0.0a8 (2021-08-21)#

Features - 4.0.0a8#

  • Add support for allowlist_externals, commands not matching error - by @gaborbernat. (#1127)

  • Add outcome of environments into the result json (–result-json) under the result key containing success boolean, exit_code integer and duration float value - by @gaborbernat. (#1405)

  • Add exec subcommand that allows users to run an arbitrary command within the tox environment (without needing to modify their configuration) - by @gaborbernat. (#1790)

  • Add check to validate the base Python names and the environments name do not conflict Python spec wise, when they do raise error if ignore_base_python_conflict is not set or False - by @gaborbernat. (#1840)

  • Allow any Unix shell-style wildcards expression for pass_env - by @gaborbernat. (#2121)

  • Add support for args_are_paths flag - by @gaborbernat. (#2122)

  • Add support for env_log_dir (compared to tox 3 extend content and keep only last run entries) - by @gaborbernat. (#2123)

  • Add support for {:} substitution in ini files as placeholder for the OS path separator - by @gaborbernat. (#2125)

  • When cleaning directories (for tox environment, env_log_dir, env_tmp_dir and packaging metadata folders) do not delete the directory itself and recreate, but instead just delete its content (this allows the user to cd into it and still be in a valid folder after a new run) - by @gaborbernat. (PR #2139)

  • Changes to help plugin development: simpler tox env creation argument list, expose python creation directly, allow skipping list dependencies install command for pip and executable is only part of the python cache for virtualenv - by @gaborbernat. (PR #2172)

Bugfixes - 4.0.0a8#

Improved Documentation - 4.0.0a8#

v4.0.0a7 (2021-07-28)#

Features - 4.0.0a7#

  • Add support for configuration taken from the setup.cfg file -by @gaborbernat. (#1836)

  • Add support for configuration taken from the pyproject.toml file, tox section legacy_tox_ini key - by @gaborbernat. (#1837)

  • Add configuration documentation - by @gaborbernat. (#1914)

  • Implemented [] substitution (alias for {posargs}) - by @hexagonrecursion. (#1928)

  • Implement [testenv] ignore_outcome - “a failing result of this testenv will not make tox fail” - by @hexagonrecursion. (#1947)

  • Inline plugin support via This is loaded where the tox config source is discovered. It’s a Python file that can contain arbitrary Python code, such as definition of a plugin. Eventually we’ll add a plugin that allows succinct declaration/generation of new tox environments - by @gaborbernat. (PR #1963)

  • Introduce the installer concept, and collect pip installation into a pip package, also attach to this the requirements file parsing which got a major rework - by @gaborbernat. (PR #1991)

  • Support CPython 3.10 -by @gaborbernat. (PR #2014)

Bugfixes - 4.0.0a7#

  • Environments with a platform mismatch are no longer silently skipped, but properly reported - by @jugmac00. (#1926)

  • Port pip requirements file parser to tox to achieve full equivalency (such as support for the per requirement --install-option and --global-option flags) - by @gaborbernat. (#1929)

  • Support for extras with paths for Python deps and requirement files - by @gaborbernat. (#1933)

  • Due to a bug \{posargs} {posargs} used to expand to literal {posargs} {posargs}. Now the second {posargs} is expanded. \{posargs} {posargs} expands to {posargs} positional arguments here - by @hexagonrecursion. (#1956)

  • Enable setting a different upstream repository for the coverage diff report. This has been hardcoded to upstream/rewrite until now. by @jugmac00. (#1972)

  • Enable replacements (a.k.a section substitions) for section names containing a dash in sections without the testenv: prefix - by @jugmac00, @obestwalter, @eumiro. (#1985)

  • Fix legacy list env command for empty/missing envlist - by @jugmac00. (#1987)

  • Requirements and constraints files handling got reimplemented, which should fix all open issues related to this area - by @gaborbernat. (PR #1991)

  • Use importlib instead of __import__ - by @dmendek. (#1995)

  • Evaluate factor conditions for command keys - by @jugmac00. (#2002)

  • Prefer f-strings instead of the str.format method - by @eumiro. (#2012)

  • Fix regex validation for SHA 512 hashes - by @jugmac00. (#2018)

  • Actually run all environments when ALL is provided to the legacy env command - by @jugmac00. (#2112)

  • Move from appdirs to platformdirs - by @gaborbernat. (PR #2117)

  • Move from toml to tomli - by @gaborbernat. (PR #2118)

Improved Documentation - 4.0.0a7#

v4.0.0a6 (2021-02-15)#

Features - 4.0.0a6#

  • Add basic quickstart implementation (just use pytest with the current Python version) - by @gaborbernat. (#1829)

  • Support comments via the # character within the ini configuration (to force a literal # use \#) - by @gaborbernat. (#1831)

  • Add support for the install_command settings in the virtual env test environments - by @gaborbernat. (#1832)

  • Add support for the package_root setupdir ( Python scoped) configuration that sets the root directory used for packaging (the location of the historical and modern pyproject.toml). This can be set at root level, or at tox environment level (the later takes precedence over the former) - by @gaborbernat. (#1838)

  • Implement support for the --installpkg CLI flag - by @gaborbernat. (#1839)

  • Add support for the list_dependencies_command settings in the virtual env test environments - by @gaborbernat. (#1842)

  • Add support for the ignore_errors settings in tox test environments - by @gaborbernat. (#1843)

  • Add support for the pip_pre settings for virtual environment based tox environments - by @gaborbernat. (#1844)

  • Add support for the platform settings in tox test environments - by @gaborbernat. (#1845)

  • Add support for the recreate settings in tox test environments - by @gaborbernat. (#1846)

  • Allow Python test and packaging environments with version 2.7 - by @gaborbernat. (PR #1900)

  • Do not construct a requirements file for deps in virtualenv, instead pass content as CLI argument to pip - by @gaborbernat. (PR #1906)

  • Do not display status update environment reports when interrupted or for the final environment ran (because at the final report will be soon printed and makes the status update redundant) - by @gaborbernat. (#1909)

  • The _TOX_SHOW_THREAD environment variable can be used to print alive threads when tox exists (useful to debug when tox hangs because of some non-finished thread) and also now prints the pid of the local subprocess when reporting the outcome of a execution - by @gaborbernat. (PR #1915)

Bugfixes - 4.0.0a6#

  • Normalize description text to collapse newlines and one or more than whitespace to a single space - by @gaborbernat. (#1829)

  • Support aliases in show config key specification (will print with the primary key) - by @gaborbernat. (#1831)

  • Show config no longer marks as unused keys that are inherited (e.g. if the key is coming from testenv section and our target is testenv:fix) - by @gaborbernat. (#1833)

  • --alwayscopy and --sitepackages legacy only flags do not work - by @gaborbernat. (#1839)

  • Fix handling of commands_pre/commands/commands_post to be in line with tox 3 (returned incorrect exit codes and post was not always executed) - by @gaborbernat. (#1843)

  • Support requirement files containing --hash constraints - by @gaborbernat. (#1903)

  • Fix a bug that caused tox to never finish when pulling configuration from a tox run environment that was never executed - by @gaborbernat. (PR #1915)

Deprecations and Removals - 4.0.0a6#

    • Drop support for sdistsrc flag because introduces a significant complexity and is barely used (5 hits on a github search).

    • --skip-missing-interpreters, --notest, --sdistonly, --installpkg, --develop and --skip-pkg-install CLI flags are no longer available for devenv (enforce the only sane value for these).

    By @gaborbernat (#1839)

  • Remove Jenkins override support: this feature goes against the spirit of tox - blurring the line between the CI and local runs. It also singles out a single CI provider, which opens the door for other CIs wanting similar functionality. Finally, only 54 code file examples came back on a Github search, showing this is a not widely used feature. People who still want Jenkins override support may create a tox plugin to achieve this functionality - by @gaborbernat. (#1841)

v4.0.0a5 (2021-01-23)#

Features - 4.0.0a5#

  • Support the system_site_packages/sitepackages flag for virtual environment based tox environments - by @gaborbernat. (#1847)

  • Support the always_copy/alwayscopy flag for virtual environment based tox environments - by @gaborbernat. (#1848)

  • Support the download flag for virtual environment based tox environments - by @gaborbernat. (#1849)

  • Recreate virtual environment based tox environments when the virtualenv version changes - by @gaborbernat. (#1865)

Bugfixes - 4.0.0a5#

  • Not all package dependencies are installed when different tox environments in the same run use different set of extras - by @gaborbernat. (#1868)

  • Support = separator in requirement file flags, directories as requirements and correctly set the root of the requirements file when using the --root CLI flag to change the root - by @gaborbernat. (#1853)

  • Cleanup local subprocess file handlers when exiting runs (fixes ResourceWarning: unclosed file errors when running with env PYTHONTRACEMALLOC=5 PYTHONDEVMODE=y under a Python built with --with-pydebug) - by @gaborbernat. (#1857)

  • Various small bugfixes:

    • honor updating default environment variables set by internal tox via set env (PIP_DISABLE_PIP_VERSION_CHECK)

    • do not multi-wrap HandledError in the ini file loader,

    • skipped environments are logged now with their fail message at default verbosity level,

    • fix an error that made the show configuration command crash when making the string of a config value failed,

    • support empty-new lines within the set env configurations replacements,

    by @gaborbernat. (PR #1864)

Improved Documentation - 4.0.0a5#

v4.0.0a4 (2021-01-16)#

Features - 4.0.0a4#

  • Use .tox/4 instead of .tox4 folder (so ignores for tox 3 works for tox 4 too), reminder we’ll rename this to just .tox before public release, however to encourage testing tox 4 in parallel with tox 3 this is helpful - by @gaborbernat. (#1812)

  • Colorize the config command: section headers are yellow, keys are green, values remained white, exceptions are light red and comments are cyan - by @gaborbernat. (PR #1821)

Bugfixes - 4.0.0a4#

  • Support legacy format (-cconstraint.txt) of constraint files in deps, and expand constraint files too when viewing inside the deps or calculating weather our environment is up to date or not - by @gaborbernat. (#1788)

  • When specifying requirements/editable/constraint paths within deps escape space, unless already escaped to support running specifying transitive requirements files within deps - by @gaborbernat. (#1792)

  • When using a provisioned tox environment requesting --recreate failed with AttributeError - by @gaborbernat. (#1793)

  • Fix RequirementsFile from tox is rendered incorrectly in config command - by @gaborbernat. (#1820)

  • Fix a bug in the configuration system where referring to the same named key in another env/section causes circular dependency error - by @gaborbernat. (PR #1821)

  • Raise ValueError with descriptive message when a requirements file specified does not exist - by @gaborbernat. (PR #1828)

  • Support all valid requirement file specification without delimiting space in the deps of the tox.ini - by @gaborbernat. (#1834)

Improved Documentation - 4.0.0a4#

v4.0.0a3 (2021-01-13)#

Features - 4.0.0a3#

  • Raise exception when set env enters into a circular reference - by @gaborbernat. (#1779)

    • Raise exception when variable substitution enters into a circle.

    • Add {/} as substitution for os specific path separator.

    • Add {env_bin_dir} constant substitution.

    • Implement support for --discover flag - by @gaborbernat. (PR #1784)

Bugfixes - 4.0.0a3#

  • Entries in the set_env does not reference environments from set_env - by @gaborbernat. (#1776)

  • env substitution does not uses values from set_env - by @gaborbernat. (#1779)

  • Adopt tox 3 base pass env list, by adding:


    • on Windows: SYSTEMDRIVE - by @gaborbernat. (#1780)

  • Fixed a bug that crashed tox where calling tox with the recreate flag and when multiple environments were reusing the same package - by @gaborbernat. (#1782)

    • Python version markers are stripped in package dependencies (after wrongfully being detected as an extra marker).

    • In packaging APIs do not set PYTHONPATH (to empty string) if backend-path is empty.

    • Fix commands parsing on Windows (do not auto-escape \ - instead users should use the new {\}, and on parsed arguments strip both ' and " quoted outcomes).

    • Allow windows paths in substitution set/default (the : character used to separate substitution arguments may also be present in paths on Windows - do not support single capital letter values as substitution arguments) - by @gaborbernat. (PR #1784)

  • Rework how we handle Python packaging environments:

    • the base packaging environment changed from .package to .pkg,

    • merged the sdist, wheel and dev separate packaging implementations into one, and internally dynamically pick the one that’s needed,

    • the base packaging environment always uses the same Python environment as tox is installed into,

    • the base packaging environment is used to get the metadata of the project (via PEP-517) and to build sdist and dev packages,

    • for building wheels introduced a new per env configurable option wheel_build_env, if the target Python major/minor and implementation for the run tox environment and the base package tox environment matches set this to .pkg, otherwise this is .pkg-{implementation}{major}{minor},

    • internally now packaging environments can create further packaging environments they are responsible of managing,

    • updated depends to use the packaging logic,

    • add support skip missing interpreters for depends and show config,

    by @gaborbernat. (#1804)

v4.0.0a2 (2021-01-09)#

Features - 4.0.0a2#

  • Add option to disable colored output, and support NO_COLOR and FORCE_COLOR environment variables - by @gaborbernat. (PR #1630)

Bugfixes - 4.0.0a2#

  • Fix coverage generation in CI - by @gaborbernat. (PR #1551)

  • Fix the CI failures:

    • drop Python 3.5 support as it’s not expected to get to a release before EOL,

    • fix test using \n instead of os.linesep,

    • Windows Python 3.6 does not contain _overlapped.ReadFileInto

    • by @gaborbernat. (PR #1556)

Improved Documentation - 4.0.0a2#


  • First version all is brand new.


The current tox is the second iteration of implementation. From version 0.5 all the way to 3.X we numbered the first iteration. Version 4.0.0a1 is a complete rewrite of the package, and as such this release history starts from there. The old changelog is still available in the legacy branch documentation.