Don't show spinner with verbose output (#160)

The spinner interferes with the extra output when verbose output is enabled (`-v` option).

Author: danielhollas

aiidalab_launch/__main__.py

@@ -92,7 +92,10 @@ def callback(ctx, param, value):  # noqa: U100
     "-v",
     "--verbose",
     count=True,
-    help="Provide this option to increase the output verbosity of the launcher.",
+    help=(
+        "Increase the output verbosity of the launcher. "
+        "Use '-vv' or '-vvv' for even more verbose output"
+    ),
 )
 @pass_app_state
 def cli(app_state, verbose):

aiidalab_launch/util.py

@@ -1,4 +1,5 @@
 import asyncio
+import logging
 import re
 import webbrowser
 from contextlib import contextmanager
@@ -36,18 +37,27 @@
 
 @contextmanager
 def spinner(
-    msg: Optional[str] = None, final: Optional[str] = None, delay: float = 0
+    msg: Optional[str] = None, final: Optional[str] = "done.", delay: float = 0
 ) -> Generator[None, None, None]:
     """Display spinner only after an optional initial delay."""
 
     def spin() -> None:
+
+        # Don't show spinner if verbose output is enabled
+        level = logging.getLogger().getEffectiveLevel()
+        show_spinner = (
+            True if level == logging.NOTSET or level >= logging.ERROR else False
+        )
         if msg:
-            click.echo(f"{msg.rstrip()} ", nl=False, err=True)
-        with click_spinner.spinner():  # type: ignore
+            newline = not show_spinner
+            click.echo(f"{msg.rstrip()} ", nl=newline, err=True)
+
+        if show_spinner:
+            with click_spinner.spinner():  # type: ignore
+                stop.wait()
+            click.echo(final if (completed.is_set() and msg) else " ", err=True)
+        else:
             stop.wait()
-        click.echo(
-            (final or "done.") if (completed.is_set() and msg) else " ", err=True
-        )
 
     stop = Event()
     completed = Event()

tests/test_cli.py

@@ -214,6 +214,8 @@ def assert_status_down():
         assert result.exit_code == 0
 
         # Start instance again (blocking, should be no-op).
+        # Disabling verbose logging to test the spinner
+        caplog.set_level(logging.ERROR)
         runner: CliRunner = CliRunner()
         result: Result = runner.invoke(
             cli.cli, ["start", "--no-browser", "--no-pull", "--wait=300"]
@@ -225,6 +227,7 @@ def assert_status_down():
         assert get_volume(instance.profile.conda_volume_name())
 
         # Start instance again – should be noop.
+        caplog.set_level(logging.DEBUG)
         result: Result = runner.invoke(
             cli.cli, ["start", "--no-browser", "--no-pull", "--wait=300"]
         )