Skip to content

Fix callable flag_value being instantiated when used as default #3213

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
worksbyfriday wants to merge 1 commit into from
Closed

Fix callable flag_value being instantiated when used as default #3213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 33 additions & 0 deletions src/click/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2820,8 +2820,10 @@ def __init__(
# and a flag_value set to something else. Refs:
# https://github.com/pallets/click/issues/3024#issuecomment-3146199461
# https://github.com/pallets/click/pull/3030/commits/06847da
self._default_from_flag_value = False
if self.default is True and self.flag_value is not UNSET:
self.default = self.flag_value
self._default_from_flag_value = True

# Set the default flag_value if it is not set.
if self.flag_value is UNSET:
Expand Down Expand Up @@ -2885,6 +2887,37 @@ def to_info_dict(self) -> dict[str, t.Any]:
)
return info_dict

@t.overload
def get_default(
self, ctx: Context, call: t.Literal[True] = True
) -> t.Any | None: ...

@t.overload
def get_default(
self, ctx: Context, call: bool = ...
) -> t.Any | t.Callable[[], t.Any] | None: ...

def get_default(
self, ctx: Context, call: bool = True
) -> t.Any | t.Callable[[], t.Any] | None:
value = ctx.lookup_default(self.name, call=False) # type: ignore

if value is UNSET:
value = self.default

# Don't call the default if it was set from the flag_value via
# the ``default=True`` alignment. A callable flag_value (e.g. a
# class used as a flag value) should be returned as-is, not
# instantiated. See https://github.com/pallets/click/issues/3121
if (
call
and callable(value)
and not self._default_from_flag_value
):
value = value()

return value

def get_error_hint(self, ctx: Context) -> str:
result = super().get_error_hint(ctx)
if self.show_envvar and self.envvar is not None:
Expand Down
4 changes: 2 additions & 2 deletions tests/test_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2148,7 +2148,7 @@ def scan(pro):
{"flag_value": Class1, "default": True},
{"flag_value": Class2},
[],
re.compile(r"'<test_options.Class1 object at 0x[0-9A-Fa-f]+>'"),
"<class 'test_options.Class1'>",
),
(
{"flag_value": Class1, "default": True},
Expand All @@ -2170,7 +2170,7 @@ def scan(pro):
{"flag_value": Class1, "type": UNPROCESSED, "default": True},
{"flag_value": Class2, "type": UNPROCESSED},
[],
re.compile(r"<test_options.Class1 object at 0x[0-9A-Fa-f]+>"),
Class1,
),
(
{"flag_value": Class1, "type": UNPROCESSED, "default": True},
Expand Down