🐛 Avoid printing default: None in the help section when using Rich#1120
Conversation
…s installed Fixes fastapi#465 Improves consitency with typer/core.py TyperArgument.get_help_record, which does not print the default value if it is None.
svlandeg
left a comment
svlandeg
left a comment
There was a problem hiding this comment.
Thanks for your PR @mattmess1221! I'll put this on my queue to review in detail and will get back to you 🙏
svlandeg
left a comment
svlandeg
left a comment
There was a problem hiding this comment.
Thanks for your work on this, @mattmess1221!
It's true that in Rich mode, the help text prints [default: None] which is unhelpful, because the argument is still required and the default effectively useless.
When printing the help without Rich, these None defaults are suppressed with the code in core.py as you referenced:
Lines 351 to 355 in 74e0923
It makes sense to ensure the same behaviour whether or not we're printing with Rich, and for clarity I agree to copy the structure from core.py into rich_utils.py. This also means adding the check for ctx.show_default which seems to have been missing previously.
I'll leave this to Tiangolo for a final review.
Thanks again!
svlandeg
changed the title
default: None in the help section when using Rich
3 participants
Related to #465
Improves consistency with
Typer(rich_markup_mode=None)(TyperArgument.get_help_record), which does not print the default value if it is None.