feat(cli): optionally hide version splash (#3329)

* feat(cli): optionally hide version splash

As discussed in #3326, this PR proposes a new optional flag to hide the version splash when manim command in launched. Additionally, the splash print is now inly executed when the CLI is executed, not on module import.

After looking at the current documentation, it does not seem to change anything. I only saw that you documented a version splash for when the CLI is used, but not when the module is imported. So removing it should not break the api docs.

In the future, users can still have version information with `import manim; print(manim.__version__)`.

Closes #3326

* chore(tests): make tests pass

---------

Co-authored-by: Tristan Schulz <[email protected]>

Author: jeertmans

manim/__main__.py

@@ -2,6 +2,7 @@
 
 import sys
 
+import click
 import cloup
 
 from . import __version__, cli_ctx_settings, console
@@ -14,12 +15,15 @@
 from .constants import EPILOG
 
 
-def exit_early(ctx, param, value):
+def show_splash(ctx, param, value):
     if value:
-        sys.exit()
+        console.print(f"Manim Community [green]v{__version__}[/green]\n")
 
 
-console.print(f"Manim Community [green]v{__version__}[/green]\n")
+def print_version_and_exit(ctx, param, value):
+    show_splash(ctx, param, value)
+    if value:
+        ctx.exit()
 
 
 @cloup.group(
@@ -37,7 +41,16 @@ def exit_early(ctx, param, value):
     "--version",
     is_flag=True,
     help="Show version and exit.",
-    callback=exit_early,
+    callback=print_version_and_exit,
+    is_eager=True,
+    expose_value=False,
+)
+@click.option(
+    "--show-splash/--hide-splash",
+    is_flag=True,
+    default=True,
+    help="Print splash message with version information.",
+    callback=show_splash,
     is_eager=True,
     expose_value=False,
 )

tests/interface/test_commands.py

@@ -28,7 +28,9 @@ def test_manim_cfg_subcommand():
     command = ["cfg"]
     runner = CliRunner()
     result = runner.invoke(main, command, prog_name="manim")
-    expected_output = """\
+    expected_output = f"""\
+Manim Community v{__version__}
+
 Usage: manim cfg [OPTIONS] COMMAND [ARGS]...
 
   Manages Manim configuration files.
@@ -50,7 +52,9 @@ def test_manim_plugins_subcommand():
     command = ["plugins"]
     runner = CliRunner()
     result = runner.invoke(main, command, prog_name="manim")
-    expected_output = """\
+    expected_output = f"""\
+Manim Community v{__version__}
+
 Usage: manim plugins [OPTIONS]
 
   Manages Manim plugins.
@@ -90,7 +94,9 @@ def test_manim_init_subcommand():
     command = ["init"]
     runner = CliRunner()
     result = runner.invoke(main, command, prog_name="manim")
-    expected_output = """\
+    expected_output = f"""\
+Manim Community v{__version__}
+
 Usage: manim init [OPTIONS] COMMAND [ARGS]...
 
   Create a new project or insert a new scene.