Changelog
### 3.21.1
```
--------------------
Bugfixes
^^^^^^^^
- Fix regression that broke using install_command in config replacements - by :user:`jayvdb`
`1777 <https://github.com/tox-dev/tox/issues/1777>`_
- Fix regression parsing posargs default containing colon. - by :user:`jayvdb`
`1785 <https://github.com/tox-dev/tox/issues/1785>`_
Features
^^^^^^^^
- Prevent .tox in envlist - by :user:`jayvdb`
`1684 <https://github.com/tox-dev/tox/issues/1684>`_
Miscellaneous
^^^^^^^^^^^^^
- Enable building tox with ``setuptools_scm`` 4 and 5 by :user:hroncok
`1799 <https://github.com/tox-dev/tox/issues/1799>`_
```
### 3.21.0
```
--------------------
Bugfixes
^^^^^^^^
- Fix the false ``congratulations`` message that appears when a ``KeyboardInterrupt`` occurs during package installation. - by :user:`gnikonorov`
`1453 <https://github.com/tox-dev/tox/issues/1453>`_
- Fix ``platform`` support for ``install_command``. - by :user:`jayvdb`
`1464 <https://github.com/tox-dev/tox/issues/1464>`_
- Fixed regression in v3.20.0 that caused escaped curly braces in setenv
to break usage of the variable elsewhere in tox.ini. - by :user:`jayvdb`
`1690 <https://github.com/tox-dev/tox/issues/1690>`_
- Prevent ``{}`` and require ``{:`` is only followed by ``}``. - by :user:`jayvdb`
`1711 <https://github.com/tox-dev/tox/issues/1711>`_
- Raise ``MissingSubstitution`` on access of broken ini setting. - by :user:`jayvdb`
`1716 <https://github.com/tox-dev/tox/issues/1716>`_
Features
^^^^^^^^
- Allow \{ and \} in default of {env:key:default}. - by :user:`jayvdb`
`1502 <https://github.com/tox-dev/tox/issues/1502>`_
- Allow {posargs} in setenv. - by :user:`jayvdb`
`1695 <https://github.com/tox-dev/tox/issues/1695>`_
- Allow {/} to refer to os.sep. - by :user:`jayvdb`
`1700 <https://github.com/tox-dev/tox/issues/1700>`_
- Make parsing [testenv] sections in setup.cfg official. - by :user:`mauvilsa`
`1727 <https://github.com/tox-dev/tox/issues/1727>`_
- Relax importlib requirement to allow 3.0.0 or any newer version - by
:user:`pkolbus`
`1763 <https://github.com/tox-dev/tox/issues/1763>`_
Documentation
^^^^^^^^^^^^^
- Document more info about using ``platform`` setting. - by :user:`prakhargurunani`
`1144 <https://github.com/tox-dev/tox/issues/1144>`_
- Replace ``indexserver`` in documentation with environment variables - by :user:`ziima`.
`1357 <https://github.com/tox-dev/tox/issues/1357>`_
- Document that the ``passenv`` environment setting is case insensitive. - by :user:`gnikonorov`
`1534 <https://github.com/tox-dev/tox/issues/1534>`_
```
### 3.20.1
```
--------------------
Bugfixes
^^^^^^^^
- Relax importlib requirement to allow version<3 - by :user:`usamasadiq`
`1682 <https://github.com/tox-dev/tox/issues/1682>`_
```
### 3.20.0
```
--------------------
Bugfixes
^^^^^^^^
- Allow hyphens and empty factors in generative section name. - by :user:`tyagdit`
`1636 <https://github.com/tox-dev/tox/issues/1636>`_
- Support for PEP517 in-tree build backend-path key in ``get-build-requires``. - by :user:`nizox`
`1654 <https://github.com/tox-dev/tox/issues/1654>`_
- Allow escaping curly braces in setenv. - by :user:`mkenigs`
`1656 <https://github.com/tox-dev/tox/issues/1656>`_
Features
^^^^^^^^
- Support for comments within ``setenv`` and environment files via the ``files|`` prefix. - by :user:`gaborbernat`
`1667 <https://github.com/tox-dev/tox/issues/1667>`_
```
### 3.19.0
```
--------------------
Bugfixes
^^^^^^^^
- skip ``setup.cfg`` if it has no ``tox:tox`` namespace - by :user:`hroncok`
`1045 <https://github.com/tox-dev/tox/issues/1045>`_
Features
^^^^^^^^
- Implement support for building projects
having :pep:`517in-tree-build-backends` ``backend-path`` setting -
by :user:`webknjaz`
`1575 <https://github.com/tox-dev/tox/issues/1575>`_
- Don't require a tox config file for ``tox --devenv`` - by :user:`hroncok`
`1643 <https://github.com/tox-dev/tox/issues/1643>`_
Documentation
^^^^^^^^^^^^^
- Fixed grammar in top-level documentation - by :user:`tfurf`
`1631 <https://github.com/tox-dev/tox/issues/1631>`_
```
### 3.18.1
```
--------------------
Bugfixes
^^^^^^^^
- Fix ``TypeError`` when using isolated_build with backends that are not submodules (e.g. ``maturin``)
`1629 <https://github.com/tox-dev/tox/issues/1629>`_
```
### 3.18.0
```
--------------------
Deprecations (removal in next major release)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Add allowlist_externals alias to whitelist_externals (whitelist_externals is now deprecated). - by :user:`dajose`
`1491 <https://github.com/tox-dev/tox/issues/1491>`_
```
### 3.17.1
```
--------------------
Bugfixes
^^^^^^^^
- Fix tests when the ``HOSTNAME`` environment variable is set, but empty string - by :user:`hroncok`
`1616 <https://github.com/tox-dev/tox/issues/1616>`_
```
### 3.17.0
```
--------------------
Features
^^^^^^^^
- The long arguments ``--verbose`` and ``--quiet`` (rather than only their short forms, ``-v`` and ``-q``) are now accepted.
`1612 <https://github.com/tox-dev/tox/issues/1612>`_
- The ``ResultLog`` now prefers ``HOSTNAME`` environment variable value (if set) over the full qualified domain name of localhost.
This makes it possible to disable an undesired DNS lookup,
which happened on all ``tox`` invocations, including trivial ones - by :user:`hroncok`
`1615 <https://github.com/tox-dev/tox/issues/1615>`_
Documentation
^^^^^^^^^^^^^
- Update packaging information for Flit.
`1613 <https://github.com/tox-dev/tox/issues/1613>`_
```
### 3.16.1
```
--------------------
Bugfixes
^^^^^^^^
- Fixed the support for using ``{temp_dir}`` in ``tox.ini`` - by :user:`webknjaz`
`1609 <https://github.com/tox-dev/tox/issues/1609>`_
```
### 3.16.0
```
--------------------
Features
^^^^^^^^
- Allow skipping the package and installation step when passing the ``--skip-pkg-install``. This should be used in pair with the ``--notest``, so you can separate environment setup and test run:
.. code-block:: console
tox -e py --notest
tox -e py --skip-pkg-install
by :user:`gaborbernat`.
`1605 <https://github.com/tox-dev/tox/issues/1605>`_
Miscellaneous
^^^^^^^^^^^^^
- Improve config parsing performance by precompiling commonly used regular expressions - by :user:`brettlangdon`
`1603 <https://github.com/tox-dev/tox/issues/1603>`_
```
### 3.15.2
```
--------------------
Bugfixes
^^^^^^^^
- Add an option to allow a process to suicide before sending the SIGTERM. - by :user:`jhesketh`
`1497 <https://github.com/tox-dev/tox/issues/1497>`_
- PyPy 7.3.1 on Windows uses the ``Script`` folder instead of ``bin``. - by :user:`gaborbernat`
`1597 <https://github.com/tox-dev/tox/issues/1597>`_
Miscellaneous
^^^^^^^^^^^^^
- Allow to run the tests with pip 19.3.1 once again while preserving the ability to use pip 20.1 - by :user:`hroncok`
`1594 <https://github.com/tox-dev/tox/issues/1594>`_
```
### 3.15.1
```
--------------------
Bugfixes
^^^^^^^^
- ``tox --showconfig`` no longer tries to interpolate '%' signs.
`1585 <https://github.com/tox-dev/tox/issues/1585>`_
```
### 3.15.0
```
--------------------
Bugfixes
^^^^^^^^
- Respect attempts to change ``PATH`` via ``setenv`` - by :user:`aklajnert`.
`1423 <https://github.com/tox-dev/tox/issues/1423>`_
- Fix parsing of architecture in python interpreter name. - by :user:`bruchar1`
`1542 <https://github.com/tox-dev/tox/issues/1542>`_
- Prevent exception when command is empty. - by :user:`bruchar1`
`1544 <https://github.com/tox-dev/tox/issues/1544>`_
- Fix irrelevant Error message for invalid argument when running outside a directory with tox support files by :user:`nkpro2000sr`.
`1547 <https://github.com/tox-dev/tox/issues/1547>`_
Features
^^^^^^^^
- Allow parallel mode without arguments. - by :user:`ssbarnea`
`1418 <https://github.com/tox-dev/tox/issues/1418>`_
- Allow generative section name expansion. - by :user:`bruchar1`
`1545 <https://github.com/tox-dev/tox/issues/1545>`_
- default to passing the env var PIP_EXTRA_INDEX_URL by :user:`georgealton`.
`1561 <https://github.com/tox-dev/tox/issues/1561>`_
Documentation
^^^^^^^^^^^^^
- Improve documentation about config by adding tox environment description at start - by :user:`stephenfin`.
`1573 <https://github.com/tox-dev/tox/issues/1573>`_
```
### 3.14.6
```
--------------------
Bugfixes
^^^^^^^^
- Exclude virtualenv dependency versions with known
regressions (20.0.[0-7]) - by :user:`webknjaz`.
`1537 <https://github.com/tox-dev/tox/issues/1537>`_
- Fix ``tox -h`` and ``tox --hi`` shows an error when run outside a directory with tox support files by :user:`nkpro2000sr`.
`1539 <https://github.com/tox-dev/tox/issues/1539>`_
- Fix ValueError on ``tox -l`` for a ``tox.ini`` file that does not contain an
``envlist`` definition. - by :user:`jquast`.
`1343 <https://github.com/tox-dev/tox/issues/1343>`_
```
### 3.14.5
```
--------------------
Features
^^^^^^^^
- Add ``--discover`` (fallback to ``TOX_DISCOVER`` environment variable via path separator) to inject python executables
to try as first step of a discovery - note the executable still needs to match the environment by :user:`gaborbernat`.
`1526 <https://github.com/tox-dev/tox/issues/1526>`_
```
### 3.14.4
```
--------------------
Bugfixes
^^^^^^^^
- Bump minimal six version needed to avoid using one incompatible with newer
virtualenv. - by :user:`ssbarnea`
`1519 <https://github.com/tox-dev/tox/issues/1519>`_
- Avoid pypy test failure due to undefined printout var. - by :user:`ssbarnea`
`1521 <https://github.com/tox-dev/tox/issues/1521>`_
Features
^^^^^^^^
- Add ``interrupt_timeout`` and ``terminate_timeout`` that configure delay between SIGINT, SIGTERM and SIGKILL when tox is interrupted. - by :user:`sileht`
`1493 <https://github.com/tox-dev/tox/issues/1493>`_
- Add ``HTTP_PROXY``, ``HTTPS_PROXY`` and ``NO_PROXY`` to default passenv. - by :user:`pfmoore`
`1498 <https://github.com/tox-dev/tox/issues/1498>`_
```
### 3.14.3
```
--------------------
Bugfixes
^^^^^^^^
- Relax importlib requirement to allow either version 0 or 1 - by :user:`chyzzqo2`
`1476 <https://github.com/tox-dev/tox/issues/1476>`_
Miscellaneous
^^^^^^^^^^^^^
- Clarify legacy setup.py error message: python projects should commit to a strong consistency of message regarding packaging. We no-longer tell people to add a setup.py to their already configured pep-517 project, otherwise it could imply that pyproject.toml isn't as well supported and recommended as it truly is - by :user:`graingert`
`1478 <https://github.com/tox-dev/tox/issues/1478>`_
```
### 3.14.2
```
--------------------
Bugfixes
^^^^^^^^
- Fix fallback to global configuration when running in Jenkins. - by :user:`daneah`
`1428 <https://github.com/tox-dev/tox/issues/1428>`_
- Fix colouring on windows: colorama is a dep. - by :user:`1138-4EB`
`1471 <https://github.com/tox-dev/tox/issues/1471>`_
Miscellaneous
^^^^^^^^^^^^^
- improve performance with internal lookup of Python version information - by :user:`blueyed`
`1462 <https://github.com/tox-dev/tox/issues/1462>`_
- Use latest version of importlib_metadata package - by :user:`kammala`
`1472 <https://github.com/tox-dev/tox/issues/1472>`_
- Mark poetry related tests as xfail since its dependency pyrsistent won't install in ci due to missing wheels/build deps. - by :user:`RonnyPfannschmidt`
`1474 <https://github.com/tox-dev/tox/issues/1474>`_
```
### 3.14.1
```
--------------------
Bugfixes
^^^^^^^^
- fix reporting of exiting due to (real) signals - by :user:`blueyed`
`1401 <https://github.com/tox-dev/tox/issues/1401>`_
- Bump minimal virtualenv to 16.0.0 to improve own transitive
deps handling in some ancient envs. — by :user:`webknjaz`
`1429 <https://github.com/tox-dev/tox/issues/1429>`_
- Adds ``CURL_CA_BUNDLE``, ``REQUESTS_CA_BUNDLE``, ``SSL_CERT_FILE`` to the default passenv values. - by :user:`ssbarnea`
`1437 <https://github.com/tox-dev/tox/issues/1437>`_
- Fix nested tox execution in the parallel mode by separating the environment
variable that let's tox know it is invoked in the parallel mode
(``_TOX_PARALLEL_ENV``) from the variable that informs the tests that tox is
running in parallel mode (``TOX_PARALLEL_ENV``).
— by :user:`hroncok`
`1444 <https://github.com/tox-dev/tox/issues/1444>`_
- Fix provisioning from a pyvenv interpreter. — by :user:`kentzo`
`1452 <https://github.com/tox-dev/tox/issues/1452>`_
Deprecations (removal in next major release)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Python ``3.4`` is no longer supported. — by :user:`gaborbernat`
`1456 <https://github.com/tox-dev/tox/issues/1456>`_
```
### 3.14.0
```
--------------------
Bugfixes
^^^^^^^^
- Fix ``PythonSpec`` detection of ``python3.10`` - by :user:`asottile`
`1374 <https://github.com/tox-dev/tox/issues/1374>`_
- Fix regression failing to detect future and past ``py`` factors - by :user:`asottile`
`1377 <https://github.com/tox-dev/tox/issues/1377>`_
- Fix ``current_tox_py`` for ``pypy`` / ``pypy3`` - by :user:`asottile`
`1378 <https://github.com/tox-dev/tox/issues/1378>`_
- Honor environment markers in ``requires`` list - by :user:`asottile`
`1380 <https://github.com/tox-dev/tox/issues/1380>`_
- improve recreate check by allowing directories containing ``.tox-config1`` (the marker file created by tox) - by :user:`asottile`
`1383 <https://github.com/tox-dev/tox/issues/1383>`_
- Recognize correctly interpreters that have suffixes (like python3.7-dbg).
`1415 <https://github.com/tox-dev/tox/issues/1415>`_
Features
^^^^^^^^
- Add support for minor versions with multiple digits ``tox -e py310`` works for ``python3.10`` - by :user:`asottile`
`1374 <https://github.com/tox-dev/tox/issues/1374>`_
- Remove dependence on ``md5`` hashing algorithm - by :user:`asottile`
`1384 <https://github.com/tox-dev/tox/issues/1384>`_
Documentation
^^^^^^^^^^^^^
- clarify behaviour if recreate is set to false - by :user:`PJCampi`
`1399 <https://github.com/tox-dev/tox/issues/1399>`_
Miscellaneous
^^^^^^^^^^^^^
- Fix relative URLs to files in the repo in ``.github/PULL_REQUEST_TEMPLATE.md`` — by :user:`webknjaz`
`1363 <https://github.com/tox-dev/tox/issues/1363>`_
- Replace ``importlib_metadata`` backport with ``importlib.metadata``
from the standard library on Python ``3.8+`` - by :user:`hroncok`
`1367 <https://github.com/tox-dev/tox/issues/1367>`_
- Render the change fragment help on the ``docs/changelog/`` directory view on GitHub — by :user:`webknjaz`
`1370 <https://github.com/tox-dev/tox/issues/1370>`_
```
### 3.13.2
```
--------------------
Bugfixes
^^^^^^^^
- on venv cleanup: add explicit check for pypy venv to make it possible to recreate it - by :user:`obestwalter`
`1355 <https://github.com/tox-dev/tox/issues/1355>`_
- non canonical names within :conf:`requires` cause infinite provisioning loop - by :user:`gaborbernat`
`1359 <https://github.com/tox-dev/tox/issues/1359>`_
```
### 3.13.1
```
--------------------
Bugfixes
^^^^^^^^
- Fix isolated build double-requirement - by :user:`asottile`.
`1349 <https://github.com/tox-dev/tox/issues/1349>`_
```
### 3.13.0
```
--------------------
Bugfixes
^^^^^^^^
- tox used Windows shell rules on non-Windows platforms when transforming
positional arguments to a string - by :user:`barneygale`.
`1336 <https://github.com/tox-dev/tox/issues/1336>`_
Features
^^^^^^^^
- Replace ``pkg_resources`` with ``importlib_metadata`` for speed - by :user:`asottile`.
`1324 <https://github.com/tox-dev/tox/issues/1324>`_
- Add the ``--devenv ENVDIR`` option for creating development environments from ``[testenv]`` configurations - by :user:`asottile`.
`1326 <https://github.com/tox-dev/tox/issues/1326>`_
- Refuse to delete ``envdir`` if it doesn't look like a virtualenv - by :user:`asottile`.
`1340 <https://github.com/tox-dev/tox/issues/1340>`_
```
### 3.12.1
```
--------------------
Bugfixes
^^^^^^^^
- Ensure ``TOX_WORK_DIR`` is a native string in ``os.environ`` - by :user:`asottile`.
`1313 <https://github.com/tox-dev/tox/issues/1313>`_
- Fix import and usage of ``winreg`` for python2.7 on windows - by :user:`asottile`.
`1315 <https://github.com/tox-dev/tox/issues/1315>`_
- Fix Windows selects incorrect spec on first discovery - by :user:`gaborbernat`
`1317 <https://github.com/tox-dev/tox/issues/1317>`_
```
### 3.12.0
```
--------------------
Bugfixes
^^^^^^^^
- When using ``--parallel`` with ``--result-json`` the test results are now included the same way as with serial runs - by :user:`fschulze`
`1295 <https://github.com/tox-dev/tox/issues/1295>`_
- Turns out the output of the ``py -0p`` is not stable yet and varies depending on various edge cases. Instead now we read the interpreter values directly from registry via `PEP-514 <https://www.python.org/dev/peps/pep-0514>`_ - by :user:`gaborbernat`.
`1306 <https://github.com/tox-dev/tox/issues/1306>`_
Features
^^^^^^^^
- Adding ``TOX_PARALLEL_NO_SPINNER`` environment variable to disable the spinner in parallel mode for the purposes of clean output when using CI tools - by :user:`zeroshift`
`1184 <https://github.com/tox-dev/tox/issues/1184>`_
```
### 3.11.1
```
--------------------
Bugfixes
^^^^^^^^
- When creating virtual environments we no longer ask the python to tell its path, but rather use the discovered path.
`1301 <https://github.com/tox-dev/tox/issues/1301>`_
```
### 3.11.0
```
--------------------
Features
^^^^^^^^
- ``--showconfig`` overhaul:
- now fully generated via the config parser, so anyone can load it by using the built-in python config parser
- the ``tox`` section contains all configuration data from config
- the ``tox`` section contains a ``host_python`` key detailing the path of the host python
- the ``tox:version`` section contains the versions of all packages tox depends on with their version
- passing ``-l`` now allows only listing default target envs
- allows showing config for a given set of tox environments only via the ``-e`` cli flag or the ``TOXENV`` environment
variable, in this case the ``tox`` and ``tox:version`` section is only shown if at least one verbosity flag is passed
this should help inspecting the options.
`1298 <https://github.com/tox-dev/tox/issues/1298>`_
```
### 3.10.0
```
--------------------
Bugfixes
^^^^^^^^
- fix for ``tox -l`` command: do not allow setting the ``TOXENV`` or the ``-e`` flag to override the listed default environment variables, they still show up under extra if non defined target - by :user:`gaborbernat`
`720 <https://github.com/tox-dev/tox/issues/720>`_
- tox ignores unknown CLI arguments when provisioning is on and outside of the provisioned environment (allowing
provisioning arguments to be forwarded freely) - by :user:`gaborbernat`
`1270 <https://github.com/tox-dev/tox/issues/1270>`_
Features
^^^^^^^^
- Virtual environments created now no longer upgrade pip/wheel/setuptools to the latest version. Instead the start
packages after virtualenv creation now is whatever virtualenv has bundled in. This allows faster virtualenv
creation and builds that are easier to reproduce.
`448 <https://github.com/tox-dev/tox/issues/448>`_
- Improve python discovery and add architecture support:
- UNIX:
- First, check if the tox host Python matches.
- Second, check if the the canonical name (e.g. ``python3.7``, ``python3``) matches or the base python is an absolute path, use that.
- Third, check if the the canonical name without version matches (e.g. ``python``, ``pypy``) matches.
- Windows:
- First, check if the tox host Python matches.
- Second, use the ``py.exe`` to list registered interpreters and any of those match.
- Third, check if the the canonical name (e.g. ``python3.7``, ``python3``) matches or the base python is an absolute path, use that.
- Fourth, check if the the canonical name without version matches (e.g. ``python``, ``pypy``) matches.
- Finally, check for known locations (``c:\python{major}{minor}\python.exe``).
tox environment configuration generation is now done in parallel (to alleviate the slowdown due to extra
checks).
`1290 <https://github.com/tox-dev/tox/issues/1290>`_
```
### 3.9.0
```
-------------------
Bugfixes
^^^^^^^^
- Fix ``congratulations`` when using ``^C`` during virtualenv creation - by :user:`asottile`
`1257 <https://github.com/tox-dev/tox/issues/1257>`_
Features
^^^^^^^^
- Allow having inline comments in :conf:`deps` — by :user:`webknjaz`
`1262 <https://github.com/tox-dev/tox/issues/1262>`_
```
### 3.8.6
```
-------------------
Bugfixes
^^^^^^^^
- :conf:`parallel_show_output` does not work with tox 3.8
`1245 <https://github.com/tox-dev/tox/issues/1245>`_
```
### 3.8.5
```
-------------------
Bugfixes
^^^^^^^^
- the isolated build env now ignores :conf:`sitepackages`, :conf:`deps` and :conf:`description` as these do not make
sense - by :user:`gaborbernat`
`1239 <https://github.com/tox-dev/tox/issues/1239>`_
- Do not print timings with more than 3 decimal digits on Python 3 - by :user:`mgedmin`.
`1241 <https://github.com/tox-dev/tox/issues/1241>`_
```
### 3.8.4
```
-------------------
Bugfixes
^^^^^^^^
- Fix sdist creation on python2.x when there is non-ascii output.
`1234 <https://github.com/tox-dev/tox/issues/1234>`_
- fix typos in isolated.py that made it impossible to install package with requirements in pyproject.toml - by :user:`unmade`
`1236 <https://github.com/tox-dev/tox/issues/1236>`_
```
### 3.8.3
```
-------------------
Bugfixes
^^^^^^^^
- don't crash when version information is not available for a proposed base python - by :user:`gaborbernat`
`1227 <https://github.com/tox-dev/tox/issues/1227>`_
- Do not print exception traceback when the provisioned tox fails - by :user:`gaborbernat`
`1228 <https://github.com/tox-dev/tox/issues/1228>`_
```
### 3.8.2
```
-------------------
Bugfixes
^^^^^^^^
- using -v and -e connected (as -ve) fails - by :user:`gaborbernat`
`1218 <https://github.com/tox-dev/tox/issues/1218>`_
- Changes to the plugin tester module (cmd no longer sets ``PYTHONPATH``), and ``action.popen`` no longer returns the
command identifier information from within the logs. No public facing changes.
`1222 <https://github.com/tox-dev/tox/issues/1222>`_
- Spinner fails in CI on ``UnicodeEncodeError`` - by :user:`gaborbernat`
`1223 <https://github.com/tox-dev/tox/issues/1223>`_
```
### 3.8.1
```
-------------------
Bugfixes
^^^^^^^^
- The ``-eALL`` command line argument now expands the ``envlist`` key and includes all its environment.
`1155 <https://github.com/tox-dev/tox/issues/1155>`_
- Isolated build environment dependency overrides were not taken in consideration (and such it inherited the deps
from the testenv section) - by :user:`gaborbernat`
`1207 <https://github.com/tox-dev/tox/issues/1207>`_
- ``--result-json`` puts the command into setup section instead of test (pre and post commands are now also correctly
put into the commands section) - by :user:`gaborbernat`
`1210 <https://github.com/tox-dev/tox/issues/1210>`_
- Set ``setup.cfg`` encoding to UTF-8 as it contains Unicode characters.
`1212 <https://github.com/tox-dev/tox/issues/1212>`_
- Fix tox CI, better error reporting when locating via the py fails - by :user:`gaborbernat`
`1215 <https://github.com/tox-dev/tox/issues/1215>`_
```
### 3.8.0
```
-------------------
Bugfixes
^^^^^^^^
- In a posix shell, setting the PATH environment variable to an empty value is equivalent to not setting it at all;
therefore we no longer if the user sets PYTHONPATH an empty string on python 3.4 or later - by :user:`gaborbernat`.
`1092 <https://github.com/tox-dev/tox/issues/1092>`_
- Fixed bug of children process calls logs clashing (log already exists) - by :user:`gaborbernat`
`1137 <https://github.com/tox-dev/tox/issues/1137>`_
- Interpreter discovery and virtualenv creation process calls that failed will now print out on the screen their output
(via the logfile we automatically save) - by :user:`gaborbernat`
`1150 <https://github.com/tox-dev/tox/issues/1150>`_
- Using ``py2`` and ``py3`` with a specific ``basepython`` will no longer raise a warning unless the major version conflicts - by :user:`demosdemon`.
`1153 <https://github.com/tox-dev/tox/issues/1153>`_
- Fix missing error for ``tox -e unknown`` when tox.ini declares ``envlist``. - by :user:`medmunds`
`1160 <https://github.com/tox-dev/tox/issues/1160>`_
- Resolve symlinks with ``toxworkdir`` - by :user:`blueyed`.
`1169 <https://github.com/tox-dev/tox/issues/1169>`_
- Interrupting a tox call (e.g. via CTRL+C) now will ensure that spawn child processes (test calls, interpreter discovery,
parallel sub-instances, provisioned hosts) are correctly stopped before exiting (via the pattern of INTERRUPT - 300 ms,
TERMINATE - 200 ms, KILL signals) - by :user:`gaborbernat`
`1172 <https://github.com/tox-dev/tox/issues/1172>`_
- Fix a ``ResourceWarning: unclosed file`` in ``Action`` - by :user:`BoboTiG`.
`1179 <https://github.com/tox-dev/tox/issues/1179>`_
- Fix deadlock when using ``--parallel`` and having environments with lots of output - by :user:`asottile`.
`1183 <https://github.com/tox-dev/tox/issues/1183>`_
- Removed code that sometimes caused a difference in results between ``--parallel`` and ``-p`` when using ``posargs`` - by :user:`timdaman`
`1192 <https://github.com/tox-dev/tox/issues/1192>`_
Features
^^^^^^^^
- tox now auto-provisions itself if needed (see :ref:`auto-provision`). Plugins or minimum version of tox no longer
need to be manually satisfied by the user, increasing their ease of use. - by :user:`gaborbernat`
`998 <https://github.com/tox-dev/tox/issues/998>`_
- tox will inject the ``TOX_PARALLEL_ENV`` environment variable, set to the current running tox environment name,
only when running in parallel mode. - by :user:`gaborbernat`
`1139 <https://github.com/tox-dev/tox/issues/1139>`_
- Parallel children now save their output to a disk logfile - by :user:`gaborbernat`
`1143 <https://github.com/tox-dev/tox/issues/1143>`_
- Parallel children now are added to ``--result-json`` - by :user:`gaborbernat`
`1159 <https://github.com/tox-dev/tox/issues/1159>`_
- Display pattern and ``sys.platform`` with platform mismatch - by :user:`blueyed`.
`1176 <https://github.com/tox-dev/tox/issues/1176>`_
- Setting the environment variable ``TOX_REPORTER_TIMESTAMP`` to ``1`` will enable showing for each output line its delta
since the tox startup. This can be especially handy when debugging parallel runs.- by :user:`gaborbernat`
`1203 <https://github.com/tox-dev/tox/issues/1203>`_
Documentation
^^^^^^^^^^^^^
- Add a ``poetry`` examples to packaging - by :user:`gaborbernat`
`1163 <https://github.com/tox-dev/tox/issues/1163>`_
```
### 3.7.0
```
-------------------
Features
^^^^^^^^
- Parallel mode added (alternative to ``detox`` which is being deprecated), for more details see :ref:`parallel_mode` - by :user:`gaborbernat`.
`439 <https://github.com/tox-dev/tox/issues/439>`_
- Added command line shortcut ``-s`` for ``--skip-missing-interpreters`` - by :user:`evandrocoan`
`1119 <https://github.com/tox-dev/tox/issues/1119>`_
Deprecations (removal in next major release)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Whitelisting of externals will be mandatory in tox 4: issue a deprecation warning as part of the already existing warning - by :user:`obestwalter`
`1129 <https://github.com/tox-dev/tox/issues/1129>`_
Documentation
^^^^^^^^^^^^^
- Clarify explanations in examples and avoid unsupported end line comments - by :user:`obestwalter`
`1110 <https://github.com/tox-dev/tox/issues/1110>`_
- Set to PULL_REQUEST_TEMPLATE.md use relative instead of absolute URLs - by :user:`evandrocoan`
Fixed PULL_REQUEST_TEMPLATE.md path for changelog/examples.rst to docs/changelog/examples.rst - by :user:`evandrocoan`
`1120 <https://github.com/tox-dev/tox/issues/1120>`_
```
### 3.6.1
```
-------------------
Features
^^^^^^^^
- if the packaging phase successfully builds a package set it as environment variable under ``TOX_PACKAGE`` (useful to make assertions on the built package itself, instead of just how it ends up after installation) - by :user:`gaborbernat` (`1081 <https://github.com/tox-dev/tox/issues/1081>`_)
```
### 3.6.0
```
-------------------
Bugfixes
^^^^^^^^
- On windows, check ``sys.executable`` before others for interpreter version lookup. This matches what happens on non-windows. (`1087 <https://github.com/tox-dev/tox/issues/1087>`_)
- Don't rewrite ``{posargs}`` substitution for absolute paths. (`1095 <https://github.com/tox-dev/tox/issues/1095>`_)
- Correctly fail ``tox --notest`` when setup fails. (`1097 <https://github.com/tox-dev/tox/issues/1097>`_)
Documentation
^^^^^^^^^^^^^
- Update Contributor Covenant URL to use https:// - by :user:`jdufresne`. (`#1082 <https://github.com/tox-dev/tox/issues/1082>`_)
- Correct the capitalization of PyPI throughout the documentation - by :user:`jdufresne`. (`1084 <https://github.com/tox-dev/tox/issues/1084>`_)
- Link to related projects (Invoke and Nox) from the documentation - by :user:`theacodes`. (`1088 <https://github.com/tox-dev/tox/issues/1088>`_)
Miscellaneous
^^^^^^^^^^^^^
- Include the license file in the wheel distribution - by :user:`jdufresne`. (`1083 <https://github.com/tox-dev/tox/issues/1083>`_)
```
### 3.5.3
```
-------------------
Bugfixes
^^^^^^^^
- Fix bug with incorrectly defactorized dependencies - by :user:`bartsanchez` (`706 <https://github.com/tox-dev/tox/issues/706>`_)
- do the same transformation to ``egg_info`` folders that ``pkg_resources`` does;
this makes it possible for hyphenated names to use the ``develop-inst-noop`` optimization (cf. 910),
which previously only worked with non-hyphenated egg names - by
:user:`hashbrowncipher` (`1051 <https://github.com/tox-dev/tox/issues/1051>`_)
- previously, if a project's ``setup.py --name`` emitted extra information to
stderr, tox would capture it and consider it part of the project's name; now,
emissions to stderr are printed to the console - by :user:`hashbrowncipher` (`1052 <https://github.com/tox-dev/tox/issues/1052>`_)
- change the way we acquire interpreter information to make it compatible with ``jython`` interpreter, note to create jython envs one needs ``virtualenv > 16.0`` which will be released later :user:`gaborbernat` (`1073 <https://github.com/tox-dev/tox/issues/1073>`_)
Documentation
^^^^^^^^^^^^^
- document substitutions with additional content starting with a space cannot be alone on a line inside the ini file - by :user:`gaborbernat` (`437 <https://github.com/tox-dev/tox/issues/437>`_)
- change the spelling of a single word from contrains to the proper word, constraints - by :user:`metasyn` (`1061 <https://github.com/tox-dev/tox/issues/1061>`_)
- Mention the minimum version required for ``commands_pre``/``commands_post`` support. (`1071 <https://github.com/tox-dev/tox/issues/1071>`_)
```
### 3.5.2
```
-------------------
Bugfixes
^^^^^^^^
- session packages are now put inside a numbered directory (instead of prefix numbering it,
because pip fails when wheels are not named according to
`PEP-491 <https://www.python.org/dev/peps/pep-0491/#id9>`_, and prefix numbering messes with this)
- by :user:`gaborbernat` (`1042 <https://github.com/tox-dev/tox/issues/1042>`_)
Features
^^^^^^^^
- level three verbosity (``-vvv``) show the packaging output - by :user:`gaborbernat` (`1047 <https://github.com/tox-dev/tox/issues/1047>`_)
```
### 3.5.1
```
-------------------
Bugfixes
^^^^^^^^
- fix regression with ``3.5.0``: specifying ``--installpkg`` raises ``AttributeError: 'str' object has no attribute 'basename'`` (`1042 <https://github.com/tox-dev/tox/issues/1042>`_)
```
### 3.5.0
```
-------------------
Bugfixes
^^^^^^^^
- intermittent failures with ``--parallel--safe-build``, instead of mangling with the file paths now uses a lock to make the package build operation thread safe and is now on by default (``--parallel--safe-build`` is now deprecated) - by :user:`gaborbernat` (`1026 <https://github.com/tox-dev/tox/issues/1026>`_)
Features
^^^^^^^^
- Added ``temp_dir`` folder configuration (defaults to ``{toxworkdir}/.tmp``) that contains tox
temporary files. Package builds now create a hard link (if possible, otherwise copy - notably in
case of Windows Python 2.7) to the built file, and feed that file downstream (e.g. for pip to
install it). The hard link is removed at the end of the run (what it points though is kept
inside ``distdir``). This ensures that a tox session operates on the same package it built, even
if a parallel tox run builds another version. Note ``distdir`` will contain only the last built
package in such cases. - by :user:`gaborbernat` (`1026 <https://github.com/tox-dev/tox/issues/1026>`_)
Documentation
^^^^^^^^^^^^^
- document tox environment recreate rules (:ref:`recreate`) - by :user:`gaborbernat` (`93 <https://github.com/tox-dev/tox/issues/93>`_)
- document inside the ``--help`` how to disable colorized output via the ``PY_COLORS`` operating system environment variable - by :user:`gaborbernat` (`163 <https://github.com/tox-dev/tox/issues/163>`_)
- document all global tox flags and a more concise format to express default and type - by :user:`gaborbernat` (`683 <https://github.com/tox-dev/tox/issues/683>`_)
- document command line interface under the config section `cli <https://tox.readthedocs.io/en/latest/config.html?highlight=cli#cli>`_ - by :user:`gaborbernat` (`829 <https://github.com/tox-dev/tox/issues/829>`_)
```
### 3.4.0
```
-------------------
Bugfixes
^^^^^^^^
- add ``--exists-action w`` to default pip flags to handle better VCS dependencies (`pip documentation on this <https://pip.pypa.io/en/latest/reference/pip/#exists-action-option>`_) - by :user:`gaborbernat` (`503 <https://github.com/tox-dev/tox/issues/503>`_)
- instead of assuming the Python version from the base python name ask the interpreter to reveal the version for the ``ignore_basepython_conflict`` flag - by :user:`gaborbernat` (`908 <https://github.com/tox-dev/tox/issues/908>`_)
- PEP-517 packaging fails with sdist already exists, fixed via ensuring the dist folder is empty before invoking the backend and `pypa/setuptools 1481 <https://github.com/pypa/setuptools/pull/1481>`_ - by :user:`gaborbernat` (`#1003 <https://github.com/tox-dev/tox/issues/1003>`_)
Features
^^^^^^^^
- add ``commands_pre`` and ``commands_post`` that run before and after running
the ``commands`` (setup runs always, commands only if setup succeeds, teardown always - all
run until the first failing command) - by :user:`gaborbernat` (`167 <https://github.com/tox-dev/tox/issues/167>`_)
- ``pyproject.toml`` config support initially by just inline the tox.ini under ``tool.tox.legacy_tox_ini`` key; config source priority order is ``pyproject.toml``, ``tox.ini`` and then ``setup.cfg`` - by :user:`gaborbernat` (`814 <https://github.com/tox-dev/tox/issues/814>`_)
- use the os environment variable ``TOX_SKIP_ENV`` to filter out tox environment names from the run list (set by ``envlist``) - by :user:`gaborbernat` (`824 <https://github.com/tox-dev/tox/issues/824>`_)
- always set ``PIP_USER=0`` (do not install into the user site package, but inside the virtual environment created) and ``PIP_NO_DEPS=0`` (installing without dependencies can cause broken package installations) inside tox - by :user:`gaborbernat` (`838 <https://github.com/tox-dev/tox/issues/838>`_)
- tox will inject some environment variables that to indicate a command is running within tox: ``TOX_WORK_DIR`` env var is set to the tox work directory,
``TOX_ENV_NAME`` is set to the current running tox environment name, ``TOX_ENV_DIR`` is set to the current tox environments working dir - by :user:`gaborbernat` (`847 <https://github.com/tox-dev/tox/issues/847>`_)
- While running tox invokes various commands (such as building the package, pip installing dependencies and so on), these were printed in case they failed as Python arrays. Changed the representation to a shell command, allowing the users to quickly replicate/debug the failure on their own - by :user:`gaborbernat` (`851 <https://github.com/tox-dev/tox/issues/851>`_)
- skip missing interpreters value from the config file can now be overridden via the ``--skip-missing-interpreters`` cli flag - by :user:`gaborbernat` (`903 <https://github.com/tox-dev/tox/issues/903>`_)
- keep additional environments config order when listing them - by :user:`gaborbernat` (`921 <https://github.com/tox-dev/tox/issues/921>`_)
- allow injecting config value inside the ini file dependent of the fact that we're connected to an interactive shell or not - by :user:`gaborbernat` (`947 <https://github.com/tox-dev/tox/issues/947>`_)
- do not build sdist if skip install is specified for the envs to be run - by :user:`gaborbernat` (`974 <https://github.com/tox-dev/tox/issues/974>`_)
- when verbosity level increases above two start passing through verbosity flags to pip - by :user:`gaborbernat` (`982 <https://github.com/tox-dev/tox/issues/982>`_)
- when discovering the interpreter to use check if the tox host Python matches and use that if so - by :user:`gaborbernat` (`994 <https://github.com/tox-dev/tox/issues/994>`_)
- ``-vv`` will print out why a virtual environment is re-created whenever this operation is triggered - by :user:`gaborbernat` (`1004 <https://github.com/tox-dev/tox/issues/1004>`_)
Documentation
^^^^^^^^^^^^^
- clarify that ``python`` and ``pip`` refer to the virtual environments executable - by :user:`gaborbernat` (`305 <https://github.com/tox-dev/tox/issues/305>`_)
- add Sphinx and mkdocs example of generating documentation via tox - by :user:`gaborbernat` (`374 <https://github.com/tox-dev/tox/issues/374>`_)
- specify that ``setup.cfg`` tox configuration needs to be inside the ``tox:tox`` namespace - by :user:`gaborbernat` (`545 <https://github.com/tox-dev/tox/issues/545>`_)
```
### 3.3.0
```
-------------------
Bugfixes
^^^^^^^^
- fix ``TOX_LIMITED_SHEBANG`` when running under python3 - by :user:`asottile` (`931 <https://github.com/tox-dev/tox/issues/931>`_)
Features
^^^^^^^^
- `PEP-517 <https://www.python.org/dev/peps/pep-0517/>`_ source distribution support (create a
``.package`` virtual environment to perform build operations inside) by :user:`gaborbernat` (`573 <https://github.com/tox-dev/tox/issues/573>`_)
- `flit <https://flit.readthedocs.io>`_ support via implementing ``PEP-517`` by :user:`gaborbernat` (`#820 <https://github.com/tox-dev/tox/issues/820>`_)
- packaging now is exposed as a hook via ``tox_package(session, venv)`` - by :user:`gaborbernat` (`951 <https://github.com/tox-dev/tox/issues/951>`_)
Miscellaneous
^^^^^^^^^^^^^
- Updated the VSTS build YAML to use the latest jobs and pools syntax - by :user:`davidstaheli` (`955 <https://github.com/tox-dev/tox/issues/955>`_)
```
### 3.2.1
```
-------------------
Bugfixes
^^^^^^^^
- ``--parallel--safe-build`` no longer cleans up its folders (``distdir``, ``distshare``, ``log``). - by :user:`gaborbernat` (`849 <https://github.com/tox-dev/tox/issues/849>`_)
```
### 3.2.0
```
-------------------
Features
^^^^^^^^
- Switch pip invocations to use the module ``-m pip`` instead of direct invocation. This could help
avoid some of the shebang limitations. - by :user:`gaborbernat` (`935 <https://github.com/tox-dev/tox/issues/935>`_)
- Ability to specify package requirements for the tox run via the ``tox.ini`` (``tox`` section under key ``requires`` - PEP-508 style): can be used to specify both plugin requirements or build dependencies. - by :user:`gaborbernat` (`783 <https://github.com/tox-dev/tox/issues/783>`_)
- Allow one to run multiple tox instances in parallel by providing the
``--parallel--safe-build`` flag. - by :user:`gaborbernat` (`849 <https://github.com/tox-dev/tox/issues/849>`_)
```
### 3.1.3
```
-------------------
Bugfixes
^^^^^^^^
- A caching issue that caused the ``develop-inst-nodeps`` action, which
reinstalls the package under test, to always run has been resolved. The
``develop-inst-noop`` action, which, as the name suggests, is a no-op, will now
run unless there are changes to ``setup.py`` or ``setup.cfg`` files that have
not been reflected - by stephenfin (`909 <https://github.com/tox-dev/tox/issues/909>`_)
Features
^^^^^^^^
- Python version testenvs are now automatically detected instead of comparing
against a hard-coded list of supported versions. This enables ``py38`` and
eventually ``py39`` / ``py40`` / etc. to work without requiring an upgrade to
``tox``. As such, the following public constants are now deprecated
(and scheduled for removal in ``tox`` 4.0: ``CPYTHON_VERSION_TUPLES``,
``PYPY_VERSION_TUPLES``, ``OTHER_PYTHON_INTERPRETERS``, and ``DEFAULT_FACTORS`` -
by :user:`asottile` (`914 <https://github.com/tox-dev/tox/issues/914>`_)
Documentation
^^^^^^^^^^^^^
- Add a system overview section on the index page that explains briefly how tox works -
by :user:`gaborbernat`. (`867 <https://github.com/tox-dev/tox/issues/867>`_)
```
### 3.1.2
```
-------------------
Bugfixes
^^^^^^^^
- Revert "Fix bug with incorrectly defactorized dependencies (`772 <https://github.com/tox-dev/tox/issues/772>`_)" due to a regression (`(#799) <https://github.com/tox-dev/tox/issues/899>`_) - by :user:`obestwalter`
```
### 3.1.1
```
-------------------
Bugfixes
^^^^^^^^
- PyPI documentation for ``3.1.0`` is broken. Added test to check for this, and
fix it by :user:`gaborbernat`. (`879
<https://github.com/tox-dev/tox/issues/879>`_)
```
### 3.1.0
```
-------------------
Bugfixes
^^^^^^^^
- Add ``ignore_basepython_conflict``, which determines whether conflicting
``basepython`` settings for environments containing default factors, such as
``py27`` or ``django18-py35``, should be ignored or result in warnings. This
was a common source of misconfiguration and is rarely, if ever, desirable from
a user perspective - by :user:`stephenfin` (`477 <https://github.com/tox-dev/tox/issues/477>`_)
- Fix bug with incorrectly defactorized dependencies (deps passed to pip were not de-factorized) - by :user:`bartsanchez` (`706 <https://github.com/tox-dev/tox/issues/706>`_)
Features
^^^^^^^^
- Add support for multiple PyPy versions using default factors. This allows you
to use, for example, ``pypy27`` knowing that the correct interpreter will be
used by default - by :user:`stephenfin` (`19 <https://github.com/tox-dev/tox/issues/19>`_)
- Add support to explicitly invoke interpreter directives for environments with
long path lengths. In the event that ``tox`` cannot invoke scripts with a
system-limited shebang (e.x. a Linux host running a Jenkins Pipeline), a user
can set the environment variable ``TOX_LIMITED_SHEBANG`` to workaround the
system's limitation (e.x. ``export TOX_LIMITED_SHEBANG=1``) - by :user:`jdknight` (`794 <https://github.com/tox-dev/tox/issues/794>`_)
- introduce a constants module to be used internally and as experimental API - by :user:`obestwalter` (`798 <https://github.com/tox-dev/tox/issues/798>`_)
- Make ``py2`` and ``py3`` aliases also resolve via ``py`` on windows by :user:`asottile`. This enables the following things:
``tox -e py2`` and ``tox -e py3`` work on windows (they already work on posix); and setting ``basepython=python2`` or ``basepython=python3`` now works on windows. (`856 <https://github.com/tox-dev/tox/issues/856>`_)
- Replace the internal version parsing logic from the not well tested `PEP-386 <https://www.python.org/dev/peps/pep-0386/>`_ parser for the more general `PEP-440 <https://www.python.org/dev/peps/pep-0440/>`_. `packaging >= 17.1 <https://pypi.org/project/packaging/>`_ is now an install dependency by :user:`gaborbernat`. (`#860 <https://github.com/tox-dev/tox/issues/860>`_)
Documentation
^^^^^^^^^^^^^
- extend the plugin documentation and make lot of small fixes and improvements - by :user:`obestwalter` (`797 <https://github.com/tox-dev/tox/issues/797>`_)
- tidy up tests - remove unused fixtures, update old cinstructs, etc. - by :user:`obestwalter` (`799 <https://github.com/tox-dev/tox/issues/799>`_)
- Various improvements to documentation: open browser once documentation generation is done, show Github/Travis info on documentation page, remove duplicate header for changelog, generate unreleased news as DRAFT on top of changelog, make the changelog page more compact and readable (width up to 1280px) by :user:`gaborbernat` (`859 <https://github.com/tox-dev/tox/issues/859>`_)
Miscellaneous
^^^^^^^^^^^^^
- filter out unwanted files in package - by :user:`obestwalter` (`754 <https://github.com/tox-dev/tox/issues/754>`_)
- make the already existing implicit API explicit - by :user:`obestwalter` (`800 <https://github.com/tox-dev/tox/issues/800>`_)
- improve tox quickstart and corresponding tests - by :user:`obestwalter` (`801 <https://github.com/tox-dev/tox/issues/801>`_)
- tweak codecov settings via .codecov.yml - by :user:`obestwalter` (`802 <https://github.com/tox-dev/tox/issues/802>`_)
```
Links
- PyPI: https://pypi.org/project/tox
- Changelog: https://pyup.io/changelogs/tox/
- Docs: http://tox.readthedocs.org
pyup-bot
commented
3 years ago
This PR updates tox from 3.0.0 to 3.21.1.
Changelog
### 3.21.1 ``` -------------------- Bugfixes ^^^^^^^^ - Fix regression that broke using install_command in config replacements - by :user:`jayvdb` `1777 <https://github.com/tox-dev/tox/issues/1777>`_ - Fix regression parsing posargs default containing colon. - by :user:`jayvdb` `1785 <https://github.com/tox-dev/tox/issues/1785>`_ Features ^^^^^^^^ - Prevent .tox in envlist - by :user:`jayvdb` `1684 <https://github.com/tox-dev/tox/issues/1684>`_ Miscellaneous ^^^^^^^^^^^^^ - Enable building tox with ``setuptools_scm`` 4 and 5 by :user:hroncok `1799 <https://github.com/tox-dev/tox/issues/1799>`_ ``` ### 3.21.0 ``` -------------------- Bugfixes ^^^^^^^^ - Fix the false ``congratulations`` message that appears when a ``KeyboardInterrupt`` occurs during package installation. - by :user:`gnikonorov` `1453 <https://github.com/tox-dev/tox/issues/1453>`_ - Fix ``platform`` support for ``install_command``. - by :user:`jayvdb` `1464 <https://github.com/tox-dev/tox/issues/1464>`_ - Fixed regression in v3.20.0 that caused escaped curly braces in setenv to break usage of the variable elsewhere in tox.ini. - by :user:`jayvdb` `1690 <https://github.com/tox-dev/tox/issues/1690>`_ - Prevent ``{}`` and require ``{:`` is only followed by ``}``. - by :user:`jayvdb` `1711 <https://github.com/tox-dev/tox/issues/1711>`_ - Raise ``MissingSubstitution`` on access of broken ini setting. - by :user:`jayvdb` `1716 <https://github.com/tox-dev/tox/issues/1716>`_ Features ^^^^^^^^ - Allow \{ and \} in default of {env:key:default}. - by :user:`jayvdb` `1502 <https://github.com/tox-dev/tox/issues/1502>`_ - Allow {posargs} in setenv. - by :user:`jayvdb` `1695 <https://github.com/tox-dev/tox/issues/1695>`_ - Allow {/} to refer to os.sep. - by :user:`jayvdb` `1700 <https://github.com/tox-dev/tox/issues/1700>`_ - Make parsing [testenv] sections in setup.cfg official. - by :user:`mauvilsa` `1727 <https://github.com/tox-dev/tox/issues/1727>`_ - Relax importlib requirement to allow 3.0.0 or any newer version - by :user:`pkolbus` `1763 <https://github.com/tox-dev/tox/issues/1763>`_ Documentation ^^^^^^^^^^^^^ - Document more info about using ``platform`` setting. - by :user:`prakhargurunani` `1144 <https://github.com/tox-dev/tox/issues/1144>`_ - Replace ``indexserver`` in documentation with environment variables - by :user:`ziima`. `1357 <https://github.com/tox-dev/tox/issues/1357>`_ - Document that the ``passenv`` environment setting is case insensitive. - by :user:`gnikonorov` `1534 <https://github.com/tox-dev/tox/issues/1534>`_ ``` ### 3.20.1 ``` -------------------- Bugfixes ^^^^^^^^ - Relax importlib requirement to allow version<3 - by :user:`usamasadiq` `1682 <https://github.com/tox-dev/tox/issues/1682>`_ ``` ### 3.20.0 ``` -------------------- Bugfixes ^^^^^^^^ - Allow hyphens and empty factors in generative section name. - by :user:`tyagdit` `1636 <https://github.com/tox-dev/tox/issues/1636>`_ - Support for PEP517 in-tree build backend-path key in ``get-build-requires``. - by :user:`nizox` `1654 <https://github.com/tox-dev/tox/issues/1654>`_ - Allow escaping curly braces in setenv. - by :user:`mkenigs` `1656 <https://github.com/tox-dev/tox/issues/1656>`_ Features ^^^^^^^^ - Support for comments within ``setenv`` and environment files via the ``files|`` prefix. - by :user:`gaborbernat` `1667 <https://github.com/tox-dev/tox/issues/1667>`_ ``` ### 3.19.0 ``` -------------------- Bugfixes ^^^^^^^^ - skip ``setup.cfg`` if it has no ``tox:tox`` namespace - by :user:`hroncok` `1045 <https://github.com/tox-dev/tox/issues/1045>`_ Features ^^^^^^^^ - Implement support for building projects having :pep:`517in-tree-build-backends` ``backend-path`` setting - by :user:`webknjaz` `1575 <https://github.com/tox-dev/tox/issues/1575>`_ - Don't require a tox config file for ``tox --devenv`` - by :user:`hroncok` `1643 <https://github.com/tox-dev/tox/issues/1643>`_ Documentation ^^^^^^^^^^^^^ - Fixed grammar in top-level documentation - by :user:`tfurf` `1631 <https://github.com/tox-dev/tox/issues/1631>`_ ``` ### 3.18.1 ``` -------------------- Bugfixes ^^^^^^^^ - Fix ``TypeError`` when using isolated_build with backends that are not submodules (e.g. ``maturin``) `1629 <https://github.com/tox-dev/tox/issues/1629>`_ ``` ### 3.18.0 ``` -------------------- Deprecations (removal in next major release) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Add allowlist_externals alias to whitelist_externals (whitelist_externals is now deprecated). - by :user:`dajose` `1491 <https://github.com/tox-dev/tox/issues/1491>`_ ``` ### 3.17.1 ``` -------------------- Bugfixes ^^^^^^^^ - Fix tests when the ``HOSTNAME`` environment variable is set, but empty string - by :user:`hroncok` `1616 <https://github.com/tox-dev/tox/issues/1616>`_ ``` ### 3.17.0 ``` -------------------- Features ^^^^^^^^ - The long arguments ``--verbose`` and ``--quiet`` (rather than only their short forms, ``-v`` and ``-q``) are now accepted. `1612 <https://github.com/tox-dev/tox/issues/1612>`_ - The ``ResultLog`` now prefers ``HOSTNAME`` environment variable value (if set) over the full qualified domain name of localhost. This makes it possible to disable an undesired DNS lookup, which happened on all ``tox`` invocations, including trivial ones - by :user:`hroncok` `1615 <https://github.com/tox-dev/tox/issues/1615>`_ Documentation ^^^^^^^^^^^^^ - Update packaging information for Flit. `1613 <https://github.com/tox-dev/tox/issues/1613>`_ ``` ### 3.16.1 ``` -------------------- Bugfixes ^^^^^^^^ - Fixed the support for using ``{temp_dir}`` in ``tox.ini`` - by :user:`webknjaz` `1609 <https://github.com/tox-dev/tox/issues/1609>`_ ``` ### 3.16.0 ``` -------------------- Features ^^^^^^^^ - Allow skipping the package and installation step when passing the ``--skip-pkg-install``. This should be used in pair with the ``--notest``, so you can separate environment setup and test run: .. code-block:: console tox -e py --notest tox -e py --skip-pkg-install by :user:`gaborbernat`. `1605 <https://github.com/tox-dev/tox/issues/1605>`_ Miscellaneous ^^^^^^^^^^^^^ - Improve config parsing performance by precompiling commonly used regular expressions - by :user:`brettlangdon` `1603 <https://github.com/tox-dev/tox/issues/1603>`_ ``` ### 3.15.2 ``` -------------------- Bugfixes ^^^^^^^^ - Add an option to allow a process to suicide before sending the SIGTERM. - by :user:`jhesketh` `1497 <https://github.com/tox-dev/tox/issues/1497>`_ - PyPy 7.3.1 on Windows uses the ``Script`` folder instead of ``bin``. - by :user:`gaborbernat` `1597 <https://github.com/tox-dev/tox/issues/1597>`_ Miscellaneous ^^^^^^^^^^^^^ - Allow to run the tests with pip 19.3.1 once again while preserving the ability to use pip 20.1 - by :user:`hroncok` `1594 <https://github.com/tox-dev/tox/issues/1594>`_ ``` ### 3.15.1 ``` -------------------- Bugfixes ^^^^^^^^ - ``tox --showconfig`` no longer tries to interpolate '%' signs. `1585 <https://github.com/tox-dev/tox/issues/1585>`_ ``` ### 3.15.0 ``` -------------------- Bugfixes ^^^^^^^^ - Respect attempts to change ``PATH`` via ``setenv`` - by :user:`aklajnert`. `1423 <https://github.com/tox-dev/tox/issues/1423>`_ - Fix parsing of architecture in python interpreter name. - by :user:`bruchar1` `1542 <https://github.com/tox-dev/tox/issues/1542>`_ - Prevent exception when command is empty. - by :user:`bruchar1` `1544 <https://github.com/tox-dev/tox/issues/1544>`_ - Fix irrelevant Error message for invalid argument when running outside a directory with tox support files by :user:`nkpro2000sr`. `1547 <https://github.com/tox-dev/tox/issues/1547>`_ Features ^^^^^^^^ - Allow parallel mode without arguments. - by :user:`ssbarnea` `1418 <https://github.com/tox-dev/tox/issues/1418>`_ - Allow generative section name expansion. - by :user:`bruchar1` `1545 <https://github.com/tox-dev/tox/issues/1545>`_ - default to passing the env var PIP_EXTRA_INDEX_URL by :user:`georgealton`. `1561 <https://github.com/tox-dev/tox/issues/1561>`_ Documentation ^^^^^^^^^^^^^ - Improve documentation about config by adding tox environment description at start - by :user:`stephenfin`. `1573 <https://github.com/tox-dev/tox/issues/1573>`_ ``` ### 3.14.6 ``` -------------------- Bugfixes ^^^^^^^^ - Exclude virtualenv dependency versions with known regressions (20.0.[0-7]) - by :user:`webknjaz`. `1537 <https://github.com/tox-dev/tox/issues/1537>`_ - Fix ``tox -h`` and ``tox --hi`` shows an error when run outside a directory with tox support files by :user:`nkpro2000sr`. `1539 <https://github.com/tox-dev/tox/issues/1539>`_ - Fix ValueError on ``tox -l`` for a ``tox.ini`` file that does not contain an ``envlist`` definition. - by :user:`jquast`. `1343 <https://github.com/tox-dev/tox/issues/1343>`_ ``` ### 3.14.5 ``` -------------------- Features ^^^^^^^^ - Add ``--discover`` (fallback to ``TOX_DISCOVER`` environment variable via path separator) to inject python executables to try as first step of a discovery - note the executable still needs to match the environment by :user:`gaborbernat`. `1526 <https://github.com/tox-dev/tox/issues/1526>`_ ``` ### 3.14.4 ``` -------------------- Bugfixes ^^^^^^^^ - Bump minimal six version needed to avoid using one incompatible with newer virtualenv. - by :user:`ssbarnea` `1519 <https://github.com/tox-dev/tox/issues/1519>`_ - Avoid pypy test failure due to undefined printout var. - by :user:`ssbarnea` `1521 <https://github.com/tox-dev/tox/issues/1521>`_ Features ^^^^^^^^ - Add ``interrupt_timeout`` and ``terminate_timeout`` that configure delay between SIGINT, SIGTERM and SIGKILL when tox is interrupted. - by :user:`sileht` `1493 <https://github.com/tox-dev/tox/issues/1493>`_ - Add ``HTTP_PROXY``, ``HTTPS_PROXY`` and ``NO_PROXY`` to default passenv. - by :user:`pfmoore` `1498 <https://github.com/tox-dev/tox/issues/1498>`_ ``` ### 3.14.3 ``` -------------------- Bugfixes ^^^^^^^^ - Relax importlib requirement to allow either version 0 or 1 - by :user:`chyzzqo2` `1476 <https://github.com/tox-dev/tox/issues/1476>`_ Miscellaneous ^^^^^^^^^^^^^ - Clarify legacy setup.py error message: python projects should commit to a strong consistency of message regarding packaging. We no-longer tell people to add a setup.py to their already configured pep-517 project, otherwise it could imply that pyproject.toml isn't as well supported and recommended as it truly is - by :user:`graingert` `1478 <https://github.com/tox-dev/tox/issues/1478>`_ ``` ### 3.14.2 ``` -------------------- Bugfixes ^^^^^^^^ - Fix fallback to global configuration when running in Jenkins. - by :user:`daneah` `1428 <https://github.com/tox-dev/tox/issues/1428>`_ - Fix colouring on windows: colorama is a dep. - by :user:`1138-4EB` `1471 <https://github.com/tox-dev/tox/issues/1471>`_ Miscellaneous ^^^^^^^^^^^^^ - improve performance with internal lookup of Python version information - by :user:`blueyed` `1462 <https://github.com/tox-dev/tox/issues/1462>`_ - Use latest version of importlib_metadata package - by :user:`kammala` `1472 <https://github.com/tox-dev/tox/issues/1472>`_ - Mark poetry related tests as xfail since its dependency pyrsistent won't install in ci due to missing wheels/build deps. - by :user:`RonnyPfannschmidt` `1474 <https://github.com/tox-dev/tox/issues/1474>`_ ``` ### 3.14.1 ``` -------------------- Bugfixes ^^^^^^^^ - fix reporting of exiting due to (real) signals - by :user:`blueyed` `1401 <https://github.com/tox-dev/tox/issues/1401>`_ - Bump minimal virtualenv to 16.0.0 to improve own transitive deps handling in some ancient envs. — by :user:`webknjaz` `1429 <https://github.com/tox-dev/tox/issues/1429>`_ - Adds ``CURL_CA_BUNDLE``, ``REQUESTS_CA_BUNDLE``, ``SSL_CERT_FILE`` to the default passenv values. - by :user:`ssbarnea` `1437 <https://github.com/tox-dev/tox/issues/1437>`_ - Fix nested tox execution in the parallel mode by separating the environment variable that let's tox know it is invoked in the parallel mode (``_TOX_PARALLEL_ENV``) from the variable that informs the tests that tox is running in parallel mode (``TOX_PARALLEL_ENV``). — by :user:`hroncok` `1444 <https://github.com/tox-dev/tox/issues/1444>`_ - Fix provisioning from a pyvenv interpreter. — by :user:`kentzo` `1452 <https://github.com/tox-dev/tox/issues/1452>`_ Deprecations (removal in next major release) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Python ``3.4`` is no longer supported. — by :user:`gaborbernat` `1456 <https://github.com/tox-dev/tox/issues/1456>`_ ``` ### 3.14.0 ``` -------------------- Bugfixes ^^^^^^^^ - Fix ``PythonSpec`` detection of ``python3.10`` - by :user:`asottile` `1374 <https://github.com/tox-dev/tox/issues/1374>`_ - Fix regression failing to detect future and past ``py`` factors - by :user:`asottile` `1377 <https://github.com/tox-dev/tox/issues/1377>`_ - Fix ``current_tox_py`` for ``pypy`` / ``pypy3`` - by :user:`asottile` `1378 <https://github.com/tox-dev/tox/issues/1378>`_ - Honor environment markers in ``requires`` list - by :user:`asottile` `1380 <https://github.com/tox-dev/tox/issues/1380>`_ - improve recreate check by allowing directories containing ``.tox-config1`` (the marker file created by tox) - by :user:`asottile` `1383 <https://github.com/tox-dev/tox/issues/1383>`_ - Recognize correctly interpreters that have suffixes (like python3.7-dbg). `1415 <https://github.com/tox-dev/tox/issues/1415>`_ Features ^^^^^^^^ - Add support for minor versions with multiple digits ``tox -e py310`` works for ``python3.10`` - by :user:`asottile` `1374 <https://github.com/tox-dev/tox/issues/1374>`_ - Remove dependence on ``md5`` hashing algorithm - by :user:`asottile` `1384 <https://github.com/tox-dev/tox/issues/1384>`_ Documentation ^^^^^^^^^^^^^ - clarify behaviour if recreate is set to false - by :user:`PJCampi` `1399 <https://github.com/tox-dev/tox/issues/1399>`_ Miscellaneous ^^^^^^^^^^^^^ - Fix relative URLs to files in the repo in ``.github/PULL_REQUEST_TEMPLATE.md`` — by :user:`webknjaz` `1363 <https://github.com/tox-dev/tox/issues/1363>`_ - Replace ``importlib_metadata`` backport with ``importlib.metadata`` from the standard library on Python ``3.8+`` - by :user:`hroncok` `1367 <https://github.com/tox-dev/tox/issues/1367>`_ - Render the change fragment help on the ``docs/changelog/`` directory view on GitHub — by :user:`webknjaz` `1370 <https://github.com/tox-dev/tox/issues/1370>`_ ``` ### 3.13.2 ``` -------------------- Bugfixes ^^^^^^^^ - on venv cleanup: add explicit check for pypy venv to make it possible to recreate it - by :user:`obestwalter` `1355 <https://github.com/tox-dev/tox/issues/1355>`_ - non canonical names within :conf:`requires` cause infinite provisioning loop - by :user:`gaborbernat` `1359 <https://github.com/tox-dev/tox/issues/1359>`_ ``` ### 3.13.1 ``` -------------------- Bugfixes ^^^^^^^^ - Fix isolated build double-requirement - by :user:`asottile`. `1349 <https://github.com/tox-dev/tox/issues/1349>`_ ``` ### 3.13.0 ``` -------------------- Bugfixes ^^^^^^^^ - tox used Windows shell rules on non-Windows platforms when transforming positional arguments to a string - by :user:`barneygale`. `1336 <https://github.com/tox-dev/tox/issues/1336>`_ Features ^^^^^^^^ - Replace ``pkg_resources`` with ``importlib_metadata`` for speed - by :user:`asottile`. `1324 <https://github.com/tox-dev/tox/issues/1324>`_ - Add the ``--devenv ENVDIR`` option for creating development environments from ``[testenv]`` configurations - by :user:`asottile`. `1326 <https://github.com/tox-dev/tox/issues/1326>`_ - Refuse to delete ``envdir`` if it doesn't look like a virtualenv - by :user:`asottile`. `1340 <https://github.com/tox-dev/tox/issues/1340>`_ ``` ### 3.12.1 ``` -------------------- Bugfixes ^^^^^^^^ - Ensure ``TOX_WORK_DIR`` is a native string in ``os.environ`` - by :user:`asottile`. `1313 <https://github.com/tox-dev/tox/issues/1313>`_ - Fix import and usage of ``winreg`` for python2.7 on windows - by :user:`asottile`. `1315 <https://github.com/tox-dev/tox/issues/1315>`_ - Fix Windows selects incorrect spec on first discovery - by :user:`gaborbernat` `1317 <https://github.com/tox-dev/tox/issues/1317>`_ ``` ### 3.12.0 ``` -------------------- Bugfixes ^^^^^^^^ - When using ``--parallel`` with ``--result-json`` the test results are now included the same way as with serial runs - by :user:`fschulze` `1295 <https://github.com/tox-dev/tox/issues/1295>`_ - Turns out the output of the ``py -0p`` is not stable yet and varies depending on various edge cases. Instead now we read the interpreter values directly from registry via `PEP-514 <https://www.python.org/dev/peps/pep-0514>`_ - by :user:`gaborbernat`. `1306 <https://github.com/tox-dev/tox/issues/1306>`_ Features ^^^^^^^^ - Adding ``TOX_PARALLEL_NO_SPINNER`` environment variable to disable the spinner in parallel mode for the purposes of clean output when using CI tools - by :user:`zeroshift` `1184 <https://github.com/tox-dev/tox/issues/1184>`_ ``` ### 3.11.1 ``` -------------------- Bugfixes ^^^^^^^^ - When creating virtual environments we no longer ask the python to tell its path, but rather use the discovered path. `1301 <https://github.com/tox-dev/tox/issues/1301>`_ ``` ### 3.11.0 ``` -------------------- Features ^^^^^^^^ - ``--showconfig`` overhaul: - now fully generated via the config parser, so anyone can load it by using the built-in python config parser - the ``tox`` section contains all configuration data from config - the ``tox`` section contains a ``host_python`` key detailing the path of the host python - the ``tox:version`` section contains the versions of all packages tox depends on with their version - passing ``-l`` now allows only listing default target envs - allows showing config for a given set of tox environments only via the ``-e`` cli flag or the ``TOXENV`` environment variable, in this case the ``tox`` and ``tox:version`` section is only shown if at least one verbosity flag is passed this should help inspecting the options. `1298 <https://github.com/tox-dev/tox/issues/1298>`_ ``` ### 3.10.0 ``` -------------------- Bugfixes ^^^^^^^^ - fix for ``tox -l`` command: do not allow setting the ``TOXENV`` or the ``-e`` flag to override the listed default environment variables, they still show up under extra if non defined target - by :user:`gaborbernat` `720 <https://github.com/tox-dev/tox/issues/720>`_ - tox ignores unknown CLI arguments when provisioning is on and outside of the provisioned environment (allowing provisioning arguments to be forwarded freely) - by :user:`gaborbernat` `1270 <https://github.com/tox-dev/tox/issues/1270>`_ Features ^^^^^^^^ - Virtual environments created now no longer upgrade pip/wheel/setuptools to the latest version. Instead the start packages after virtualenv creation now is whatever virtualenv has bundled in. This allows faster virtualenv creation and builds that are easier to reproduce. `448 <https://github.com/tox-dev/tox/issues/448>`_ - Improve python discovery and add architecture support: - UNIX: - First, check if the tox host Python matches. - Second, check if the the canonical name (e.g. ``python3.7``, ``python3``) matches or the base python is an absolute path, use that. - Third, check if the the canonical name without version matches (e.g. ``python``, ``pypy``) matches. - Windows: - First, check if the tox host Python matches. - Second, use the ``py.exe`` to list registered interpreters and any of those match. - Third, check if the the canonical name (e.g. ``python3.7``, ``python3``) matches or the base python is an absolute path, use that. - Fourth, check if the the canonical name without version matches (e.g. ``python``, ``pypy``) matches. - Finally, check for known locations (``c:\python{major}{minor}\python.exe``). tox environment configuration generation is now done in parallel (to alleviate the slowdown due to extra checks). `1290 <https://github.com/tox-dev/tox/issues/1290>`_ ``` ### 3.9.0 ``` ------------------- Bugfixes ^^^^^^^^ - Fix ``congratulations`` when using ``^C`` during virtualenv creation - by :user:`asottile` `1257 <https://github.com/tox-dev/tox/issues/1257>`_ Features ^^^^^^^^ - Allow having inline comments in :conf:`deps` — by :user:`webknjaz` `1262 <https://github.com/tox-dev/tox/issues/1262>`_ ``` ### 3.8.6 ``` ------------------- Bugfixes ^^^^^^^^ - :conf:`parallel_show_output` does not work with tox 3.8 `1245 <https://github.com/tox-dev/tox/issues/1245>`_ ``` ### 3.8.5 ``` ------------------- Bugfixes ^^^^^^^^ - the isolated build env now ignores :conf:`sitepackages`, :conf:`deps` and :conf:`description` as these do not make sense - by :user:`gaborbernat` `1239 <https://github.com/tox-dev/tox/issues/1239>`_ - Do not print timings with more than 3 decimal digits on Python 3 - by :user:`mgedmin`. `1241 <https://github.com/tox-dev/tox/issues/1241>`_ ``` ### 3.8.4 ``` ------------------- Bugfixes ^^^^^^^^ - Fix sdist creation on python2.x when there is non-ascii output. `1234 <https://github.com/tox-dev/tox/issues/1234>`_ - fix typos in isolated.py that made it impossible to install package with requirements in pyproject.toml - by :user:`unmade` `1236 <https://github.com/tox-dev/tox/issues/1236>`_ ``` ### 3.8.3 ``` ------------------- Bugfixes ^^^^^^^^ - don't crash when version information is not available for a proposed base python - by :user:`gaborbernat` `1227 <https://github.com/tox-dev/tox/issues/1227>`_ - Do not print exception traceback when the provisioned tox fails - by :user:`gaborbernat` `1228 <https://github.com/tox-dev/tox/issues/1228>`_ ``` ### 3.8.2 ``` ------------------- Bugfixes ^^^^^^^^ - using -v and -e connected (as -ve) fails - by :user:`gaborbernat` `1218 <https://github.com/tox-dev/tox/issues/1218>`_ - Changes to the plugin tester module (cmd no longer sets ``PYTHONPATH``), and ``action.popen`` no longer returns the command identifier information from within the logs. No public facing changes. `1222 <https://github.com/tox-dev/tox/issues/1222>`_ - Spinner fails in CI on ``UnicodeEncodeError`` - by :user:`gaborbernat` `1223 <https://github.com/tox-dev/tox/issues/1223>`_ ``` ### 3.8.1 ``` ------------------- Bugfixes ^^^^^^^^ - The ``-eALL`` command line argument now expands the ``envlist`` key and includes all its environment. `1155 <https://github.com/tox-dev/tox/issues/1155>`_ - Isolated build environment dependency overrides were not taken in consideration (and such it inherited the deps from the testenv section) - by :user:`gaborbernat` `1207 <https://github.com/tox-dev/tox/issues/1207>`_ - ``--result-json`` puts the command into setup section instead of test (pre and post commands are now also correctly put into the commands section) - by :user:`gaborbernat` `1210 <https://github.com/tox-dev/tox/issues/1210>`_ - Set ``setup.cfg`` encoding to UTF-8 as it contains Unicode characters. `1212 <https://github.com/tox-dev/tox/issues/1212>`_ - Fix tox CI, better error reporting when locating via the py fails - by :user:`gaborbernat` `1215 <https://github.com/tox-dev/tox/issues/1215>`_ ``` ### 3.8.0 ``` ------------------- Bugfixes ^^^^^^^^ - In a posix shell, setting the PATH environment variable to an empty value is equivalent to not setting it at all; therefore we no longer if the user sets PYTHONPATH an empty string on python 3.4 or later - by :user:`gaborbernat`. `1092 <https://github.com/tox-dev/tox/issues/1092>`_ - Fixed bug of children process calls logs clashing (log already exists) - by :user:`gaborbernat` `1137 <https://github.com/tox-dev/tox/issues/1137>`_ - Interpreter discovery and virtualenv creation process calls that failed will now print out on the screen their output (via the logfile we automatically save) - by :user:`gaborbernat` `1150 <https://github.com/tox-dev/tox/issues/1150>`_ - Using ``py2`` and ``py3`` with a specific ``basepython`` will no longer raise a warning unless the major version conflicts - by :user:`demosdemon`. `1153 <https://github.com/tox-dev/tox/issues/1153>`_ - Fix missing error for ``tox -e unknown`` when tox.ini declares ``envlist``. - by :user:`medmunds` `1160 <https://github.com/tox-dev/tox/issues/1160>`_ - Resolve symlinks with ``toxworkdir`` - by :user:`blueyed`. `1169 <https://github.com/tox-dev/tox/issues/1169>`_ - Interrupting a tox call (e.g. via CTRL+C) now will ensure that spawn child processes (test calls, interpreter discovery, parallel sub-instances, provisioned hosts) are correctly stopped before exiting (via the pattern of INTERRUPT - 300 ms, TERMINATE - 200 ms, KILL signals) - by :user:`gaborbernat` `1172 <https://github.com/tox-dev/tox/issues/1172>`_ - Fix a ``ResourceWarning: unclosed file`` in ``Action`` - by :user:`BoboTiG`. `1179 <https://github.com/tox-dev/tox/issues/1179>`_ - Fix deadlock when using ``--parallel`` and having environments with lots of output - by :user:`asottile`. `1183 <https://github.com/tox-dev/tox/issues/1183>`_ - Removed code that sometimes caused a difference in results between ``--parallel`` and ``-p`` when using ``posargs`` - by :user:`timdaman` `1192 <https://github.com/tox-dev/tox/issues/1192>`_ Features ^^^^^^^^ - tox now auto-provisions itself if needed (see :ref:`auto-provision`). Plugins or minimum version of tox no longer need to be manually satisfied by the user, increasing their ease of use. - by :user:`gaborbernat` `998 <https://github.com/tox-dev/tox/issues/998>`_ - tox will inject the ``TOX_PARALLEL_ENV`` environment variable, set to the current running tox environment name, only when running in parallel mode. - by :user:`gaborbernat` `1139 <https://github.com/tox-dev/tox/issues/1139>`_ - Parallel children now save their output to a disk logfile - by :user:`gaborbernat` `1143 <https://github.com/tox-dev/tox/issues/1143>`_ - Parallel children now are added to ``--result-json`` - by :user:`gaborbernat` `1159 <https://github.com/tox-dev/tox/issues/1159>`_ - Display pattern and ``sys.platform`` with platform mismatch - by :user:`blueyed`. `1176 <https://github.com/tox-dev/tox/issues/1176>`_ - Setting the environment variable ``TOX_REPORTER_TIMESTAMP`` to ``1`` will enable showing for each output line its delta since the tox startup. This can be especially handy when debugging parallel runs.- by :user:`gaborbernat` `1203 <https://github.com/tox-dev/tox/issues/1203>`_ Documentation ^^^^^^^^^^^^^ - Add a ``poetry`` examples to packaging - by :user:`gaborbernat` `1163 <https://github.com/tox-dev/tox/issues/1163>`_ ``` ### 3.7.0 ``` ------------------- Features ^^^^^^^^ - Parallel mode added (alternative to ``detox`` which is being deprecated), for more details see :ref:`parallel_mode` - by :user:`gaborbernat`. `439 <https://github.com/tox-dev/tox/issues/439>`_ - Added command line shortcut ``-s`` for ``--skip-missing-interpreters`` - by :user:`evandrocoan` `1119 <https://github.com/tox-dev/tox/issues/1119>`_ Deprecations (removal in next major release) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Whitelisting of externals will be mandatory in tox 4: issue a deprecation warning as part of the already existing warning - by :user:`obestwalter` `1129 <https://github.com/tox-dev/tox/issues/1129>`_ Documentation ^^^^^^^^^^^^^ - Clarify explanations in examples and avoid unsupported end line comments - by :user:`obestwalter` `1110 <https://github.com/tox-dev/tox/issues/1110>`_ - Set to PULL_REQUEST_TEMPLATE.md use relative instead of absolute URLs - by :user:`evandrocoan` Fixed PULL_REQUEST_TEMPLATE.md path for changelog/examples.rst to docs/changelog/examples.rst - by :user:`evandrocoan` `1120 <https://github.com/tox-dev/tox/issues/1120>`_ ``` ### 3.6.1 ``` ------------------- Features ^^^^^^^^ - if the packaging phase successfully builds a package set it as environment variable under ``TOX_PACKAGE`` (useful to make assertions on the built package itself, instead of just how it ends up after installation) - by :user:`gaborbernat` (`1081 <https://github.com/tox-dev/tox/issues/1081>`_) ``` ### 3.6.0 ``` ------------------- Bugfixes ^^^^^^^^ - On windows, check ``sys.executable`` before others for interpreter version lookup. This matches what happens on non-windows. (`1087 <https://github.com/tox-dev/tox/issues/1087>`_) - Don't rewrite ``{posargs}`` substitution for absolute paths. (`1095 <https://github.com/tox-dev/tox/issues/1095>`_) - Correctly fail ``tox --notest`` when setup fails. (`1097 <https://github.com/tox-dev/tox/issues/1097>`_) Documentation ^^^^^^^^^^^^^ - Update Contributor Covenant URL to use https:// - by :user:`jdufresne`. (`#1082 <https://github.com/tox-dev/tox/issues/1082>`_) - Correct the capitalization of PyPI throughout the documentation - by :user:`jdufresne`. (`1084 <https://github.com/tox-dev/tox/issues/1084>`_) - Link to related projects (Invoke and Nox) from the documentation - by :user:`theacodes`. (`1088 <https://github.com/tox-dev/tox/issues/1088>`_) Miscellaneous ^^^^^^^^^^^^^ - Include the license file in the wheel distribution - by :user:`jdufresne`. (`1083 <https://github.com/tox-dev/tox/issues/1083>`_) ``` ### 3.5.3 ``` ------------------- Bugfixes ^^^^^^^^ - Fix bug with incorrectly defactorized dependencies - by :user:`bartsanchez` (`706 <https://github.com/tox-dev/tox/issues/706>`_) - do the same transformation to ``egg_info`` folders that ``pkg_resources`` does; this makes it possible for hyphenated names to use the ``develop-inst-noop`` optimization (cf. 910), which previously only worked with non-hyphenated egg names - by :user:`hashbrowncipher` (`1051 <https://github.com/tox-dev/tox/issues/1051>`_) - previously, if a project's ``setup.py --name`` emitted extra information to stderr, tox would capture it and consider it part of the project's name; now, emissions to stderr are printed to the console - by :user:`hashbrowncipher` (`1052 <https://github.com/tox-dev/tox/issues/1052>`_) - change the way we acquire interpreter information to make it compatible with ``jython`` interpreter, note to create jython envs one needs ``virtualenv > 16.0`` which will be released later :user:`gaborbernat` (`1073 <https://github.com/tox-dev/tox/issues/1073>`_) Documentation ^^^^^^^^^^^^^ - document substitutions with additional content starting with a space cannot be alone on a line inside the ini file - by :user:`gaborbernat` (`437 <https://github.com/tox-dev/tox/issues/437>`_) - change the spelling of a single word from contrains to the proper word, constraints - by :user:`metasyn` (`1061 <https://github.com/tox-dev/tox/issues/1061>`_) - Mention the minimum version required for ``commands_pre``/``commands_post`` support. (`1071 <https://github.com/tox-dev/tox/issues/1071>`_) ``` ### 3.5.2 ``` ------------------- Bugfixes ^^^^^^^^ - session packages are now put inside a numbered directory (instead of prefix numbering it, because pip fails when wheels are not named according to `PEP-491 <https://www.python.org/dev/peps/pep-0491/#id9>`_, and prefix numbering messes with this) - by :user:`gaborbernat` (`1042 <https://github.com/tox-dev/tox/issues/1042>`_) Features ^^^^^^^^ - level three verbosity (``-vvv``) show the packaging output - by :user:`gaborbernat` (`1047 <https://github.com/tox-dev/tox/issues/1047>`_) ``` ### 3.5.1 ``` ------------------- Bugfixes ^^^^^^^^ - fix regression with ``3.5.0``: specifying ``--installpkg`` raises ``AttributeError: 'str' object has no attribute 'basename'`` (`1042 <https://github.com/tox-dev/tox/issues/1042>`_) ``` ### 3.5.0 ``` ------------------- Bugfixes ^^^^^^^^ - intermittent failures with ``--parallel--safe-build``, instead of mangling with the file paths now uses a lock to make the package build operation thread safe and is now on by default (``--parallel--safe-build`` is now deprecated) - by :user:`gaborbernat` (`1026 <https://github.com/tox-dev/tox/issues/1026>`_) Features ^^^^^^^^ - Added ``temp_dir`` folder configuration (defaults to ``{toxworkdir}/.tmp``) that contains tox temporary files. Package builds now create a hard link (if possible, otherwise copy - notably in case of Windows Python 2.7) to the built file, and feed that file downstream (e.g. for pip to install it). The hard link is removed at the end of the run (what it points though is kept inside ``distdir``). This ensures that a tox session operates on the same package it built, even if a parallel tox run builds another version. Note ``distdir`` will contain only the last built package in such cases. - by :user:`gaborbernat` (`1026 <https://github.com/tox-dev/tox/issues/1026>`_) Documentation ^^^^^^^^^^^^^ - document tox environment recreate rules (:ref:`recreate`) - by :user:`gaborbernat` (`93 <https://github.com/tox-dev/tox/issues/93>`_) - document inside the ``--help`` how to disable colorized output via the ``PY_COLORS`` operating system environment variable - by :user:`gaborbernat` (`163 <https://github.com/tox-dev/tox/issues/163>`_) - document all global tox flags and a more concise format to express default and type - by :user:`gaborbernat` (`683 <https://github.com/tox-dev/tox/issues/683>`_) - document command line interface under the config section `cli <https://tox.readthedocs.io/en/latest/config.html?highlight=cli#cli>`_ - by :user:`gaborbernat` (`829 <https://github.com/tox-dev/tox/issues/829>`_) ``` ### 3.4.0 ``` ------------------- Bugfixes ^^^^^^^^ - add ``--exists-action w`` to default pip flags to handle better VCS dependencies (`pip documentation on this <https://pip.pypa.io/en/latest/reference/pip/#exists-action-option>`_) - by :user:`gaborbernat` (`503 <https://github.com/tox-dev/tox/issues/503>`_) - instead of assuming the Python version from the base python name ask the interpreter to reveal the version for the ``ignore_basepython_conflict`` flag - by :user:`gaborbernat` (`908 <https://github.com/tox-dev/tox/issues/908>`_) - PEP-517 packaging fails with sdist already exists, fixed via ensuring the dist folder is empty before invoking the backend and `pypa/setuptools 1481 <https://github.com/pypa/setuptools/pull/1481>`_ - by :user:`gaborbernat` (`#1003 <https://github.com/tox-dev/tox/issues/1003>`_) Features ^^^^^^^^ - add ``commands_pre`` and ``commands_post`` that run before and after running the ``commands`` (setup runs always, commands only if setup succeeds, teardown always - all run until the first failing command) - by :user:`gaborbernat` (`167 <https://github.com/tox-dev/tox/issues/167>`_) - ``pyproject.toml`` config support initially by just inline the tox.ini under ``tool.tox.legacy_tox_ini`` key; config source priority order is ``pyproject.toml``, ``tox.ini`` and then ``setup.cfg`` - by :user:`gaborbernat` (`814 <https://github.com/tox-dev/tox/issues/814>`_) - use the os environment variable ``TOX_SKIP_ENV`` to filter out tox environment names from the run list (set by ``envlist``) - by :user:`gaborbernat` (`824 <https://github.com/tox-dev/tox/issues/824>`_) - always set ``PIP_USER=0`` (do not install into the user site package, but inside the virtual environment created) and ``PIP_NO_DEPS=0`` (installing without dependencies can cause broken package installations) inside tox - by :user:`gaborbernat` (`838 <https://github.com/tox-dev/tox/issues/838>`_) - tox will inject some environment variables that to indicate a command is running within tox: ``TOX_WORK_DIR`` env var is set to the tox work directory, ``TOX_ENV_NAME`` is set to the current running tox environment name, ``TOX_ENV_DIR`` is set to the current tox environments working dir - by :user:`gaborbernat` (`847 <https://github.com/tox-dev/tox/issues/847>`_) - While running tox invokes various commands (such as building the package, pip installing dependencies and so on), these were printed in case they failed as Python arrays. Changed the representation to a shell command, allowing the users to quickly replicate/debug the failure on their own - by :user:`gaborbernat` (`851 <https://github.com/tox-dev/tox/issues/851>`_) - skip missing interpreters value from the config file can now be overridden via the ``--skip-missing-interpreters`` cli flag - by :user:`gaborbernat` (`903 <https://github.com/tox-dev/tox/issues/903>`_) - keep additional environments config order when listing them - by :user:`gaborbernat` (`921 <https://github.com/tox-dev/tox/issues/921>`_) - allow injecting config value inside the ini file dependent of the fact that we're connected to an interactive shell or not - by :user:`gaborbernat` (`947 <https://github.com/tox-dev/tox/issues/947>`_) - do not build sdist if skip install is specified for the envs to be run - by :user:`gaborbernat` (`974 <https://github.com/tox-dev/tox/issues/974>`_) - when verbosity level increases above two start passing through verbosity flags to pip - by :user:`gaborbernat` (`982 <https://github.com/tox-dev/tox/issues/982>`_) - when discovering the interpreter to use check if the tox host Python matches and use that if so - by :user:`gaborbernat` (`994 <https://github.com/tox-dev/tox/issues/994>`_) - ``-vv`` will print out why a virtual environment is re-created whenever this operation is triggered - by :user:`gaborbernat` (`1004 <https://github.com/tox-dev/tox/issues/1004>`_) Documentation ^^^^^^^^^^^^^ - clarify that ``python`` and ``pip`` refer to the virtual environments executable - by :user:`gaborbernat` (`305 <https://github.com/tox-dev/tox/issues/305>`_) - add Sphinx and mkdocs example of generating documentation via tox - by :user:`gaborbernat` (`374 <https://github.com/tox-dev/tox/issues/374>`_) - specify that ``setup.cfg`` tox configuration needs to be inside the ``tox:tox`` namespace - by :user:`gaborbernat` (`545 <https://github.com/tox-dev/tox/issues/545>`_) ``` ### 3.3.0 ``` ------------------- Bugfixes ^^^^^^^^ - fix ``TOX_LIMITED_SHEBANG`` when running under python3 - by :user:`asottile` (`931 <https://github.com/tox-dev/tox/issues/931>`_) Features ^^^^^^^^ - `PEP-517 <https://www.python.org/dev/peps/pep-0517/>`_ source distribution support (create a ``.package`` virtual environment to perform build operations inside) by :user:`gaborbernat` (`573 <https://github.com/tox-dev/tox/issues/573>`_) - `flit <https://flit.readthedocs.io>`_ support via implementing ``PEP-517`` by :user:`gaborbernat` (`#820 <https://github.com/tox-dev/tox/issues/820>`_) - packaging now is exposed as a hook via ``tox_package(session, venv)`` - by :user:`gaborbernat` (`951 <https://github.com/tox-dev/tox/issues/951>`_) Miscellaneous ^^^^^^^^^^^^^ - Updated the VSTS build YAML to use the latest jobs and pools syntax - by :user:`davidstaheli` (`955 <https://github.com/tox-dev/tox/issues/955>`_) ``` ### 3.2.1 ``` ------------------- Bugfixes ^^^^^^^^ - ``--parallel--safe-build`` no longer cleans up its folders (``distdir``, ``distshare``, ``log``). - by :user:`gaborbernat` (`849 <https://github.com/tox-dev/tox/issues/849>`_) ``` ### 3.2.0 ``` ------------------- Features ^^^^^^^^ - Switch pip invocations to use the module ``-m pip`` instead of direct invocation. This could help avoid some of the shebang limitations. - by :user:`gaborbernat` (`935 <https://github.com/tox-dev/tox/issues/935>`_) - Ability to specify package requirements for the tox run via the ``tox.ini`` (``tox`` section under key ``requires`` - PEP-508 style): can be used to specify both plugin requirements or build dependencies. - by :user:`gaborbernat` (`783 <https://github.com/tox-dev/tox/issues/783>`_) - Allow one to run multiple tox instances in parallel by providing the ``--parallel--safe-build`` flag. - by :user:`gaborbernat` (`849 <https://github.com/tox-dev/tox/issues/849>`_) ``` ### 3.1.3 ``` ------------------- Bugfixes ^^^^^^^^ - A caching issue that caused the ``develop-inst-nodeps`` action, which reinstalls the package under test, to always run has been resolved. The ``develop-inst-noop`` action, which, as the name suggests, is a no-op, will now run unless there are changes to ``setup.py`` or ``setup.cfg`` files that have not been reflected - by stephenfin (`909 <https://github.com/tox-dev/tox/issues/909>`_) Features ^^^^^^^^ - Python version testenvs are now automatically detected instead of comparing against a hard-coded list of supported versions. This enables ``py38`` and eventually ``py39`` / ``py40`` / etc. to work without requiring an upgrade to ``tox``. As such, the following public constants are now deprecated (and scheduled for removal in ``tox`` 4.0: ``CPYTHON_VERSION_TUPLES``, ``PYPY_VERSION_TUPLES``, ``OTHER_PYTHON_INTERPRETERS``, and ``DEFAULT_FACTORS`` - by :user:`asottile` (`914 <https://github.com/tox-dev/tox/issues/914>`_) Documentation ^^^^^^^^^^^^^ - Add a system overview section on the index page that explains briefly how tox works - by :user:`gaborbernat`. (`867 <https://github.com/tox-dev/tox/issues/867>`_) ``` ### 3.1.2 ``` ------------------- Bugfixes ^^^^^^^^ - Revert "Fix bug with incorrectly defactorized dependencies (`772 <https://github.com/tox-dev/tox/issues/772>`_)" due to a regression (`(#799) <https://github.com/tox-dev/tox/issues/899>`_) - by :user:`obestwalter` ``` ### 3.1.1 ``` ------------------- Bugfixes ^^^^^^^^ - PyPI documentation for ``3.1.0`` is broken. Added test to check for this, and fix it by :user:`gaborbernat`. (`879 <https://github.com/tox-dev/tox/issues/879>`_) ``` ### 3.1.0 ``` ------------------- Bugfixes ^^^^^^^^ - Add ``ignore_basepython_conflict``, which determines whether conflicting ``basepython`` settings for environments containing default factors, such as ``py27`` or ``django18-py35``, should be ignored or result in warnings. This was a common source of misconfiguration and is rarely, if ever, desirable from a user perspective - by :user:`stephenfin` (`477 <https://github.com/tox-dev/tox/issues/477>`_) - Fix bug with incorrectly defactorized dependencies (deps passed to pip were not de-factorized) - by :user:`bartsanchez` (`706 <https://github.com/tox-dev/tox/issues/706>`_) Features ^^^^^^^^ - Add support for multiple PyPy versions using default factors. This allows you to use, for example, ``pypy27`` knowing that the correct interpreter will be used by default - by :user:`stephenfin` (`19 <https://github.com/tox-dev/tox/issues/19>`_) - Add support to explicitly invoke interpreter directives for environments with long path lengths. In the event that ``tox`` cannot invoke scripts with a system-limited shebang (e.x. a Linux host running a Jenkins Pipeline), a user can set the environment variable ``TOX_LIMITED_SHEBANG`` to workaround the system's limitation (e.x. ``export TOX_LIMITED_SHEBANG=1``) - by :user:`jdknight` (`794 <https://github.com/tox-dev/tox/issues/794>`_) - introduce a constants module to be used internally and as experimental API - by :user:`obestwalter` (`798 <https://github.com/tox-dev/tox/issues/798>`_) - Make ``py2`` and ``py3`` aliases also resolve via ``py`` on windows by :user:`asottile`. This enables the following things: ``tox -e py2`` and ``tox -e py3`` work on windows (they already work on posix); and setting ``basepython=python2`` or ``basepython=python3`` now works on windows. (`856 <https://github.com/tox-dev/tox/issues/856>`_) - Replace the internal version parsing logic from the not well tested `PEP-386 <https://www.python.org/dev/peps/pep-0386/>`_ parser for the more general `PEP-440 <https://www.python.org/dev/peps/pep-0440/>`_. `packaging >= 17.1 <https://pypi.org/project/packaging/>`_ is now an install dependency by :user:`gaborbernat`. (`#860 <https://github.com/tox-dev/tox/issues/860>`_) Documentation ^^^^^^^^^^^^^ - extend the plugin documentation and make lot of small fixes and improvements - by :user:`obestwalter` (`797 <https://github.com/tox-dev/tox/issues/797>`_) - tidy up tests - remove unused fixtures, update old cinstructs, etc. - by :user:`obestwalter` (`799 <https://github.com/tox-dev/tox/issues/799>`_) - Various improvements to documentation: open browser once documentation generation is done, show Github/Travis info on documentation page, remove duplicate header for changelog, generate unreleased news as DRAFT on top of changelog, make the changelog page more compact and readable (width up to 1280px) by :user:`gaborbernat` (`859 <https://github.com/tox-dev/tox/issues/859>`_) Miscellaneous ^^^^^^^^^^^^^ - filter out unwanted files in package - by :user:`obestwalter` (`754 <https://github.com/tox-dev/tox/issues/754>`_) - make the already existing implicit API explicit - by :user:`obestwalter` (`800 <https://github.com/tox-dev/tox/issues/800>`_) - improve tox quickstart and corresponding tests - by :user:`obestwalter` (`801 <https://github.com/tox-dev/tox/issues/801>`_) - tweak codecov settings via .codecov.yml - by :user:`obestwalter` (`802 <https://github.com/tox-dev/tox/issues/802>`_) ```Links
- PyPI: https://pypi.org/project/tox - Changelog: https://pyup.io/changelogs/tox/ - Docs: http://tox.readthedocs.org