Add --quiet option to silence spinners

Author: gps035

proxygen_cli/cli/command_instance.py

@@ -1,3 +1,5 @@
+import os
+import sys
 from typing import get_args
 from urllib import parse
 
@@ -55,8 +57,14 @@ def list(ctx, env):
     show_default=True,
     help="Do not prompt for confirmation.",
 )
+@click.option(
+    "--quiet",
+    is_flag=True,
+    show_default=True,
+    help="Suppress spinner output.",
+)
 @click.pass_context
-def deploy(ctx, env, base_path, spec_file, no_confirm):
+def deploy(ctx, env, base_path, spec_file, no_confirm, quiet):
     """
     Deploy <SPEC_FILE> to <ENV> under <BASE_PATH>
 
@@ -86,7 +94,7 @@ def deploy(ctx, env, base_path, spec_file, no_confirm):
         if not click.confirm(f"Deploy this spec to {_url}?"):  # pragma: no cover
             raise click.Abort()
 
-    with yaspin() as sp:
+    with yaspin(stream=open(os.devnull, 'w') if quiet else sys.stdout) as sp:
         sp.text = f"Deploying {_url}"
         instance = parse.quote(base_path)
 
@@ -127,8 +135,14 @@ def get(ctx, env, base_path):
     show_default=True,
     help="Do not prompt for confirmation.",
 )
+@click.option(
+    "--quiet",
+    is_flag=True,
+    show_default=True,
+    help="Suppress spinner output.",
+)
 @click.pass_context
-def delete(ctx, env, base_path, no_confirm):
+def delete(ctx, env, base_path, no_confirm, quiet):
     """
     Delete the instance deployed on <BASE_PATH> in environment <ENV>.
     """
@@ -144,7 +158,7 @@ def delete(ctx, env, base_path, no_confirm):
         if not click.confirm(f"Delete the instance at {_url}?"):
             raise click.Abort()
 
-    with yaspin() as sp:
+    with yaspin(stream=open(os.devnull, 'w') if quiet else sys.stdout) as sp:
         sp.text = f"Deleting {_url}"
 
         try:

proxygen_cli/cli/command_secret.py

@@ -1,3 +1,5 @@
+import os
+import sys
 from typing import get_args
 
 import click
@@ -119,8 +121,14 @@ def _read_or_fail(secret_file: str, type_label: str) -> str:
 @click.option(
     "--mtls-key", help="Provide a path to a PEM encoded private key for mutual TLS"
 )
+@click.option(
+    "--quiet",
+    is_flag=True,
+    show_default=True,
+    help="Suppress spinner output.",
+)
 @click.pass_context
-def put(ctx, env, secret_name, secret_value, secret_file, apikey, mtls_cert, mtls_key):
+def put(ctx, env, secret_name, secret_value, secret_file, apikey, mtls_cert, mtls_key, quiet):
     """
     Create or overwrite a secret.
 
@@ -133,7 +141,7 @@ def put(ctx, env, secret_name, secret_value, secret_file, apikey, mtls_cert, mtl
         secret_value, secret_file, apikey, mtls_cert, mtls_key
     )
 
-    with yaspin() as spinner:
+    with yaspin(stream=open(os.devnull, 'w') if quiet else sys.stdout) as spinner:
         spinner.text = f"Putting secret {secret_name} in {env}"
 
         try:
@@ -183,8 +191,14 @@ def describe(ctx, env, secret_type, secret_name):
     show_default=True,
     help="Do not prompt for confirmation.",
 )
+@click.option(
+    "--quiet",
+    is_flag=True,
+    show_default=True,
+    help="Suppress spinner output.",
+)
 @click.pass_context
-def delete(ctx, env, secret_type, secret_name, no_confirm):
+def delete(ctx, env, secret_type, secret_name, no_confirm, quiet):
     """
     Delete a secret.
     """
@@ -199,7 +213,7 @@ def delete(ctx, env, secret_type, secret_name, no_confirm):
         output.print_json(result)
         if not click.confirm(f"Delete secret {secret_name} from {env}?"):
             raise click.Abort()
-    with yaspin() as sp:
+    with yaspin(stream=open(os.devnull, 'w') if quiet else sys.stdout) as sp:
         sp.text = f"Deleting secret {secret_name} from {env}"
         try:
             result = proxygen_api.delete_secret(api, env, secret_type, secret_name)

proxygen_cli/cli/command_spec.py

@@ -1,3 +1,5 @@
+import os
+import sys
 from typing import get_args
 
 import click
@@ -13,6 +15,7 @@
 
 HELP_NO_CONFIRM = "Do not prompt for confirmation."
 HELP_UAT = "Target the UAT instance of API catalogue."
+HELP_QUIET = "Suppress spinner output."
 
 UAT_KWARGS = {
     'default': False,
@@ -26,6 +29,12 @@
     'help': HELP_NO_CONFIRM,
 }
 
+QUIET_KWARGS = {
+    'is_flag': True,
+    'show_default': True,
+    'help': HELP_QUIET,
+}
+
 
 @click.group()
 @click.option(
@@ -56,8 +65,12 @@ def spec(ctx, api, uat):
     "--uat",
     **UAT_KWARGS
 )
+@click.option(
+    "--quiet",
+    **QUIET_KWARGS
+)
 @click.pass_context
-def publish(ctx, spec_file, no_confirm, uat):
+def publish(ctx, spec_file, no_confirm, uat, quiet):
     """
     Publish <SPEC_FILE>.
     """
@@ -70,7 +83,7 @@ def publish(ctx, spec_file, no_confirm, uat):
         if not click.confirm(f"Publish this spec for {api}?"):
             raise click.Abort()
 
-    with yaspin() as sp:
+    with yaspin(stream=open(os.devnull, 'w') if quiet else sys.stdout) as sp:
         sp.text = f"Publishing spec {api}"
 
         try:
@@ -124,8 +137,12 @@ def get(ctx, uat):
     "--uat",
     **UAT_KWARGS
 )
+@click.option(
+    "--quiet",
+    **QUIET_KWARGS
+)
 @click.pass_context
-def delete(ctx, no_confirm, uat):
+def delete(ctx, no_confirm, uat, quiet):
     """
     Delete the published spec.
     """
@@ -138,7 +155,7 @@ def delete(ctx, no_confirm, uat):
         if not click.confirm(f"Delete the spec at {api}?"):
             raise click.Abort()
 
-    with yaspin() as sp:
+    with yaspin(stream=open(os.devnull, 'w') if quiet else sys.stdout) as sp:
         sp.text = f"Deleting spec {api}"
 
         try: