Global CLI flag should override env var flag #10423
Merged
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10423 +/- ##
==========================================
- Coverage 88.81% 88.81% -0.01%
==========================================
Files 180 180
Lines 22558 22562 +4
==========================================
+ Hits 20036 20038 +2
- Misses 2522 2524 +2
Flags with carried forward coverage won't be shown. Click here to find out more.
|
2 tasks
ChenyuLInx
approved these changes
Jul 10, 2024
| @@ -380,6 +380,22 @@ def test_global_flag_at_child_context(self): | |||
|
|
|||
| assert flags_a.USE_COLORS == flags_b.USE_COLORS | |||
|
|
|||
| def test_global_flag_with_env_var(self, monkeypatch): | |||
github-actions bot
pushed a commit
that referenced
this pull request
Jul 10, 2024
(cherry picked from commit 601fee0)
gshank
added a commit
that referenced
this pull request
Jul 12, 2024
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.
resolves #10304
Problem
When both an environment variable and a command line flag are provided, the cli flag should override the environment variable. This wasn't happening for "global" flags, which can occur both before and after the sub command, when the flag came after the command.
Solution
The click context contains a "child" context for command options and a "parent" context for flags which occur before the command. If there was no "cli" setting for a flag, it would use the env var. When processing the parent context flags we add code to check if the source of this parameter is an env var, and do not overwrite the value of the param if it has already been set by the user.
Checklist