# SPDX-License-Identifier: BSD-3-Clause AND Apache-2.0
# Copyright 2018 Regents of the University of California
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# Copyright 2019 Blue Cheetah Analog Design Inc.
#
# 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.
"""This module defines methods to create files from templates.
"""
import os
from jinja2 import (
Environment, PackageLoader, select_autoescape, BaseLoader, TemplateNotFound, StrictUndefined
)
[docs]class FileLoader(BaseLoader):
"""A loader that loads files"""
def __init__(self) -> None:
BaseLoader.__init__(self)
[docs] def get_source(self, environment: Environment, template: str):
if not os.path.isfile(template):
raise TemplateNotFound(template)
mtime = os.path.getmtime(template)
with open(template, 'r') as f:
source = f.read()
return source, template, lambda: mtime == os.path.getmtime(template)
[docs]def new_template_env(parent_package: str, tmp_folder: str) -> Environment:
return Environment(trim_blocks=True,
lstrip_blocks=True,
keep_trailing_newline=True,
autoescape=select_autoescape(default_for_string=False),
loader=PackageLoader(parent_package, package_path=tmp_folder),
enable_async=False,
undefined=StrictUndefined,
)
[docs]def new_template_env_fs() -> Environment:
return Environment(trim_blocks=True,
lstrip_blocks=True,
keep_trailing_newline=True,
autoescape=select_autoescape(default_for_string=False),
loader=FileLoader(),
enable_async=False,
undefined=StrictUndefined,
)