feat(tools): add a retry tool for launcher

jourdain · jourdain · commit c3110e5f8bc1 · 2025-08-18T14:19:23.000-06:00
diff --git a/docs/api/source/index.rst b/docs/api/source/index.rst
@@ -40,6 +40,7 @@ Welcome to Trame's documentation!
 
    tools.www
    tools.app
+   tools.retry
    tools.widgets
    tools.serve
    tools.vtk
diff --git a/docs/api/source/tools.retry.rst b/docs/api/source/tools.retry.rst
@@ -0,0 +1,15 @@
+Update launcher retry array
+==============================
+
+This small utility let you run a command line to update an existing HTML file
+with a new launcher-retry content.
+
+In order to use that tool, you will need to provide the path of the base
+application to use as template along with the content of the launcher-retry.
+This tool will then update the HTML file provided.
+
+
+.. code-block:: bash
+
+    python -m trame.tools.retry --input ./www-content/index.html --retry "[3000, 2000, 1000]"
+    # => Update ./www-content/index.html using data-launcher-retry="[3000, 2000, 1000]" instead of the default empty array.
diff --git a/pyproject.toml b/pyproject.toml
@@ -2,19 +2,17 @@
 name = "trame"
 version = "3.11.0"
 description = "Trame, a framework to build applications in plain Python"
-authors = [
-    {name = "Kitware Inc."},
-]
+authors = [{ name = "Kitware Inc." }]
 dependencies = [
     "trame-server>=3.4,<4",
-    "trame-client>=3.8,<4",
+    "trame-client>=3.10.1,<4",
     "trame-common>=1,<2",
     "wslink>=2.3.3",
-    "pyyaml", # for trame.tools.widgets
+    "pyyaml",                  # for trame.tools.widgets
 ]
 requires-python = ">=3.9"
 readme = "README.rst"
-license = {text = "Apache License 2.0"}
+license = { text = "Apache License 2.0" }
 keywords = ["Python", "Interactive", "Web", "Application", "Framework"]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -28,17 +26,9 @@ classifiers = [
 ]
 
 [project.optional-dependencies]
-app = [
-    "pywebview",
-]
-jupyter = [
-    "jupyterlab",
-]
-dev = [
-    "pre-commit",
-    "ruff",
-    "pytest",
-]
+app = ["pywebview"]
+jupyter = ["jupyterlab"]
+dev = ["pre-commit", "ruff", "pytest"]
 
 [build-system]
 requires = ['setuptools', 'wheel']
@@ -51,9 +41,7 @@ where = ["."]
 
 
 [tool.semantic_release]
-version_toml = [
-    "pyproject.toml:project.version",
-]
+version_toml = ["pyproject.toml:project.version"]
 build_command = """
   python -m venv .venv
   source .venv/bin/activate
diff --git a/trame/tools/retry.py b/trame/tools/retry.py
@@ -0,0 +1,60 @@
+r"""
+From the directory containing the static content for a trame application to work,
+generate another application specific HTML file.
+"""
+
+import argparse
+import re
+import sys
+from pathlib import Path
+
+RETRY_PATTERN = re.compile(r'data-launcher-retry=".+"')
+
+
+def update_retry_file(input_file, output_file, retry_array):
+    # Read in the file
+    with open(input_file, "r") as f_in:
+        content = f_in.read()
+        patched_content = RETRY_PATTERN.sub(
+            f'data-launcher-retry="{retry_array}"', content
+        )
+        with open(output_file, "w") as f_out:
+            f_out.write(patched_content)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="HTML app file generator for trame applications"
+    )
+
+    parser.add_argument(
+        "--retry",
+        default="[]",
+        help="Retry array for launcher. Times are in ms.",
+    )
+
+    parser.add_argument(
+        "--input",
+        help="Input file to use as template",
+    )
+
+    args, _ = parser.parse_known_args()
+
+    # Handle input
+    input_file = Path(args.input)
+    if not input_file.exists():
+        parser.print_help()
+        sys.exit(0)
+
+    if input_file.is_dir():
+        input_file = input_file / "index.html"
+
+    if not input_file.exists():
+        parser.print_help()
+        sys.exit(0)
+
+    update_retry_file(input_file, input_file, args.retry)
+
+
+if __name__ == "__main__":
+    main()
