commit 9b8b13d619190f8e645da7b8e179a42ea0da2d67
author Trent Apted <tapted@chromium.org> Fri Aug 04 16:49:04 2023 +1000
committer Chromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com> Wed Aug 09 11:51:46 2023 +0000
tree 942efe94316aefb6072de0f8c98e78e5f041a1c5
parent 78af158492c53bce16698f257f4581a499211fb1

lib: Add a commandline.ArgumentParser.add_bool_argument(..) helper

This helps command line arguments be set up according to recommendations
in
https://chromium.googlesource.com/chromiumos/chromite/+/HEAD/docs/cli-guidelines.md#Boolean-Options

Follow-up to crrev.com/c/4617263/comment/7dbecead_4a32ec54/

BUG=None
TEST=Added test case

Change-Id: I33aa8707b1e8fdfa6492cfb4c0951876eddda568
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/chromite/+/4749873
Commit-Queue: Trent Apted <tapted@chromium.org>
Reviewed-by: Mike Frysinger <vapier@chromium.org>
Tested-by: Trent Apted <tapted@chromium.org>

scripts/build_sdk_subtools.py

diff --git a/scripts/build_sdk_subtools.py b/scripts/build_sdk_subtools.py
index e4dc311..ddfb655 100644
--- a/scripts/build_sdk_subtools.py
+++ b/scripts/build_sdk_subtools.py
@@ -85,37 +85,22 @@
     """Returns the cmdline argparser, populates the options and descriptions."""
     parser = commandline.ArgumentParser(description=__doc__)
 
-    def add_conforming_bool(flag: str, default: bool, desc: str, no_desc: str):
-        """Adds a boolean argument conforming to chromite recommendations.
-
-        See go/chromite-git/+/HEAD/docs/cli-guidelines.md#Boolean-Options.
-        """
-        desc += " (DEFAULT)" if default else ""
-        no_desc += " (DEFAULT)" if not default else ""
-        dest = flag.replace("-", "_")
-        parser.add_argument(
-            f"--{flag}", action="store_true", default=default, help=desc
-        )
-        parser.add_argument(
-            f"--no-{flag}", action="store_false", dest=dest, help=no_desc
-        )
-
-    add_conforming_bool(
-        "clean",
+    parser.add_bool_argument(
+        "--clean",
         False,
         "Remove the subtools chroot and re-extract the SDK.",
         "Re-use an existing subtools chroot.",
     )
 
-    add_conforming_bool(
-        "setup-chroot",
+    parser.add_bool_argument(
+        "--setup-chroot",
         True,
         "Look for a newer base SDK and set it up as a subtools SDK.",
         "Don't look for a newer base SDK and assume the chroot is setup.",
     )
 
-    add_conforming_bool(
-        "update-packages",
+    parser.add_bool_argument(
+        "--update-packages",
         True,
         "Update and install packages before looking for things to export.",
         "Only export packages already installed in the subtools SDK.",