True TOML config support #3353
True TOML config support #3353
Conversation
gaborbernat
force-pushed
the
toml
branch
3 times, most recently
from
9819aeb to
f2a6f74
Compare
gaborbernat
force-pushed
the
toml
branch
16 times, most recently
from
9a8a916 to
7cc25cf
Compare
Signed-off-by: Bernát Gábor <[email protected]>
Signed-off-by: Bernát Gábor <[email protected]>
gaborbernat
force-pushed
the
toml
branch
6 times, most recently
from
9b75bf8 to
e3bf846
Compare
gaborbernat
force-pushed
the
toml
branch
3 times, most recently
from
57c4e5c to
43d8113
Compare
Signed-off-by: Bernát Gábor <[email protected]>
Following tox-dev/tox#3353 there is now full native TOML support for `tox`
Following tox-dev/tox#3353 but pending ymyzk/tox-gh-actions#197
| install tox into an isolated environment. This has the added benefit that later you'll be able to upgrade tox without | ||
| affecting other parts of the system. | ||
| :pypi:`tox` is a CLI tool that needs a Python interpreter (version 3.7 or higher) to run. We recommend either | ||
| :pypi:`pipx` or :pypi:`ruff` to install tox into an isolated environment. This has the added benefit that later you'll |
There was a problem hiding this comment.
is this a typo? should it be uv and not ruff?
|
|
||
| .. code-block:: bash | ||
|
|
||
| tox --override env_run_base.deps+=pytest-xdist |
There was a problem hiding this comment.
I find it odd that overrides depend on the config file format. I'd expect the options to behave the same way regardless of the config file format.
At least it should be noted that default of base option is format-dependent above.
There was a problem hiding this comment.
Achieving this goal would require that the syntax for the new file format to be very ugly. testenv:whatever Is very much something we inherited in the INI world. Furthermore, this is already the case when using setup.CFG over tox.ini.
There was a problem hiding this comment.
If you read the configuration file format introduction section, it clearly calls out the differences.
| Historically, the INI format was created first, and TOML was added in 2024. The TOML format generally is more robust, | ||
| however is less powerful and more verbose. You should use TOML unless you need some of the more advanced features | ||
| that TOML does not support (such as conditional factors, generative environments to name a few -- however, PRs to | ||
| add support for these in TOML is welcome). |
There was a problem hiding this comment.
I'd mark TOML config as experimental until all these are supported. Supporting those may affect the TOML file structure.
There was a problem hiding this comment.
I disagree. Some of these features I explicitly do not want to support in the new format (such as conditional factors). The TOML file Format is just not a good match for it.
| ``tox.toml`` | ||
| ~~~~~~~~~~~~ | ||
|
|
||
| This configuration file is equivalent to :ref:`pyproject.toml - native <pyproject-toml-native>` with the difference |
There was a problem hiding this comment.
I very appreciate the option to have a separate TOML file 👍
Done:
pyproject.tomlsourcetox.tomlsourcehttps://tox--3353.org.readthedocs.build/en/3353/config.html#tox-toml
Resolves #999.