feat: add template_searchpaths to generator config

Author: esynr3z

schemas/corsair-build-schema.json

@@ -15,6 +15,15 @@
       "additionalProperties": false,
       "description": "Configuration for the Markdown generator.",
       "properties": {
+        "template_searchpaths": {
+          "description": "Additional paths to search for templates.\n\nTemplates will be searched for in the given paths first.",
+          "items": {
+            "format": "path",
+            "type": "string"
+          },
+          "title": "Template Searchpaths",
+          "type": "array"
+        },
         "extra": {
           "additionalProperties": true,
           "description": "Extra configuration parameters for the generator.",
@@ -68,6 +77,7 @@
         "wavedrom": {
           "$ref": "#/$defs/corsair___generators__wavedrom__WaveDromGenerator__Config",
           "default": {
+            "template_searchpaths": [],
             "extra": {},
             "kind": "wavedrom",
             "vspace": 80,
@@ -92,6 +102,15 @@
       "additionalProperties": false,
       "description": "Configuration for the Verilog generator.",
       "properties": {
+        "template_searchpaths": {
+          "description": "Additional paths to search for templates.\n\nTemplates will be searched for in the given paths first.",
+          "items": {
+            "format": "path",
+            "type": "string"
+          },
+          "title": "Template Searchpaths",
+          "type": "array"
+        },
         "extra": {
           "additionalProperties": true,
           "description": "Extra configuration parameters for the generator.",
@@ -117,6 +136,15 @@
       "additionalProperties": false,
       "description": "Configuration for the VHDL generator.",
       "properties": {
+        "template_searchpaths": {
+          "description": "Additional paths to search for templates.\n\nTemplates will be searched for in the given paths first.",
+          "items": {
+            "format": "path",
+            "type": "string"
+          },
+          "title": "Template Searchpaths",
+          "type": "array"
+        },
         "extra": {
           "additionalProperties": true,
           "description": "Extra configuration parameters for the generator.",
@@ -142,6 +170,15 @@
       "additionalProperties": false,
       "description": "Configuration for the WaveDrom generator.",
       "properties": {
+        "template_searchpaths": {
+          "description": "Additional paths to search for templates.\n\nTemplates will be searched for in the given paths first.",
+          "items": {
+            "format": "path",
+            "type": "string"
+          },
+          "title": "Template Searchpaths",
+          "type": "array"
+        },
         "extra": {
           "additionalProperties": true,
           "description": "Extra configuration parameters for the generator.",

src/corsair/_generators/base.py

@@ -81,6 +81,12 @@ def __str__(self) -> str:
 class GeneratorConfig(BaseModel, ABC):
     """Base configuration for a generator."""
 
+    template_searchpaths: list[Path] = Field(default_factory=list)
+    """Additional paths to search for templates.
+
+    Templates will be searched for in the given paths first.
+    """
+
     extra: dict[str, Any] = Field(default_factory=dict)
     """Extra configuration parameters for the generator."""
 
@@ -108,14 +114,12 @@ def __init__(
         register_map: Map,
         config: GeneratorConfig,
         output_dir: Path,
-        template_searchpaths: list[Path] | None = None,
     ) -> None:
         """Initialize the generator."""
         self.label = label
         self.register_map = register_map
         self.config = config
         self.output_dir = output_dir.resolve()
-        self.template_searchpaths = template_searchpaths
 
         if not isinstance(self.config, self.get_config_cls()):
             raise TypeError(
@@ -139,7 +143,7 @@ def __call__(self) -> TypeGenerator[Path, None, None]:
 
     def _render_to_text(self, template_name: str, context: dict[str, Any]) -> str:
         """Render text with Jinja2."""
-        env = TemplateEnvironment(searchpath=self.template_searchpaths)
+        env = TemplateEnvironment(searchpath=self.config.template_searchpaths)
         template = env.get_template(template_name)
         return template.render(context)
 

src/corsair/_templates/env.py

@@ -61,9 +61,9 @@ def __init__(self, searchpath: list[Path] | None = None) -> None:
         """Initialize the template environment."""
         if not searchpath:
             searchpath = []
+
         # Always include the directory containing the built-in templates
-        if Path(__file__).parent not in searchpath:
-            searchpath.append(Path(__file__).parent)
+        searchpath.append(Path(__file__).parent)
 
         super().__init__(
             loader=_EnhancedFileSystemLoader(searchpath=searchpath),

tests/generators/test_markdown.py

@@ -66,6 +66,30 @@ def simple_regmap() -> csr.Map:
     )
 
 
+@pytest.fixture
+def custom_template(tmp_path: Path) -> Path:
+    """Create a custom template file directly in tmp_path and return its absolute path."""
+    template_name = "custom_template_fixture.md.j2"
+    template_content = (
+        """"" \
+# Custom Template Fixture Test
+
+Registers:
+{% for item in regmap.items %}
+- {{ item.name }}
+{% endfor %}
+
+{% if cfg.extra['my_param'] is defined %}
+Custom Param: {{ cfg.extra['my_param'] }}
+{% endif %}
+"""
+        ""
+    )  # Raw string literal to handle backslashes correctly
+    template_file = tmp_path / template_name
+    template_file.write_text(template_content)
+    return template_file.resolve()  # Return absolute path
+
+
 def test_default_generation(tmp_path: Path, simple_regmap: csr.Map) -> None:
     """Test default Markdown generation."""
     config = csr.MarkdownGenerator.Config()
@@ -215,25 +239,13 @@ def test_wavedrom_dump_json(tmp_path: Path, simple_regmap: csr.Map) -> None:
     assert {f for f in expected_data_dir.iterdir() if f.suffix == ".json"} == expected_json_files
 
 
-def test_custom_template_and_extra_param(tmp_path: Path, simple_regmap: csr.Map) -> None:
+def test_custom_template_and_extra_param(tmp_path: Path, simple_regmap: csr.Map, custom_template: Path) -> None:
     """Test generation with a custom template and extra config parameters."""
-    custom_template_name = "custom_template.md.j2"
-    custom_template_content = """
-# Custom Template Test
-
-Registers:
-{% for item in regmap.items %}
-- {{ item.name }}
-{% endfor %}
-
-Custom Param: {{ cfg.extra['my_param'] }}
-"""
-    custom_template_file = tmp_path / custom_template_name
-    custom_template_file.write_text(custom_template_content)
+    template_file = custom_template
 
     custom_key = "my_param"
     custom_value = "hello_world"
-    config = csr.MarkdownGenerator.Config(template_name=str(custom_template_file), extra={custom_key: custom_value})
+    config = csr.MarkdownGenerator.Config(template_name=str(template_file), extra={custom_key: custom_value})
 
     gen = csr.MarkdownGenerator(
         label="test_md_gen_custom_tmpl",
@@ -250,8 +262,34 @@ def test_custom_template_and_extra_param(tmp_path: Path, simple_regmap: csr.Map)
 
     # Check the content of the generated file
     content = expected_file.read_text()
-    assert "# Custom Template Test" in content
+    assert "# Custom Template Fixture Test" in content
     assert "Registers:" in content
     assert "- reg1" in content
     assert "- reg2" in content
     assert f"Custom Param: {custom_value}" in content
+
+
+def test_custom_template_searchpath(tmp_path: Path, simple_regmap: csr.Map, custom_template: Path) -> None:
+    """Test generation with a custom template specified via search path."""
+    template_file = custom_template  # Fixture now returns the absolute path
+    templates_dir = template_file.parent
+    template_name = template_file.name
+
+    # Configure the generator to use the custom template directory and name
+    config = csr.MarkdownGenerator.Config(
+        template_searchpaths=[templates_dir],
+        template_name=template_name,
+    )
+
+    gen = csr.MarkdownGenerator(
+        label="test_md_gen_searchpath",
+        register_map=simple_regmap,
+        config=config,
+        output_dir=tmp_path,
+    )
+
+    # Running the generator should succeed without TemplateNotFound
+    try:
+        list(gen())
+    except csr.GeneratorTemplateError as e:
+        pytest.fail(f"Template generation failed: {e}")