Automatically process choices and add 'with_overwrite option

Author: collijk

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Automatically process choices with a `RUN_ALL` option into a list.
+- Add `with_overwrite` cli option.
 
 ## [1.0.12] - 2024-11-13
 ### Fixed

pyproject.toml

@@ -138,5 +138,6 @@ disallow_any_unimported = true
 module = [
     "deep_translator.*",
     "pathos.*",
+    "mkdocs_gen_files.*",
 ]
 ignore_missing_imports = true

scripts/gen_ref_pages.py

@@ -4,7 +4,7 @@
 
 import mkdocs_gen_files
 
-nav = mkdocs_gen_files.Nav()  # type: ignore[attr-defined, no-untyped-call]
+nav = mkdocs_gen_files.Nav()
 
 root = Path(__file__).parent.parent
 src = root / "src"

src/rra_tools/cli_tools/options.py

@@ -13,6 +13,26 @@
 RUN_ALL = "ALL"
 
 
+def convert_choice(value: str, choices: Sequence[str]) -> list[str]:
+    """Convert a choice to a list of choices, handling the special 'All' choice.
+
+    Parameters
+    ----------
+    value
+        The choice to convert.
+    choices
+        The set of choices to choose from.
+
+    Returns
+    -------
+    list[str]
+        The list of choices.
+    """
+    if value == RUN_ALL:
+        return list(choices)
+    return [value]
+
+
 def process_choices(
     allow_all: bool,  # noqa: FBT001
     choices: Sequence[str] | None,
@@ -62,7 +82,7 @@ def process_choices(
             choices.append(RUN_ALL)
             default = RUN_ALL
         else:
-            default = choices[-1]
+            default = None
         option_type = click.Choice(choices)
     show_default = default is not None
     return option_type, default, show_default
@@ -74,6 +94,7 @@ def with_choice(
     *,
     allow_all: bool = True,
     choices: Sequence[str] | None = None,
+    convert: bool = True,
     **kwargs: Any,
 ) -> ClickOption[_P, _T]:
     """Create an option with a set of choices.
@@ -88,8 +109,12 @@ def with_choice(
         Whether to allow the special value "ALL", which represents all choices.
     choices
         The set of choices to allow.
+    convert
+        Whether to convert the provided argument to a list, resolving the special
+        value "ALL" to all choices.
 
     """
+
     names = [f"--{name.replace('_', '-')}"]
     if short_name is not None:
         if len(short_name) != 1:
@@ -98,6 +123,23 @@ def with_choice(
         names.append(f"-{short_name}")
     option_type, default, show_default = process_choices(allow_all, choices)
 
+    if convert:
+        if not allow_all:
+            msg = "Conversion is only supported when allow_all is True."
+            raise ValueError(msg)
+        if choices is None:
+            msg = "Conversion is only supported when choices are provided."
+            raise ValueError(msg)
+
+        def convert_to_list_callback(
+            ctx: click.Context,  # noqa: ARG001
+            param: click.Parameter,  # noqa: ARG001
+            value: str,
+        ) -> list[str]:
+            return convert_choice(value, choices)
+
+        kwargs["callback"] = convert_to_list_callback
+
     return click.option(
         *names,
         type=option_type,
@@ -182,3 +224,11 @@ def with_dry_run() -> ClickOption[_P, _T]:
         is_flag=True,
         help="Don't actually run the workflow.",
     )
+
+
+def with_overwrite() -> ClickOption[_P, _T]:
+    return click.option(
+        "--overwrite",
+        is_flag=True,
+        help="Overwrite existing files.",
+    )