Implement magic opt_output_auto

Author: NickCao

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/create.py

@@ -12,7 +12,7 @@
     opt_log_level,
     opt_namespace,
     opt_nointeractive,
-    opt_output_all,
+    opt_output_auto,
 )
 from jumpstarter_kubernetes import ClientsV1Alpha1Api, ExportersV1Alpha1Api, V1Alpha1Client, V1Alpha1Exporter
 from kubernetes_asyncio.client.exceptions import ApiException
@@ -71,7 +71,7 @@ def print_created_client(client: V1Alpha1Client, output: OutputType):
 @opt_context
 @opt_oidc_username
 @opt_nointeractive
-@opt_output_all
+@opt_output_auto(V1Alpha1Client)
 async def create_client(
     name: Optional[str],
     kubeconfig: Optional[str],
@@ -148,7 +148,7 @@ def print_created_exporter(exporter: V1Alpha1Exporter, output: OutputType):
 @opt_context
 @opt_oidc_username
 @opt_nointeractive
-@opt_output_all
+@opt_output_auto(V1Alpha1Exporter)
 async def create_exporter(
     name: Optional[str],
     kubeconfig: Optional[str],

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/get.py

@@ -9,12 +9,15 @@
     opt_kubeconfig,
     opt_log_level,
     opt_namespace,
-    opt_output_all,
+    opt_output_auto,
 )
 from jumpstarter_kubernetes import (
     ClientsV1Alpha1Api,
     ExportersV1Alpha1Api,
     LeasesV1Alpha1Api,
+    V1Alpha1Client,
+    V1Alpha1Exporter,
+    V1Alpha1Lease,
 )
 from kubernetes_asyncio.client.exceptions import ApiException
 from kubernetes_asyncio.config.config_exception import ConfigException
@@ -41,7 +44,7 @@ def get(log_level: Optional[str]):
 @opt_namespace
 @opt_kubeconfig
 @opt_context
-@opt_output_all
+@opt_output_auto(V1Alpha1Client)
 async def get_client(
     name: Optional[str], kubeconfig: Optional[str], context: Optional[str], namespace: str, output: OutputType
 ):
@@ -65,7 +68,7 @@ async def get_client(
 @opt_namespace
 @opt_kubeconfig
 @opt_context
-@opt_output_all
+@opt_output_auto(V1Alpha1Exporter)
 @click.option("-d", "--devices", is_flag=True, help="Display the devices hosted by the exporter(s)")
 async def get_exporter(
     name: Optional[str],
@@ -95,7 +98,7 @@ async def get_exporter(
 @opt_namespace
 @opt_kubeconfig
 @opt_context
-@opt_output_all
+@opt_output_auto(V1Alpha1Lease)
 async def get_lease(
     name: Optional[str], kubeconfig: Optional[str], context: Optional[str], namespace: str, output: OutputType
 ):

packages/jumpstarter-cli-common/jumpstarter_cli_common/__init__.py

@@ -13,6 +13,7 @@
     opt_namespace,
     opt_nointeractive,
     opt_output_all,
+    opt_output_auto,
     opt_output_name_only,
     opt_output_path_only,
 )
@@ -34,6 +35,7 @@
     "opt_output_all",
     "opt_output_name_only",
     "opt_output_path_only",
+    "opt_output_auto",
     "OutputMode",
     "OutputType",
     "NameOutputType",

packages/jumpstarter-cli-common/jumpstarter_cli_common/opt.py

@@ -55,3 +55,30 @@
 opt_nointeractive = click.option(
     "--nointeractive", is_flag=True, default=False, help="Disable interactive prompts (for use in scripts)."
 )
+
+
+def opt_output_auto(cls):
+    choices = []
+    if hasattr(cls, "dump_json"):
+        choices.append(OutputMode.JSON)
+    if hasattr(cls, "dump_yaml"):
+        choices.append(OutputMode.YAML)
+    if hasattr(cls, "dump_name"):
+        choices.append(OutputMode.NAME)
+    if hasattr(cls, "dump_path"):
+        choices.append(OutputMode.PATH)
+
+    if OutputMode.PATH in choices:
+        help = 'Output mode. Use "-o path" for shorter output (file/path).'
+    elif OutputMode.NAME in choices:
+        help = 'Output mode. Use "-o name" for shorter output (resource/name).'
+    else:
+        help = "Output mode."
+
+    return click.option(
+        "-o",
+        "--output",
+        type=click.Choice(choices),
+        default=None,
+        help=help,
+    )