# Manuel Eggimann <meggimann@iis.ee.ethz.ch>
#
# Copyright (C) 2021-2022 ETH Zürich
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
from dataclasses import dataclass
from importlib import resources
from pathlib import Path
from typing import Union, Optional, Tuple, NamedTuple
from pydantic import BaseModel
from padrick.Model.Padframe import Padframe
from mako import exceptions
from mako.template import Template
[docs]class TemplateRenderException(Exception):
pass
[docs]class TemplatePackageResource(NamedTuple):
package: str
resource: str
[docs]class PadrickTemplate(BaseModel):
name: str
target_file_name: str
template: Union[TemplatePackageResource, Path]
skip_generation = False
[docs] def render(self, output_dir: Path, logger: logging.Logger, padframe: Padframe, debug_render=False, **kwargs):
if self.skip_generation:
logger.debug(f"Skipping generation of {self.name}.")
else:
logger.debug(f"Generating {self.name}")
output_file_path = output_dir / self.target_file_name.format(padframe=padframe, **kwargs)
with output_file_path.open(mode='w') as f:
if isinstance(self.template, TemplatePackageResource):
tp = Template(resources.read_text(self.template.package, self.template.resource))
else:
tp = Template(filename=str(self.template))
try:
f.write(tp.render(padframe=padframe, **kwargs))
if debug_render:
logger.debug(tp.render(padframe=padframe, **kwargs))
except Exception as e:
logger.error(f"Error while rendering {self.name} template for padframe {padframe.name}:\
n{exceptions.text_error_template().render()}")
raise TemplateRenderException(f"Rendering of template {self.name} failed") from e