feat!: Use pretty output for exists if raw-option is not set

To archive the old beaviour add the --output-raw option to your cli call

Author: onefloid

tests/test_cmd_dimension.py

@@ -16,9 +16,16 @@ def test_dimension_list(mocker, command):
     assert result.stdout == "Dimension1\nDimension2\nDimension3\n"
 
 
-def test_dimension_exists(mocker):
+@pytest.mark.parametrize(
+    "raw_option,expected_output",
+    [(None, "✅ Dimension exists!\n"), ("--output-raw", "True\n")],
+)
+def test_dimension_exists(mocker, raw_option, expected_output):
     mocker.patch("tm1cli.utils.generic.TM1Service", MockedTM1Service)
-    result = runner.invoke(app, ["dimension", "exists", "Dimension1"])
+    if raw_option:
+        result = runner.invoke(app, [raw_option, "dimension", "exists", "Dimension1"])
+    else:
+        result = runner.invoke(app, ["dimension", "exists", "Dimension1"])
     assert result.exit_code == 0
     assert isinstance(result.stdout, str)
-    assert result.stdout == "True\n"
+    assert result.stdout == expected_output

tm1cli/main.py

@@ -1,7 +1,7 @@
-import os
+import importlib.metadata
 import json
+import os
 
-import importlib.metadata
 import typer
 import yaml
 from rich import print
@@ -14,7 +14,6 @@
 from tm1cli.utils.cli_param import DATABASE_OPTION
 from tm1cli.utils.various import resolve_database
 
-
 console = Console()
 app = typer.Typer()
 
@@ -30,7 +29,13 @@
 
 
 @app.callback()
-def main(ctx: typer.Context):
+def main(
+    ctx: typer.Context,
+    raw: Annotated[
+        bool,
+        typer.Option("--output-raw", help="Raw output without formatting"),
+    ] = False,
+):
     """
     CLI tool to interact with TM1 using TM1py.
     """
@@ -52,6 +57,8 @@ def main(ctx: typer.Context):
         }
         ctx.obj = {"configs": {}, "default_db_config": default_db_config}
 
+    ctx.obj["raw"] = raw
+
 
 @app.command()
 def version():

tm1cli/utils/generic.py

@@ -15,7 +15,17 @@ def execute_exists(attribute_name, ctx, database, **args):
 
             attribute = getattr(tm1, attribute_name)
             method = getattr(attribute, "exists")
-            print(method(**args))
+            output = method(**args)
+            if ctx.obj["raw"]:
+                print(output)
+                return
+
+            output_name = f"{attribute_name[:-1].capitalize()}"
+            if output:
+                print(f":white_check_mark: {output_name} exists!")
+            else:
+                print(f":x: {output_name} does not exist!")
+
     except Exception as e:
         print(f"[bold red]{type(e).__name__}:[/bold red] {e}")
         raise typer.Exit(code=1)