fix: properly interpret flag values #8326
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
Both `--preemptible` and `--preemption-enabled` cast values with the built-in `bool`, which casts to True any possible value but "0". Even "false" and "False". This is almost certainly not what users expect. Using `string_to_bool`, "0" is still supported. But now all the strings that should evaluate to False do, too.
✅ Deploy Preview for determined-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
ioga
reviewed
Nov 3, 2023
| @@ -427,7 +427,7 @@ def parse(s: str) -> Tuple[str, str]: | |||
| ), | |||
| Arg( | |||
| "--preemptible", | |||
| type=bool, | |||
| type=string_to_bool, | |||
There was a problem hiding this comment.
why is this string_to_bool and not BoolOptArg?
There was a problem hiding this comment.
You're right.
Reasoning was that despite its name, BoolOptArg args aren't really optional, and aren't appropriate when the system doesn't want defaults. But this is one of those cases where having defaults is appropriate. I'll fix.
There was a problem hiding this comment.
Well, maybe not. 2 reasons:
- (minor reason) Switching to
BoolOptArgchanges the interface from--preemptible=true|falseto--preemptible|--no-preemptible, and this is more likely to have user impact. - (major reason) Each of these args is a part of an
ArgGroup, which contains a list ofArgs.BoolOptArgsare notArgsand do not look likeArgsand at this point I think refactoringBoolOptArgsor shimming an interface is not worth this PR. I could just make eachArgGroup'schild_argslist contain a union ofArgsandBoolOptArgs, but this feels like asking for trouble in the future if I don't unify the interface. I'm not convinced that it's worth spending a lot of time ondeclarative_argparse's lesser-used features because I'm not sure what the future ofdeclarative_argparsewill be.
ioga
approved these changes
Nov 6, 2023
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.
Both
--preemptibleand--preemption-enabledcast values with the built-inbool, which casts to True any possible value but "0". Even "false" and "False". This is almost certainly not what users expect.Using
string_to_bool, "0" is still supported. But now all the strings that should evaluate to False do, too.Description
Test Plan
ROI on testing this might not be high, but:
Deploy a cluster to GCP with
det deploy gcp upwith different values for--preemptibleand--preemption-enabled.Commentary (optional)
Checklist
docs/release-notes/.See Release Note for details.
Ticket