Skip to content

Add caching of jinja templates #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkupferer merged 1 commit into from
Sep 11, 2025
+91 −89
Merged

Add caching of jinja templates #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Development.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,9 @@ helm template helm \
--set manageClaimsInterval=5 \
--set manageHandlesInterval=5 \
--set operatorDomain.name=poolboy.dev.local \
--set=image.tagOverride=- \
--set=image.repository=$(oc get imagestream poolboy -o jsonpath='{.status.tags[?(@.tag=="latest")].items[0].dockerImageReference}') \
--set resourceHandlerCount=2 \
--set image.tagOverride=- \
--set image.repository=$(oc get imagestream poolboy -o jsonpath='{.status.tags[?(@.tag=="latest")].items[0].dockerImageReference}') \
| oc apply -f -
--------------------------------------------------------------------------------

Expand Down
66 changes: 36 additions & 30 deletions operator/poolboy_templating.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,20 +101,18 @@ def timedelta_to_str(td:timedelta) -> str:
ret += f"{seconds}s"
return ret

jinja2envs = {
'jinja2': jinja2.Environment(
finalize = error_if_undefined,
undefined = jinja2.ChainableUndefined,
),
}
jinja2envs['jinja2'].filters['bool'] = lambda x: bool(str2bool(x)) if isinstance(x, str) else bool(x)
jinja2envs['jinja2'].filters['json_query'] = lambda x, query: jmespath.search(query, x)
jinja2envs['jinja2'].filters['merge_list_of_dicts'] = lambda a: functools.reduce(lambda d1, d2: {**(d1 or {}), **(d2 or {})}, a) if a else {}
jinja2envs['jinja2'].filters['object'] = lambda x: json.dumps(x)
jinja2envs['jinja2'].filters['parse_time_interval'] = lambda x: timedelta(seconds=pytimeparse.parse(str(x)))
jinja2envs['jinja2'].filters['strgen'] = lambda x: StringGenerator(x).render()
jinja2envs['jinja2'].filters['to_datetime'] = lambda s, f='%Y-%m-%d %H:%M:%S': datetime.strptime(str(s), f)
jinja2envs['jinja2'].filters['to_json'] = lambda x: json.dumps(x)
jinja2env = jinja2.Environment(
finalize = error_if_undefined,
undefined = jinja2.ChainableUndefined,
)
jinja2env.filters['bool'] = lambda x: bool(str2bool(x)) if isinstance(x, str) else bool(x)
jinja2env.filters['json_query'] = lambda x, query: jmespath.search(query, x)
jinja2env.filters['merge_list_of_dicts'] = lambda a: functools.reduce(lambda d1, d2: {**(d1 or {}), **(d2 or {})}, a) if a else {}
jinja2env.filters['object'] = lambda x: json.dumps(x)
jinja2env.filters['parse_time_interval'] = lambda x: timedelta(seconds=pytimeparse.parse(str(x)))
jinja2env.filters['strgen'] = lambda x: StringGenerator(x).render()
jinja2env.filters['to_datetime'] = lambda s, f='%Y-%m-%d %H:%M:%S': datetime.strptime(str(s), f)
jinja2env.filters['to_json'] = lambda x: json.dumps(x)

# Regex to detect if it looks like this value should be rendered as a raw type
# rather than a string.
Expand Down Expand Up @@ -146,10 +144,9 @@ def timedelta_to_str(td:timedelta) -> str:
# name: alice
type_filter_match_re = re.compile(r'^{{(?!.*{{).*\| *(bool|float|int|list|object) *}}$')

def check_condition(condition, template_style='jinja2', variables={}, template_variables={}):
def check_condition(condition, variables={}, template_variables={}):
return jinja2process(
template="{{ (" + condition + ") | bool}}",
template_style=template_style,
variables=variables,
template_variables=template_variables,
)
Expand Down Expand Up @@ -178,7 +175,15 @@ def j2now(utc=False, fmt=None):
dt = datetime.now(timezone.utc if utc else None)
return dt.strftime(fmt) if fmt else dt

def jinja2process(template, omit=None, template_style='jinja2', variables={}, template_variables={}):
j2template_cache = {}
def j2template_get(template: str):
if template in j2template_cache:
return j2template_cache[template]
j2template = jinja2env.from_string(template)
j2template_cache[template] = j2template
return j2template

def jinja2process(template, omit=None, variables={}, template_variables={}):
variables = copy.copy(variables)
variables['datetime'] = datetime
variables['now'] = j2now
Expand All @@ -187,18 +192,19 @@ def jinja2process(template, omit=None, template_style='jinja2', variables={}, te
variables['timezone'] = timezone
variables['timestamp'] = TimeStamp()
variables['__recursion_depth__'] = 0
jinja2env = jinja2envs.get(template_style)
j2template = jinja2env.from_string(template)
j2template = j2template_get(template)

class TemplateVariable(object):
'''Variable may contain template string referencing other variables.'''
def __init__(self, value):
self.template = value
self.j2template = jinja2env.from_string(value)
self.value = value
self.j2template = j2template_get(value) if '{{' in value else None

def get_typed_value(self):
template_out = self.__str__()
return template_output_typing(template_out, self.template)
if self.j2template:
template_out = self.__str__()
return template_output_typing(template_out, self.value)
return self.value

def __bool__(self):
return str2bool(self.__str__())
Expand Down Expand Up @@ -255,6 +261,8 @@ def __repr__(self):
return self.__str__()

def __str__(self):
if self.j2template is None:
return str(self.value)
if variables['__recursion_depth__'] > MAX_RECURSION_DEPTH:
raise RuntimeError("Template variable exceeded max recursion")
variables['__recursion_depth__'] += 1
Expand All @@ -268,7 +276,7 @@ def __str__(self):
template_out = j2template.render(variables)
return template_output_typing(template_out, template)

def recursive_process_template_strings(template, template_style='jinja2', variables={}, template_variables={}):
def recursive_process_template_strings(template, variables={}, template_variables={}):
"""Take a template and recursively process template strings within it.
The template may be any type.
If it is a dictionary or list then all values will be recursively procesed.
Expand All @@ -280,7 +288,6 @@ def recursive_process_template_strings(template, template_style='jinja2', variab
validating parameters, checking heath/readiness, and generating resource definitions.

Keyword arguments:
template_style -- Style of templates used. Currently only "jinja2" is supported
variables -- simple key/value pair variables
template_variables -- variables which may contain template strings and should only come from trusted sources
"""
Expand All @@ -289,26 +296,25 @@ def recursive_process_template_strings(template, template_style='jinja2', variab
__recursive_process_template_strings(
omit = omit,
template = template,
template_style = template_style,
variables = variables,
template_variables = template_variables,
),
omit = omit,
)

def __recursive_process_template_strings(template, omit, template_style, variables, template_variables):
def __recursive_process_template_strings(template, omit, variables, template_variables):
if isinstance(template, dict):
return {
key: __recursive_process_template_strings(val, omit=omit, template_style=template_style, variables=variables, template_variables=template_variables)
key: __recursive_process_template_strings(val, omit=omit, variables=variables, template_variables=template_variables)
for key, val in template.items()
}
elif isinstance(template, list):
return [
__recursive_process_template_strings(item, omit=omit, template_style=template_style, variables=variables, template_variables=template_variables)
__recursive_process_template_strings(item, omit=omit, variables=variables, template_variables=template_variables)
for item in template
]
elif isinstance(template, str):
return jinja2process(template, omit=omit, template_style=template_style, variables=variables, template_variables=template_variables)
return jinja2process(template, omit=omit, variables=variables, template_variables=template_variables)
else:
return template

Expand Down
11 changes: 3 additions & 8 deletions operator/resourceprovider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def check_wait_for(self,
)

return recursive_process_template_strings(
'{{(' + self.wait_for + ')|bool}}', resource_provider.template_style,
'{{(' + self.wait_for + ')|bool}}',
variables = vars_,
template_variables = {**resource_provider.vars, **resource_handle.vars},
)
Expand All @@ -92,7 +92,7 @@ def check_when(self,
resource_handle_vars = resource_handle.vars if resource_handle else {}

return recursive_process_template_strings(
'{{(' + self.when + ')|bool}}', resource_provider.template_style,
'{{(' + self.when + ')|bool}}',
variables = {
**parameter_values,
"resource_claim": resource_claim,
Expand Down Expand Up @@ -354,10 +354,6 @@ def status_summary_template(self) -> Mapping|None:
def template_enable(self):
return self.spec.get('template', {}).get('enable', False)

@property
def template_style(self) -> str:
return self.spec.get('template', {}).get('style', 'jinja2')

@property
def vars(self) -> Mapping:
return self.spec.get('vars', {})
Expand Down Expand Up @@ -402,7 +398,6 @@ def apply_template_defaults(self, resource_claim, resource_index) -> Mapping:
template,
recursive_process_template_strings(
template = self.spec['default'],
template_style = self.template_style,
variables = {
"resource_claim": resource_claim,
"resource_index": resource_index,
Expand Down Expand Up @@ -699,7 +694,7 @@ async def resource_definition_from_template(self,
deep_merge(
resource_definition,
recursive_process_template_strings(
self.override, self.template_style,
self.override,
variables = all_vars,
template_variables = {**self.vars, **resource_handle_vars}
)
Expand Down
Loading