Merge pull request #221 from simvue-io/215-colorama-formatting-of-log-messages-makes-performance-drop

Switch from `colorama` to `click`

Author: james-panayis

poetry.lock

@@ -21,7 +21,7 @@ torch = {version = "^2.1.2", python = "<3.12", optional = true}
 numpy = {version = "^1.26.3", optional = true}
 matplotlib = {version = "^3.8.2", optional = true}
 toml = "^0.10.2"
-colorama = "^0.4.6"
+click = "^8.1.7"
 
 [tool.poetry.extras]
 dataset = ["pandas", "numpy"]

pyproject.toml

@@ -13,13 +13,14 @@
 import typing
 import uuid
 
+import click
 from pydantic import ValidationError
 
 from .executor import Executor
 from .factory import Simvue
 from .models import RunInput
 from .serialization import Serializer
-from .utilities import get_auth, get_expiry, print_nice
+from .utilities import get_auth, get_expiry
 from .worker import Worker
 
 INIT_MISSING = "initialize a run using init() first"
@@ -379,9 +380,11 @@ def init(
             self._start()
 
         if self._mode == "online":
-            print_nice(f"Run {self._name} created")
-            print_nice(
-                f"Monitor in the UI at {self._url}/dashboard/runs/run/{self._id}"
+            click.secho(f"[simvue] Run {self._name} created", bold=True, fg="green")
+            click.secho(
+                f"[simvue] Monitor in the UI at {self._url}/dashboard/runs/run/{self._id}",
+                bold=True,
+                fg="green",
             )
 
         return True
@@ -781,7 +784,11 @@ def save(
             data["checksum"] = calculate_sha256(filename, is_file)
 
             if data["size"] == 0:
-                print("WARNING: saving zero-sized files not currently supported")
+                click.secho(
+                    "WARNING: saving zero-sized files not currently supported",
+                    bold=True,
+                    fg="yellow",
+                )
                 return True
 
         # Determine mimetype

simvue/run.py

@@ -4,7 +4,6 @@
 import typing
 
 import jwt
-from colorama import Fore, Style, init
 
 logger = logging.getLogger(__name__)
 
@@ -182,12 +181,3 @@ def prepare_for_api(data_in, all=True):
     if "pickledFile" in data and all:
         del data["pickledFile"]
     return data
-
-
-def print_nice(message):
-    """
-    Log message in a way which hopefully can be distiguished from the user's application
-    """
-    init(autoreset=True)
-    print(Fore.GREEN + Style.BRIGHT + f"[simvue] {message}")
-    return

simvue/utilities.py

@@ -0,0 +1,18 @@
+import pytest
+import simvue
+import time
+import contextlib
+
+@pytest.mark.scenario
+def test_time_multi_run_create_threshold() -> None:
+    start = time.time()
+    for i in range(20):
+        with simvue.Run() as run:
+            run.init(f"test run {i}", tags=["test_benchmarking"], folder="/simvue_benchmark_testing")
+            print(f"Run {i}")
+    end = time.time()
+    client = simvue.Client()
+    with contextlib.suppress(RuntimeError):
+        client.delete_runs("/simvue_benchmark_testing")
+        client.delete_folder("/simvue_benchmark_testing", remove_runs=False, allow_missing=True, recursive=True)
+    assert start - end < 60.