mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-07-14 04:14:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Caching templates to allow for dynamic template generation

Browse source 
Co-authored-by: rbeard0330 <@dul2k3BKW6m>
This commit is contained in:
Emil Stenström 2021-02-15 21:07:14 +01:00 • committed by GitHub
parent 3919943cbd
commit 07986c5216
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 36 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

27
django_components/component.py
View file

@ -1,5 +1,6 @@
import warnings
from copy import copy
from functools import lru_cache
from itertools import chain
from django.conf import settings
@ -11,12 +12,15 @@ from django.utils.safestring import mark_safe
# Allow "component.AlreadyRegistered" instead of having to import these everywhere
from django_components.component_registry import AlreadyRegistered, ComponentRegistry, NotRegistered # noqa
TEMPLATE_CACHE_SIZE = getattr(settings, "COMPONENTS", {}).get('TEMPLATE_CACHE_SIZE', 128)
class Component(metaclass=MediaDefiningClass):
def __init__(self, component_name):
self.__component_name = component_name
self.instance_template = None
self.slots = {}
def context(self):
return {}
@ -43,15 +47,16 @@ class Component(metaclass=MediaDefiningClass):
def slots_in_template(template):
return {node.name: node.nodelist for node in template.template.nodelist if is_slot_node(node)}
def compile_instance_template(self, slots_for_instance):
@lru_cache(maxsize=TEMPLATE_CACHE_SIZE)
def compile_instance_template(self, template_name):
"""Use component's base template and the slots used for this instance to compile
a unified template for this instance."""
component_template = get_template(self.template({}))
component_template = get_template(template_name)
slots_in_template = self.slots_in_template(component_template)
defined_slot_names = set(slots_in_template.keys())
filled_slot_names = set(slots_for_instance.keys())
filled_slot_names = set(self.slots.keys())
unexpected_slots = filled_slot_names - defined_slot_names
if unexpected_slots:
if settings.DEBUG:
@ -61,21 +66,25 @@ class Component(metaclass=MediaDefiningClass):
)
)
for unexpected_slot in unexpected_slots:
del slots_for_instance[unexpected_slot]
del self.slots[unexpected_slot]
combined_slots = dict(slots_in_template, **slots_for_instance)
combined_slots = dict(slots_in_template, **self.slots)
if combined_slots:
# Replace slot nodes with their nodelists, then combine into a single, flat nodelist
node_iterator = ([node] if not is_slot_node(node) else combined_slots[node.name]
for node in component_template.template.nodelist)
self.instance_template = copy(component_template.template)
self.instance_template.nodelist = NodeList(chain.from_iterable(node_iterator))
instance_template = copy(component_template.template)
instance_template.nodelist = NodeList(chain.from_iterable(node_iterator))
else:
self.instance_template = component_template.template
instance_template = component_template.template
return instance_template
def render(self, context):
return self.instance_template.render(context)
template_name = self.template(context)
instance_template = self.compile_instance_template(template_name)
return instance_template.render(context)
class Media:
css = {}