Skip to content

fix: Improve metavar display consistency in Rich help output #1607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
by22Jy wants to merge 2 commits into from
Closed

fix: Improve metavar display consistency in Rich help output #1607

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f6ac9f
fix: Improve metavar display consistency in Rich help output
Feb 24, 2026
fd8d5bc
🎨 Auto format
pre-commit-ci-lite[bot] Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 45 additions & 12 deletions typer/rich_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,31 +361,64 @@ def _print_options_panel(
opt_short_strs = []
secondary_opt_long_strs = []
secondary_opt_short_strs = []

# Determine if this parameter has a custom metavar
metavar_str = param.make_metavar(ctx=ctx)

# For Arguments, check if metavar is a custom value or just the default
# Default metavar is either PARAM_NAME or [PARAM_NAME] for optional args
is_default_metavar = False
if isinstance(param, click.Argument) and param.name:
expected_upper = param.name.upper()
# Check if metavar is the default (with or without brackets)
if metavar_str == expected_upper or metavar_str == f"[{expected_upper}]":
is_default_metavar = True

has_custom_metavar = (
isinstance(param, click.Argument) and not is_default_metavar
)

# Process opts
for opt_str in param.opts:
if "--" in opt_str:
opt_long_strs.append(opt_str)
elif has_custom_metavar:
# Arguments with custom metavar: use metavar as name
opt_short_strs.append(metavar_str)
else:
opt_short_strs.append(opt_str)

for opt_str in param.secondary_opts:
if "--" in opt_str:
secondary_opt_long_strs.append(opt_str)
else:
secondary_opt_short_strs.append(opt_str)

# Column for a metavar, if we have one
# Column for displaying type or metavar
metavar = Text(style=STYLE_METAVAR, overflow="fold")
metavar_str = param.make_metavar(ctx=ctx)
# Do it ourselves if this is a positional argument
if (
isinstance(param, click.Argument)
and param.name
and metavar_str == param.name.upper()
):
metavar_str = param.type.name.upper()

# Skip booleans and choices (handled above)
if metavar_str != "BOOLEAN":
metavar.append(metavar_str)
# For Arguments with custom metavar: show type in metavar column
# For other parameters: use original logic
if isinstance(param, click.Argument) and has_custom_metavar:
# Arguments with custom metavar: show the type, not metavar
type_str = param.type.name.upper()
if type_str != "BOOLEAN":
metavar.append(type_str)
else:
# Original logic for Options and Arguments without custom metavar
# For Arguments without custom metavar, metavar_str might be the uppercase name
if (
isinstance(param, click.Argument)
and param.name
and (
metavar_str == param.name.upper()
or metavar_str == f"[{param.name.upper()}]"
)
):
metavar_str = param.type.name.upper()

if metavar_str != "BOOLEAN":
metavar.append(metavar_str)

# Range - from
# https://github.com/pallets/click/blob/c63c70dabd3f86ca68678b4f00951f78f52d0270/src/click/core.py#L2698-L2706 # noqa: E501
Expand Down
Loading