🐛 fix(cli): allow --help with invalid config#3821
Merged
gaborbernat merged 2 commits intotox-dev:mainfrom Feb 24, 2026
Merged
Conversation
Config discovery errors were preventing --help from rendering because _get_base() calls discover_source() after catching the SystemExit from argparse's help handling. When the config file is malformed, the HandledError propagates before argparse can display help in _get_all(). Fall back to an empty source when help is requested and config loading fails, so users can still access help output regardless of config state. Fixes tox-dev#3819
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Config discovery errors were preventing
--helpfrom rendering because_get_base()callsdiscover_source()which raisesHandledErroron malformed config files. This propagates before argparse can display help output in_get_all(). Fixes #3819.When
--helpis requested and config loading fails, tox now falls back to an empty source so users can still access help output regardless of config state. This only applies when-hor--helpis in the arguments — all other invocations still raise the config error as before.