Reduce blast-radius of UNSET in default_map (#3240)

Author: Rowlando13

CHANGES.rst

@@ -13,6 +13,9 @@ Unreleased
     ``semver.Version``. :issue:`3298` :pr:`3299`
 -   Fix pager test pollution under parallel execution by using pytest's
     ``tmp_path`` fixture instead of a shared temporary file path. :pr:`3238`
+-   Treat ``Sentinel.UNSET`` values in a ``default_map`` as absent, so they fall
+    through to the next default source instead of being used as the value.
+    :issue:`3224` :pr:`3240`
 -   Patch ``pdb.Pdb`` in ``CliRunner`` isolation so ``pdb.set_trace()``,
     ``breakpoint()``, and debuggers subclassing ``pdb.Pdb`` (ipdb, pdbpp) can
     interact with the real terminal instead of the captured I/O streams.

src/click/core.py

@@ -698,6 +698,20 @@ def ensure_object(self, object_type: type[V]) -> V:
             self.obj = rv = object_type()
         return rv
 
+    def _default_map_has(self, name: str | None) -> bool:
+        """Check if :attr:`default_map` contains a real value for ``name``.
+
+        Returns ``False`` when the key is absent, the map is ``None``,
+        ``name`` is ``None``, or the stored value is the internal
+        :data:`UNSET` sentinel.
+        """
+        return (
+            name is not None
+            and self.default_map is not None
+            and name in self.default_map
+            and self.default_map[name] is not UNSET
+        )
+
     @t.overload
     def lookup_default(
         self, name: str, call: t.Literal[True] = True
@@ -718,15 +732,17 @@ def lookup_default(self, name: str, call: bool = True) -> t.Any | None:
         .. versionchanged:: 8.0
             Added the ``call`` parameter.
         """
-        if self.default_map is not None:
-            value = self.default_map.get(name)
+        if not self._default_map_has(name):
+            return None
 
-            if call and callable(value):
-                return value()
+        # Assert to make the type checker happy.
+        assert self.default_map is not None
+        value = self.default_map[name]
 
-            return value
+        if call and callable(value):
+            return value()
 
-        return None
+        return value
 
     def fail(self, message: str) -> t.NoReturn:
         """Aborts the execution of the program with a specific error
@@ -2294,9 +2310,7 @@ def get_default(
         name = self.name
         value = ctx.lookup_default(name, call=False) if name is not None else None
 
-        if value is None and not (
-            ctx.default_map is not None and name is not None and name in ctx.default_map
-        ):
+        if value is None and not ctx._default_map_has(name):
             value = self.default
 
         if call and callable(value):
@@ -2338,9 +2352,7 @@ def consume_value(
 
         if value is UNSET:
             default_map_value = ctx.lookup_default(self.name)  # type: ignore[arg-type]
-            if default_map_value is not None or (
-                ctx.default_map is not None and self.name in ctx.default_map
-            ):
+            if default_map_value is not None or ctx._default_map_has(self.name):
                 value = default_map_value
                 source = ParameterSource.DEFAULT_MAP
 

tests/test_defaults.py

@@ -2,6 +2,7 @@
 
 import click
 from click import UNPROCESSED
+from click._utils import UNSET
 
 
 @pytest.mark.parametrize(
@@ -354,3 +355,22 @@ def cli(value):
     result = runner.invoke(cli, args, **kwargs)
     assert result.exit_code == 0
     assert result.output == repr(expected)
+
+
+def test_unset_in_default_map(runner):
+    """An ``UNSET`` value in ``default_map`` should be treated as if
+    the key is absent, and so fallback to the parameter's own default.
+
+    Refs: https://github.com/pallets/click/pull/3224#issuecomment-3968643305
+    """
+
+    @click.command(
+        context_settings={"default_map": {"port": UNSET}},
+    )
+    @click.option("--port", default=8000)
+    def cli(port):
+        click.echo(f"port={port}")
+
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0
+    assert result.output.strip() == "port=8000"