Do not use setup.cfg file that does not have tox:tox namespace #1642
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When tox is invoked without a tox configuration file (and without command line
options that could be used instead), it fails with:
$ tox
ERROR: tox config file (either pyproject.toml, tox.ini, setup.cfg) not found
This is useful: If there is no config, test didn't run and such error should
not pass silently.
However, until this commit, when there was a setup.cfg file it was considered
as a tox config even when there was no [tox:tox] section:
$ tox
GLOB sdist-make: .../setup.py
python create: .../.tox/python
python inst: ...
python installed: ...
python run-test-pre: PYTHONHASHSEED='1234567890'
___________________________________ summary ____________________________________
python: commands succeeded
congratulations :)
That is not safe, because setup.cfg can exist even if there is no tox
configuration in it and the success creates a false sense of safety.
To fix this and to match the behavior of pyproject.toml without a tox section,
tox now skips setup.cfg, if there is no [tox:tox] section.
Fixes tox-dev#1045
hroncok
requested review from
asottile,
gaborbernat and
obestwalter
as code owners
|
heheh I actually noticed this behaviour recently and considered it a feature (at least for will try this branch out and poke around a bit 👍 |
|
Well, if it is useful to allow devenv without configuration, let's do that explicitly and not just with setup.cfg? |
gaborbernat
approved these changes
Aug 6, 2020
ssbarnea
pushed a commit
to ssbarnea/tox
that referenced
this pull request
Apr 19, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Do not use setup.cfg file that does not have tox:tox namespace
When tox is invoked without a tox configuration file (and without command line
options that could be used instead), it fails with:
This is useful: If there is no config, test didn't run and such error should
not pass silently.
However, until this commit, when there was a setup.cfg file it was considered
as a tox config even when there was no
[tox:tox]section:That is not safe, because setup.cfg can exist even if there is no tox
configuration in it and the success creates a false sense of safety.
To fix this and to match the behavior of pyproject.toml without a tox section,
tox now skips setup.cfg, if there is no
[tox:tox]section.Fixes #1045
Contribution checklist:
CONTRIBUTORS(preserving alphabetical order)