ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Override Jinja2 Template class to make {% include %} work again

Browse source 
Fixes #1908.
This commit is contained in:
Daniel Hokka Zakrisson 2013-01-25 01:48:04 +01:00
parent 58618474db
commit 864b75e54b
1 changed files with 41 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
lib/ansible/utils/template.py
View file

@ -249,15 +249,34 @@ def template(basedir, text, vars, lookup_fatal=True, expand_lists=False):
return text return text
class _jinja2_vars(object): class _jinja2_vars(object):
''' helper class to template all variable content before jinja2 sees it ''' '''
def __init__(self, basedir, vars, globals): Helper class to template all variable content before jinja2 sees it.
This is done by hijacking the variable storage that jinja2 uses, and
overriding __contains__ and __getitem__ to look like a dict. Added bonus
is avoiding duplicating the large hashes that inject tends to be.
To facilitate using builtin jinja2 things like range, globals are handled
here.
extras is a list of locals to also search for variables.
'''
def __init__(self, basedir, vars, globals, *extras):
self.basedir = basedir self.basedir = basedir
self.vars = vars self.vars = vars
self.globals = globals self.globals = globals
self.extras = extras
def __contains__(self, k): def __contains__(self, k):
return k in self.vars or k in self.globals if k in self.vars:
return True
for i in self.extras:
if k in i:
return True
if k in self.globals:
return True
return False
def __getitem__(self, varname): def __getitem__(self, varname):
if varname not in self.vars: if varname not in self.vars:
for i in self.extras:
if varname in i:
return i[varname]
if varname in self.globals: if varname in self.globals:
return self.globals[varname] return self.globals[varname]
else: else:
@ -268,6 +287,24 @@ class _jinja2_vars(object):
return var return var
else: else:
return template_ds(self.basedir, var, self.vars) return template_ds(self.basedir, var, self.vars)
def add_locals(self, locals):
'''
If locals are provided, create a copy of self containing those
locals in addition to what is already in this variable proxy.
'''
if locals is None:
return self
return _jinja2_vars(self.basedir, self.vars, self.globals, locals, *self.extras)
class J2Template(jinja2.environment.Template):
'''
This class prevents Jinja2 from running _jinja2_vars through dict()
Without this, {% include %} and similar will create new contexts unlike
the special one created in template_from_file. This ensures they are all
alike, with the exception of potential locals.
'''
def new_context(self, vars=None, shared=False, locals=None):
return jinja2.runtime.Context(self.environment, vars.add_locals(locals), self.name, self.blocks)
def template_from_file(basedir, path, vars): def template_from_file(basedir, path, vars):
''' run a file through the templating engine ''' ''' run a file through the templating engine '''
@ -297,6 +334,7 @@ def template_from_file(basedir, path, vars):
(key,val) = pair.split(':') (key,val) = pair.split(':')
setattr(environment,key.strip(),val.strip()) setattr(environment,key.strip(),val.strip())
environment.template_class = J2Template
t = environment.from_string(data) t = environment.from_string(data)
vars = vars.copy() vars = vars.copy()
try: try: