Skip to content

Fix negative bool flag default=True with flag_value=False #3351

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
Polusss wants to merge 2 commits into from
Closed

Fix negative bool flag default=True with flag_value=False #3351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05319a0
Fix negative bool flag default=True with flag_value=False
Polusss Apr 18, 2026
902c276
Update prompt expectations for bool flag default=True and flag_value=…
Polusss Apr 18, 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
6 changes: 5 additions & 1 deletion src/click/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2897,7 +2897,11 @@ def get_default(
# (instead of eagerly in __init__) prevents callable flag_values
# (like classes) from being instantiated by the callable check below.
# https://github.com/pallets/click/issues/3121
if value is True and self.is_flag:
if (
value is True
and self.is_flag
and not (self.is_bool_flag and self.flag_value is False)
):
value = self.flag_value
elif call and callable(value):
value = value()
Expand Down
17 changes: 16 additions & 1 deletion tests/test_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1435,7 +1435,7 @@ def test_type_from_flag_value():
# Not passing --foo returns the default value as-is, in its Python type, then
# converted by the option type.
({"type": bool, "default": True, "flag_value": True}, [], True),
({"type": bool, "default": True, "flag_value": False}, [], False),
({"type": bool, "default": True, "flag_value": False}, [], True),
({"type": bool, "default": False, "flag_value": True}, [], False),
({"type": bool, "default": False, "flag_value": False}, [], False),
({"type": bool, "default": None, "flag_value": True}, [], None),
Expand Down Expand Up @@ -1480,6 +1480,21 @@ def cmd(foo):
assert result.output == repr(expected)


def test_negative_boolean_flag_value_preserves_true_default(runner):
@click.command()
@click.option(
"--without-xyz", "enable_xyz", is_flag=True, flag_value=False, default=True
)
def cmd(enable_xyz):
click.echo(repr(enable_xyz), nl=False)

result = runner.invoke(cmd, [])
assert result.output == "True"

result = runner.invoke(cmd, ["--without-xyz"])
assert result.output == "False"


@pytest.mark.parametrize(
("args", "opts"),
[
Expand Down
6 changes: 3 additions & 3 deletions tests/test_termui.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,9 +604,9 @@ def cmd(arg1):
({"prompt": True, "default": True, "flag_value": True}, [], "[Y/n]", "", True),
({"prompt": True, "default": True, "flag_value": True}, [], "[Y/n]", "y", True),
({"prompt": True, "default": True, "flag_value": True}, [], "[Y/n]", "n", False),
({"prompt": True, "default": True, "flag_value": False}, [], "[y/N]", "", False),
({"prompt": True, "default": True, "flag_value": False}, [], "[y/N]", "y", True),
({"prompt": True, "default": True, "flag_value": False}, [], "[y/N]", "n", False),
({"prompt": True, "default": True, "flag_value": False}, [], "[Y/n]", "", True),
({"prompt": True, "default": True, "flag_value": False}, [], "[Y/n]", "y", True),
({"prompt": True, "default": True, "flag_value": False}, [], "[Y/n]", "n", False),
# default=False
({"prompt": True, "default": False, "flag_value": True}, [], "[y/N]", "", False),
({"prompt": True, "default": False, "flag_value": True}, [], "[y/N]", "y", True),
Expand Down