Adding ArgumentDefaultsHelpFormatter to EntryPoint.parser#2546
Open
drewj-tp wants to merge 1 commit into
Open
Conversation
Helps show more information about the default value for a given argument. For example, from the output of `armi vis-file -h` ``` --format, -f FORMAT Output format. Supported formats: `vtk` and `xdmf` (default: vtk) --nodes NODES An optional list of time nodes to include. Should look like `(1,0)(1,1)(1,2)`, etc (default: None) --max-node MAX_NODE An optional (cycle,timeNode) tuple to specify the latest time step that should be included (default: None) --min-node MIN_NODE An optional (cycle,timeNode) tuple to specify the earliest time step that should be included (default: None) ```
opotowsky
approved these changes
May 29, 2026
Member
opotowsky
left a comment
There was a problem hiding this comment.
I'm a fan for more CLI help info!
Member
|
testing this, it's glorious. why is this not the default argparse behavior, grumble grumble. |
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
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.
What is the change? Why is it being made?
Helps show more information about the default value for a given argument. For example, from the output of
armi vis-file -hOther cases where this may be useful:
The
armi submit-suitehas a runtime dependent default for--suiteDir(current working directory) that also nicely populatesSCR Information
Change Type: trivial
One-Sentence Rationale: Plugins can have complicated, run time dependent defaults and this helps automatically display them
One-line Impact on Requirements: NA
Checklist
docfolder.pyproject.toml.