feat: add jinja2 template renderer

Signed-off-by: James McCorrie <[email protected]>

Author: machshev

pyproject.toml

@@ -20,6 +20,7 @@ dependencies = [
     "click>=8.1.7",
     "enlighten>=1.12.4",
     "hjson>=3.1.0",
+    "jinja2>=3.1.6",
     "logzero>=1.7.0",
     "mistletoe>=1.4.0",
     "premailer>=3.10.0",

src/dvsim/templates/__init__.py

@@ -0,0 +1,5 @@
+# Copyright lowRISC contributors (OpenTitan project).
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Templates for DVSim."""

src/dvsim/templates/render.py

@@ -0,0 +1,41 @@
+# Copyright lowRISC contributors (OpenTitan project).
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Render templates for use with report generation.
+
+This directory is also the parent directory containing templates for use with
+DVSim. Templates can be referenced relative to this directory.
+"""
+
+from collections.abc import Mapping
+
+from jinja2 import Environment, PackageLoader, select_autoescape
+
+__all__ = ("render_template",)
+
+_env: Environment | None = None
+
+
+def render_template(path: str, data: Mapping[str, object] | None = None) -> str:
+    """Render a template packaged with DVSim.
+
+    Args:
+        path: relative path to the DVSim template directory
+        data: mapping of key/value pairs to send to the template renderer
+
+    Returns:
+        string containing the rendered template
+
+    """
+    global _env
+
+    if _env is None:
+        _env = Environment(
+            loader=PackageLoader("dvsim"),
+            autoescape=select_autoescape(),
+        )
+
+    template = _env.get_template(path)
+
+    return template.render(data)