feat: add --ask flag to force prompting of selected questions (copier-org#2705)

Author: bentheiii

copier/_cli.py

@@ -239,6 +239,15 @@ class CopierCopySubApp(_Subcommand):
         ["-w", "--overwrite"],
         help="Overwrite files that already exist, without asking.",
     )
+    ask = cli.SwitchAttr(
+        ["--ask"],
+        str,
+        list=True,
+        help=(
+            "Ask the questions matching the given glob-pattern, even if they would be "
+            "skipped by other options"
+        ),
+    )
 
     def main(self, template_src: str, destination_path: str) -> int:
         """Call [run_copy][copier.run_copy].
@@ -270,6 +279,7 @@ def inner() -> None:
                 quiet=self.quiet,
                 unsafe=self.unsafe,
                 skip_tasks=self.skip_tasks,
+                ask=self.ask,
             )
 
         return _handle_exceptions(inner)
@@ -318,6 +328,15 @@ class CopierRecopySubApp(_Subcommand):
         default=False,
         help="Skip questions that have already been answered",
     )
+    ask = cli.SwitchAttr(
+        ["--ask"],
+        str,
+        list=True,
+        help=(
+            "Ask the questions matching the given fnamtch-pattern, even if they would be "
+            "skipped by other options"
+        ),
+    )
 
     def main(self, destination_path: str = ".") -> int:
         """Call [run_recopy][copier.run_recopy].
@@ -347,6 +366,7 @@ def inner() -> None:
                 unsafe=self.unsafe,
                 skip_answered=self.skip_answered,
                 skip_tasks=self.skip_tasks,
+                ask=self.ask,
             )
 
         return _handle_exceptions(inner)
@@ -401,6 +421,15 @@ class CopierUpdateSubApp(_Subcommand):
         default=False,
         help="Skip questions that have already been answered",
     )
+    ask = cli.SwitchAttr(
+        ["--ask"],
+        str,
+        list=True,
+        help=(
+            "Ask the questions matching the given glob-pattern, even if they would be "
+            "skipped by other options"
+        ),
+    )
 
     def main(self, destination_path: str = ".") -> int:
         """Call [run_update][copier.run_update].
@@ -432,6 +461,7 @@ def inner() -> None:
                 unsafe=self.unsafe,
                 skip_answered=self.skip_answered,
                 skip_tasks=self.skip_tasks,
+                ask=self.ask,
             )
 
         return _handle_exceptions(inner)

copier/_main.py

@@ -13,6 +13,7 @@
 from contextvars import ContextVar
 from dataclasses import field, replace
 from filecmp import dircmp
+from fnmatch import fnmatchcase
 from functools import cached_property, partial, wraps
 from itertools import chain
 from pathlib import Path, PurePath, PurePosixPath, PureWindowsPath
@@ -228,6 +229,10 @@ class Worker:
 
         skip_tasks:
             When `True`, skip template tasks execution.
+
+        ask:
+            List of question names to ask, even if they would be skipped by other
+            options. Supports glob-style patterns.
     """
 
     # NOTE: attributes are fully documented in [creating.md](../docs/creating.md)
@@ -253,6 +258,7 @@ class Worker:
     unsafe: bool = False
     skip_answered: bool = False
     skip_tasks: bool = False
+    ask: Sequence[str] = ()
 
     answers: AnswersMap = field(default_factory=AnswersMap, init=False)
     _cleanup_hooks: list[Callable[[], None]] = field(default_factory=list, init=False)
@@ -622,35 +628,36 @@ def _ask(self) -> None:  # noqa: C901
                 # value.
                 if question.get_default() is MISSING:
                     continue
-            if var_name in self.answers.init:
-                # Try to parse and validate (if the question has a validator)
-                # the answer value.
-                answer = question.parse_answer(self.answers.init[var_name])
-                question.validate_answer(answer)
-                # At this point, the answer value is valid. Do not ask the
-                # question again, but set answer as the user's answer instead.
-                self.answers.user[var_name] = answer
-                continue
-            # Skip a question when the user already answered it.
-            if self.skip_answered and var_name in self.answers.last:
-                continue
 
-            # Display TUI and ask user interactively only without --defaults
-            try:
+            if not any(fnmatchcase(var_name, ask_pattern) for ask_pattern in self.ask):
+                # If the user didn't explicitly request the question be asked,
+                # it may now be skipped by `--data`, `--skip-answered`, or `--defaults`.
+                if var_name in self.answers.init:
+                    # Try to parse and validate (if the question has a validator)
+                    # the answer value.
+                    answer = question.parse_answer(self.answers.init[var_name])
+                    question.validate_answer(answer)
+                    self.answers.user[var_name] = answer
+                    continue
+                if self.skip_answered and var_name in self.answers.last:
+                    continue
                 if self.defaults:
-                    new_answer = question.get_default()
-                    if new_answer is MISSING:
+                    answer = question.get_default()
+                    if answer is MISSING:
                         raise ValueError(f'Question "{var_name}" is required')
-                else:
-                    try:
-                        new_answer = unsafe_prompt(
-                            [question.get_questionary_structure()],
-                            answers={question.var_name: question.get_default()},
-                        )[question.var_name]
-                    except EOFError as err:
-                        raise InteractiveSessionError(
-                            "Use `--defaults` and/or `--data`/`--data-file`"
-                        ) from err
+                    self.answers.user[var_name] = answer
+                    continue
+
+            # Display TUI and ask user interactively only without --defaults
+            try:
+                new_answer = unsafe_prompt(
+                    [question.get_questionary_structure()],
+                    answers={question.var_name: question.get_default()},
+                )[question.var_name]
+            except EOFError as err:
+                raise InteractiveSessionError(
+                    "Use `--defaults` and/or `--data`/`--data-file`"
+                ) from err
             except KeyboardInterrupt as err:
                 raise CopierAnswersInterrupt(
                     self.answers, question, self.template
@@ -1385,6 +1392,7 @@ def _apply_update(self) -> None:  # noqa: C901
                 # won't be included in the diff as deleted paths to prevent deletion.
                 # https://github.com/orgs/copier-org/discussions/2345
                 exclude=[*self.template.exclude, *self.exclude],
+                ask=(),
             ) as old_worker:
                 old_worker.run_copy()
             # Run pre-migration tasks
@@ -1457,6 +1465,7 @@ def _apply_update(self) -> None:  # noqa: C901
                 src_path=self.subproject.template.url,  # type: ignore[union-attr]
                 exclude=exclude_plus_removed,
                 vcs_ref=self.resolved_vcs_ref,
+                ask=(),
             ) as new_worker:
                 new_worker.run_copy()
             with local.cwd(new_copy):
@@ -1708,6 +1717,7 @@ def run_copy(
     quiet: bool = False,
     unsafe: bool = False,
     skip_tasks: bool = False,
+    ask: Sequence[str] = (),
 ) -> Worker:
     """Copy a template to a destination, from zero."""
     with Worker(
@@ -1736,6 +1746,7 @@ def run_copy(
         quiet=quiet,
         unsafe=unsafe,
         skip_tasks=skip_tasks,
+        ask=ask,
     ) as worker:
         worker.run_copy()
     return worker
@@ -1760,6 +1771,7 @@ def run_recopy(
     unsafe: bool = False,
     skip_answered: bool = False,
     skip_tasks: bool = False,
+    ask: Sequence[str] = (),
 ) -> Worker:
     """Update a subproject from its template, discarding subproject evolution."""
     with Worker(
@@ -1788,6 +1800,7 @@ def run_recopy(
         unsafe=unsafe,
         skip_answered=skip_answered,
         skip_tasks=skip_tasks,
+        ask=ask,
     ) as worker:
         worker.run_recopy()
     return worker
@@ -1814,6 +1827,7 @@ def run_update(
     unsafe: bool = False,
     skip_answered: bool = False,
     skip_tasks: bool = False,
+    ask: Sequence[str] = (),
 ) -> Worker:
     """Update a subproject, from its template."""
     with Worker(
@@ -1844,6 +1858,7 @@ def run_update(
         unsafe=unsafe,
         skip_answered=skip_answered,
         skip_tasks=skip_tasks,
+        ask=ask,
     ) as worker:
         worker.run_update()
     return worker

docs/configuring.md

@@ -808,6 +808,19 @@ Don't forget to read [the docs about the answers file](#the-copier-answersyml-fi
     _answers_file: .my-custom-answers.yml
     ```
 
+### `ask`
+
+- Format: `List[str]`
+- CLI flags: `--ask`
+
+Ask the matched questions, even if they would be skipped by other options such as
+[defaults](#defaults), [skip-answered](#skip_answered), or [data](#data). Names may be
+glob-style patterns.
+
+!!! info
+
+    Not supported in `copier.yml`.
+
 ### `cleanup_on_error`
 
 - Format: `bool`

tests/test_cli.py

@@ -408,6 +408,9 @@ def test_copy_help(capsys: pytest.CaptureFixture[str]) -> None:
                                     extensions, migrations, tasks)
     -a, --answers-file VALUE:str    Update using this path (relative to
                                     `destination_path`) to find the answers file
+    --ask VALUE:str                 Ask the questions matching the given glob-
+                                    pattern, even if they would be skipped by
+                                    other options; may be given multiple times
     -d, --data VARIABLE=VALUE:str   Make VARIABLE available as VALUE when
                                     rendering the template; may be given
                                     multiple times
@@ -475,6 +478,9 @@ def test_update_help(capsys: pytest.CaptureFixture[str]) -> None:
                                     extensions, migrations, tasks)
     -a, --answers-file VALUE:str    Update using this path (relative to
                                     `destination_path`) to find the answers file
+    --ask VALUE:str                 Ask the questions matching the given glob-
+                                    pattern, even if they would be skipped by
+                                    other options; may be given multiple times
     -c, --context-lines VALUE:int   Lines of context to use for detecting
                                     conflicts. Increase for accuracy, decrease
                                     for resilience.; the default is 3