🐛 Ensure an optional argument is shown in brackets, even when metavar is set
#1409
+10
−9
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
Contributor
📝 Docs previewLast commit b482a50 at: https://a6d30ef0.typertiangolo.pages.dev Modified Pages |
svlandeg
commented
Nov 17, 2025
| assert "[OPTIONS] ✨username✨" in result.output | ||
| assert "Usage: main [OPTIONS] [✨username✨]" in result.output | ||
| assert "Arguments" in result.output | ||
| assert "✨username✨" in result.output |
Member
Author
There was a problem hiding this comment.
Note that this second assert was always redundant, as L18 would already fail if this wasn't the case.
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.
As stated in the docs, currently when an argument has a default and is thus not required (e.g. tutorial003.py), the help string shows the argument name between brackets when printing the help string:
However, when we use
metavarto set a synonym for this argument, then suddenly it doesn't appear between brackets anymore, e.g. tutorial006.pyThis PR makes that consistent:
Follow-up work
I'd love feedback on this, because I'm looking into a few more cases where
metavarprocessing seems to be inconsistent, especially when combined with Rich formatting.I also have questions around adding the
type_varstuff at L394-403 incore.py, and whether that's actually used/documented anywhere in Typer. Those are probably follow-up discussions though, and this PR tries to single out a first fix before moving on.[Update]: now also created #1410, which I would review after this one.