DRY some help text

navapbc · Jan 3, 2025 · afc5826 · afc5826
1 parent 34dce16
commit afc5826
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 58 deletions.
diff --git a/nava/platform/cli/commands/app.py b/nava/platform/cli/commands/app.py
@@ -5,7 +5,13 @@
 import typer
 
 import nava.platform.util.collections.dict as dict_util
-from nava.platform.cli.commands.infra import opt_data
+from nava.platform.cli.commands.common import (
+    opt_answers_only,
+    opt_commit,
+    opt_data,
+    opt_template_uri,
+    opt_version,
+)
 from nava.platform.cli.context import CliContext
 from nava.platform.projects.migrate_from_legacy_template import MigrateFromLegacyTemplate
 from nava.platform.projects.project import Project
@@ -24,12 +30,10 @@ def install(
         ),
     ],
     app_name: Annotated[str, typer.Argument(help="What to call the new application")],
-    template_uri: Annotated[str, typer.Option()],
-    version: Annotated[str | None, typer.Option()] = None,
+    template_uri: Annotated[str, opt_template_uri],
+    version: Annotated[str | None, opt_version] = None,
     data: Annotated[list[str] | None, opt_data] = None,
-    commit: Annotated[
-        bool, typer.Option(help="Commit changes with standard message if able")
-    ] = False,
+    commit: Annotated[bool, opt_commit] = False,
     template_name: Annotated[
         str | None,
         typer.Option(
@@ -65,19 +69,17 @@ def update(
     app_name: Annotated[
         str, typer.Argument(help="Name of the application based on given template to update")
     ],
-    template_uri: Annotated[str | None, typer.Option()] = None,
-    version: Annotated[str | None, typer.Option()] = None,
+    template_uri: Annotated[str | None, opt_template_uri] = None,
+    version: Annotated[str | None, opt_version] = None,
     data: Annotated[list[str] | None, opt_data] = None,
-    commit: Annotated[
-        bool, typer.Option(help="Commit changes with standard message if able")
-    ] = True,
+    commit: Annotated[bool, opt_commit] = True,
     template_name: Annotated[
         str | None,
         typer.Option(
             help="The name of the template. Usually this can be derived from the repository name automatically, but if you are running from a local checkout under a different name, you will need to specify the upstream name here."
         ),
     ] = None,
-    answers_only: Annotated[bool, typer.Option(help="Do not change the version")] = False,
+    answers_only: Annotated[bool, opt_answers_only] = False,
 ) -> None:
     """Update application based on template in project."""
     ctx = typer_context.ensure_object(CliContext)
@@ -139,9 +141,7 @@ def migrate_from_legacy(
     app_name: Annotated[
         str, typer.Argument(help="Name of the application based on given template to migrate")
     ],
-    commit: Annotated[
-        bool, typer.Option(help="Commit changes with standard message if able")
-    ] = True,
+    commit: Annotated[bool, opt_commit] = True,
 ) -> None:
     """Migrate an older version of a template to platform-cli setup."""
     ctx = typer_context.ensure_object(CliContext)

diff --git a/nava/platform/cli/commands/common.py b/nava/platform/cli/commands/common.py
@@ -0,0 +1,23 @@
+import typer
+
+opt_template_uri = typer.Option(
+    help="Path or URL to template source. Can be a path to a local clone of the template repo.",
+)
+
+opt_version = typer.Option(
+    help="Template version to install. Can be a branch, tag, or commit hash. Defaults to the latest tag version.",
+)
+
+# Unfortunately typer doesn't handle args annotated as dictionaries[1], even
+# when the dictionary parsing is happening via a `callback`. So we annotate
+# `data` as a list of strings, and do the parsing we'd normally do in `callback`
+# in the body of the command.
+#
+# https://github.com/fastapi/typer/issues/130
+opt_data = typer.Option(
+    help="Parameters in form VARIABLE=VALUE, will make VARIABLE available as VALUE when rendering the template.",
+)
+
+opt_commit = typer.Option(help="Commit changes with standard message if able.")
+
+opt_answers_only = typer.Option(help="Do not change the version.")
diff --git a/nava/platform/cli/commands/infra/__init__.py b/nava/platform/cli/commands/infra/__init__.py
@@ -4,6 +4,7 @@
 import typer
 
 import nava.platform.util.collections.dict as dict_util
+from nava.platform.cli.commands.common import opt_answers_only, opt_commit, opt_data, opt_version
 from nava.platform.cli.context import CliContext
 from nava.platform.templates.errors import MergeConflictsDuringUpdateError
 
@@ -36,32 +37,15 @@
 # TODO: Set the default back to None once the rollout plan is complete
 DEFAULT_VERSION = "lorenyu/platform-cli"
 
-opt_version = typer.Option(
-    help="Template version to install. Can be a branch, tag, or commit hash. Defaults to the latest tag version.",
-)
-
-
-# Unfortunately typer doesn't handle args annotated as dictionaries[1], even
-# when the dictionary parsing is happening via a `callback`. So we annotate
-# `data` as a list of strings, and do the parsing we'd normally do in `callback`
-# in the body of the command.
-#
-# https://github.com/fastapi/typer/issues/130
-opt_data = typer.Option(
-    help="Parameters in form VARIABLE=VALUE, will make VARIABLE available as VALUE when rendering the template.",
-)
-
 
 @app.command()
 def install(
     typer_context: typer.Context,
     project_dir: str,
     template_uri: Annotated[str, opt_template_uri] = DEFAULT_TEMPLATE_URI,
-    version: Annotated[str, opt_version] = DEFAULT_VERSION,
+    version: Annotated[str | None, opt_version] = DEFAULT_VERSION,
     data: Annotated[list[str] | None, opt_data] = None,
-    commit: Annotated[
-        bool, typer.Option(help="Commit changes with standard message if able.")
-    ] = False,
+    commit: Annotated[bool, opt_commit] = False,
 ) -> None:
     """Install template-infra in project."""
     ctx = typer_context.ensure_object(CliContext)
@@ -84,9 +68,7 @@ def add_app(
     app_name: str,
     template_uri: Annotated[str, opt_template_uri] = DEFAULT_TEMPLATE_URI,
     data: Annotated[list[str] | None, opt_data] = None,
-    commit: Annotated[
-        bool, typer.Option(help="Commit changes with standard message if able.")
-    ] = True,
+    commit: Annotated[bool, opt_commit] = True,
 ) -> None:
     """Add infra for APP_NAME."""
     ctx = typer_context.ensure_object(CliContext)
@@ -107,9 +89,9 @@ def update(
     typer_context: typer.Context,
     project_dir: str,
     template_uri: Annotated[str, opt_template_uri] = DEFAULT_TEMPLATE_URI,
-    version: Annotated[str, opt_version] = DEFAULT_VERSION,
+    version: Annotated[str | None, opt_version] = DEFAULT_VERSION,
     data: Annotated[list[str] | None, opt_data] = None,
-    answers_only: Annotated[bool, typer.Option(help="Do not change the version")] = False,
+    answers_only: Annotated[bool, opt_answers_only] = False,
 ) -> None:
     """Update base and application infrastructure."""
     ctx = typer_context.ensure_object(CliContext)
@@ -137,12 +119,10 @@ def update_base(
     typer_context: typer.Context,
     project_dir: str,
     template_uri: Annotated[str, opt_template_uri] = DEFAULT_TEMPLATE_URI,
-    version: Annotated[str, opt_version] = DEFAULT_VERSION,
+    version: Annotated[str | None, opt_version] = DEFAULT_VERSION,
     data: Annotated[list[str] | None, opt_data] = None,
-    commit: Annotated[
-        bool, typer.Option(help="Commit changes with standard message if able.")
-    ] = True,
-    answers_only: Annotated[bool, typer.Option(help="Do not change the version")] = False,
+    commit: Annotated[bool, opt_commit] = True,
+    answers_only: Annotated[bool, opt_answers_only] = False,
 ) -> None:
     """Update base infrastructure."""
     ctx = typer_context.ensure_object(CliContext)
@@ -165,13 +145,11 @@ def update_app(
     project_dir: str,
     app_name: Annotated[list[str] | None, typer.Argument()] = None,
     template_uri: Annotated[str, opt_template_uri] = DEFAULT_TEMPLATE_URI,
-    version: Annotated[str, opt_version] = DEFAULT_VERSION,
+    version: Annotated[str | None, opt_version] = DEFAULT_VERSION,
     data: Annotated[list[str] | None, opt_data] = None,
-    commit: Annotated[
-        bool, typer.Option(help="Commit changes with standard message if able.")
-    ] = True,
+    commit: Annotated[bool, opt_commit] = True,
     all: Annotated[bool, typer.Option("--all", help="Attempt to update all known apps")] = False,
-    answers_only: Annotated[bool, typer.Option(help="Do not change the version")] = False,
+    answers_only: Annotated[bool, opt_answers_only] = False,
 ) -> None:
     """Update application(s) infrastructure."""
     ctx = typer_context.ensure_object(CliContext)
@@ -200,9 +178,7 @@ def migrate_from_legacy(
             help="Path or URL to the legacy infra template that was used to set up the project. Can be a path to a local clone of template-infra. Defaults to the template-infra repository on GitHub.",
         ),
     ] = "https://github.com/navapbc/template-infra",
-    commit: Annotated[
-        bool, typer.Option(help="Commit changes with standard message if able.")
-    ] = False,
+    commit: Annotated[bool, opt_commit] = False,
 ) -> None:
     """Migrate an older version of the template to platform-cli setup."""
     ctx = typer_context.ensure_object(CliContext)
@@ -223,12 +199,7 @@ def info(
             file_okay=False,
         ),
     ],
-    template_uri: Annotated[
-        str | None,
-        typer.Option(
-            help="Path or URL to infra template. Can be a path to a local clone of template-infra. Defaults to the template-infra repository on GitHub."
-        ),
-    ] = None,
+    template_uri: Annotated[str | None, opt_template_uri] = None,
 ) -> None:
     """Display some information about the state of template-infra in the project."""
     ctx = typer_context.ensure_object(CliContext)