charm-hacluster/charmhelpers/contrib/templating/jinja.py

48 lines
1.6 KiB
Python

# Copyright 2014-2015 Canonical Limited.
#
# 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.
"""
Templating using the python3-jinja2 package.
"""
from charmhelpers.fetch import apt_install, apt_update
try:
import jinja2
except ImportError:
apt_update(fatal=True)
apt_install(["python3-jinja2"], fatal=True)
import jinja2
DEFAULT_TEMPLATES_DIR = 'templates'
def render(template_name, context, template_dir=DEFAULT_TEMPLATES_DIR,
jinja_env_args=None):
"""
Render jinja2 template with provided context.
:param template_name: name of the jinja template file
:param context: template context
:param template_dir: directory in which the template file is located
:param jinja_env_args: additional arguments passed to the
jinja2.Environment. Expected dict with format
{'arg_name': 'arg_value'}
:return: Rendered template as a string
"""
env_kwargs = jinja_env_args or {}
templates = jinja2.Environment(
loader=jinja2.FileSystemLoader(template_dir), **env_kwargs)
template = templates.get_template(template_name)
return template.render(context)