🐛 Ensure that options_metavar is passed through correctly#816
🐛 Ensure that options_metavar is passed through correctly#816tiangolo merged 8 commits intofastapi:masterfrom
options_metavar is passed through correctly#816Conversation
Typer was ignoring this setting when provided to commands. Refer to added test for details.
svlandeg
left a comment
svlandeg
left a comment
There was a problem hiding this comment.
Thanks!
I have yet to check the test case, but a few quick first comments:
svlandeg
left a comment
svlandeg
left a comment
There was a problem hiding this comment.
I double checked the unit test and found that the second option (c2) is already working correctly on master, while the first one (c1) fails. Nevertheless, it's good to have both options checked here.
One thing I wonder about though. If you change "OPTIONS" to "OPTS" or something different entirely like "STUFF", the box with options in the help menu would still be named "Options".
$ python script.py --help
Usage: script.py [STUFF]
┌─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help Show this message and exit. │
└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
Is this something that should be addressed as well?
I think that's a good idea! But the goal of this PR is to fix a bug that currently prevents I would classify your point here as an enhancement to the API to support configuration of the panel label/title. This could be captured as a new feature request, while merging this PR. |
svlandeg
changed the title
options_metavar is passed through correctly
Agreed that we can address this as future work! |
tiangolo
left a comment
tiangolo
left a comment
There was a problem hiding this comment.
Thank you! 🚀
This will be available in Typer 0.20.1, released in the next few hours. 🎉
3 participants
Typer was ignoring this setting when provided to commands. Refer to added test for details.