Refactor bolt.jinja to bolt.templates, render templates immediately

Author: davegaeddert

bolt-auth/bolt/auth/forms.py

@@ -1,12 +1,13 @@
 import unicodedata
 
-from bolt import forms, jinja
+from bolt import forms
 from bolt.auth import authenticate, get_user_model, password_validation
 from bolt.auth.models import User
 from bolt.auth.tokens import default_token_generator
 from bolt.db.forms import ModelForm
 from bolt.exceptions import ValidationError
 from bolt.mail import EmailMultiAlternatives
+from bolt.templates import Template
 from bolt.utils.encoding import force_bytes
 from bolt.utils.http import urlsafe_base64_encode
 
@@ -279,16 +280,16 @@ def send_mail(
         """
         Send a bolt.mail.EmailMultiAlternatives to `to_email`.
         """
-        template = jinja.environment.from_string(subject_template_name)
+        template = Template(subject_template_name)
         subject = template.render(context)
         # Email subject *must not* contain newlines
         subject = "".join(subject.splitlines())
-        template = jinja.environment.from_string(email_template_name)
+        template = Template(email_template_name)
         body = template.render(context)
 
         email_message = EmailMultiAlternatives(subject, body, from_email, [to_email])
         if html_email_template_name is not None:
-            template = jinja.environment.from_string(html_email_template_name)
+            template = Template(html_email_template_name)
             html_email = template.render(context)
             email_message.attach_alternative(html_email, "text/html")
 

bolt-htmx/bolt/htmx/jinja.py

@@ -1,7 +1,7 @@
 import jinja2
 from jinja2.ext import Extension
 
-from bolt.jinja.extensions import InclusionTagExtension
+from bolt.templates.jinja.extensions import InclusionTagExtension
 
 
 class HTMXJSExtension(InclusionTagExtension):

bolt-htmx/bolt/htmx/views.py

@@ -1,26 +1,23 @@
 import re
 
-from bolt.http import HttpResponse
-
 
 class HTMXViewMixin:
     htmx_template_name = ""
 
-    def get_template_response(self, context=None) -> HttpResponse:
+    def render_template(self):
+        template = super().get_template()
+        context = self.get_context()
+
         if self.is_htmx_request and self.htmx_fragment_name:
             from .jinja import HTMXFragmentExtension
 
-            template = self.get_template()
-            if context is None:
-                context = self.get_context()
-            rendered = HTMXFragmentExtension.render_template_fragment(
-                template=template,
+            return HTMXFragmentExtension.render_template_fragment(
+                template=template._jinja_template,
                 fragment_name=self.htmx_fragment_name,
                 context=context,
             )
-            return HttpResponse(rendered, content_type=self.content_type)
 
-        return super().get_template_response(context=context)
+        return template.render(context)
 
     def get_request_handler(self):
         if self.is_htmx_request:

bolt-importmap/bolt/importmap/jinja.py

@@ -1,7 +1,7 @@
 import json
 
-from bolt.jinja.extensions import InclusionTagExtension
 from bolt.runtime import settings
+from bolt.templates.jinja.extensions import InclusionTagExtension
 
 from .core import Importmap
 

bolt-oauth/bolt/oauth/views.py

@@ -1,6 +1,6 @@
-from bolt import jinja
 from bolt.auth.mixins import LoginRequiredMixin
 from bolt.http import HttpResponseBadRequest, HttpResponseRedirect
+from bolt.templates import jinja
 from bolt.views import View
 
 from .exceptions import (

bolt-pages/bolt/pages/pages.py

@@ -3,8 +3,8 @@
 import frontmatter
 import pycmarkgfm
 
-from bolt.jinja import environment
 from bolt.runtime import settings
+from bolt.templates.jinja import environment
 from bolt.utils.functional import cached_property
 
 

bolt-staff/bolt/admin/cards/base.py

@@ -1,7 +1,7 @@
 from enum import Enum
 
-from bolt import jinja
 from bolt.admin.dates import DatetimeRange, DatetimeRangeAliases
+from bolt.templates import Template
 from bolt.utils.text import slugify
 
 
@@ -39,8 +39,7 @@ def render(self, request, datetime_range):
             # If fixed, show that on the card too (I guess you could use description for this)
         else:
             self.datetime_range = datetime_range
-        template = jinja.environment.get_template(self.template_name)
-        return template.render(self.get_context())
+        return Template(self.template_name).render(self.get_context())
 
     @classmethod
     def view_name(cls) -> str:

bolt-staff/bolt/querystats/middleware.py

@@ -86,15 +86,3 @@ def is_staff_request(request):
             return request.impersonator and request.impersonator.is_staff
 
         return hasattr(request, "user") and request.user and request.user.is_staff
-
-    def process_template_response(self, request, response):
-        # Template hasn't been rendered yet, so we can't include querystats themselves
-        # unless we're pulling the previous page stats from the session storage
-        if (
-            response.context_data is not None
-            and hasattr(_local, "querystats")
-            and self.is_staff_request(request)
-        ):
-            response.context_data["querystats_enabled"] = True
-
-        return response

bolt-staff/bolt/toolbar/jinja.py

@@ -1,5 +1,5 @@
-from bolt.jinja.extensions import InclusionTagExtension
 from bolt.runtime import settings
+from bolt.templates.jinja.extensions import InclusionTagExtension
 from bolt.utils.module_loading import import_string
 
 

bolt-staff/bolt/toolbar/templates/toolbar/toolbar.html

@@ -22,7 +22,7 @@
             {% endif %}
         </div>
         <div class="flex items-center space-x-4">
-            {% if querystats_enabled|default(false) %}{% include "querystats/toolbar.html" %}{% endif %}
+            {% include "querystats/toolbar.html" %}
 
             <div class="flex items-center space-x-3 transition-all">
                 {% include "toolbar/links.html" %}

bolt-tailwind/bolt/tailwind/jinja.py

@@ -1,6 +1,6 @@
 from bolt.assets.finders import APP_ASSETS_DIR
-from bolt.jinja.extensions import InclusionTagExtension
 from bolt.runtime import settings
+from bolt.templates.jinja.extensions import InclusionTagExtension
 
 
 class TailwindCSSExtension(InclusionTagExtension):

bolt/internal/handlers/base.py

@@ -15,7 +15,6 @@
 
 class BaseHandler:
     _view_middleware = None
-    _template_response_middleware = None
     _exception_middleware = None
     _middleware_chain = None
 
@@ -26,7 +25,6 @@ def load_middleware(self):
         Must be called after the environment is fixed (see __call__ in subclasses).
         """
         self._view_middleware = []
-        self._template_response_middleware = []
         self._exception_middleware = []
 
         get_response = self._get_response
@@ -61,10 +59,6 @@ def load_middleware(self):
                     0,
                     self.adapt_method_mode(mw_instance.process_view),
                 )
-            if hasattr(mw_instance, "process_template_response"):
-                self._template_response_middleware.append(
-                    self.adapt_method_mode(mw_instance.process_template_response),
-                )
             if hasattr(mw_instance, "process_exception"):
                 # The exception-handling stack is still always synchronous for
                 # now, so adapt that way.
@@ -145,27 +139,6 @@ def _get_response(self, request):
         # Complain if the view returned None (a common error).
         self.check_response(response, callback)
 
-        # If the response supports deferred rendering, apply template
-        # response middleware and then render the response
-        if hasattr(response, "render") and callable(response.render):
-            for middleware_method in self._template_response_middleware:
-                response = middleware_method(request, response)
-                # Complain if the template response middleware returned None
-                # (a common error).
-                self.check_response(
-                    response,
-                    middleware_method,
-                    name="{}.process_template_response".format(
-                        middleware_method.__self__.__class__.__name__
-                    ),
-                )
-            try:
-                response = response.render()
-            except Exception as e:
-                response = self.process_exception_by_middleware(e, request)
-                if response is None:
-                    raise
-
         return response
 
     def resolve_request(self, request):

bolt/jinja/context.py

@@ -196,4 +196,4 @@
 #############
 
 JINJA_LOADER = "jinja2.loaders.FileSystemLoader"
-JINJA_ENVIRONMENT = "bolt.jinja.defaults.create_default_environment"
+JINJA_ENVIRONMENT = "bolt.templates.jinja.defaults.create_default_environment"

bolt/runtime/global_settings.py

@@ -0,0 +1,6 @@
+from .core import Template, TemplateFileMissing
+
+__all__ = [
+    "Template",
+    "TemplateFileMissing",
+]

bolt/templates/__init__.py

@@ -0,0 +1,20 @@
+import jinja2
+
+from .jinja import environment
+
+
+class TemplateFileMissing(Exception):
+    pass
+
+
+class Template:
+    def __init__(self, filename: str) -> None:
+        self.filename = filename
+
+        try:
+            self._jinja_template = environment.get_template(filename)
+        except jinja2.TemplateNotFound:
+            raise TemplateFileMissing(f"Template file {filename} not found")
+
+    def render(self, context: dict) -> str:
+        return self._jinja_template.render(context)

bolt/templates/core.py

@@ -122,22 +122,8 @@ def _wrapper_view(request, *args, **kwargs):
                         if result is not None:
                             return result
                     raise
-                if hasattr(response, "render") and callable(response.render):
-                    if hasattr(middleware, "process_template_response"):
-                        response = middleware.process_template_response(
-                            request, response
-                        )
-                    # Defer running of process_response until after the template
-                    # has been rendered:
-                    if hasattr(middleware, "process_response"):
-
-                        def callback(response):
-                            return middleware.process_response(request, response)
-
-                        response.add_post_render_callback(callback)
-                else:
-                    if hasattr(middleware, "process_response"):
-                        return middleware.process_response(request, response)
+                if hasattr(middleware, "process_response"):
+                    return middleware.process_response(request, response)
                 return response
 
             return _wrapper_view

bolt/jinja/README.md bolt/templates/jinja/README.md

@@ -55,6 +55,7 @@ def view(request, *args, **kwargs):
 
     def get_request_handler(self) -> callable:
         """Return the handler for the current request method."""
+
         if not self.request.method:
             raise AttributeError("HTTP method is not set")
 

bolt/jinja/__init__.py bolt/templates/jinja/__init__.py

@@ -56,7 +56,7 @@ def form_invalid(self, form: "BaseForm") -> HttpResponse:
             **self.get_context(),
             "form": form,
         }
-        return self.get_template_response(context)
+        return self.get_template().render(context)
 
     def get_context(self) -> dict:
         """Insert the form into the context dict."""

bolt/jinja/defaults.py bolt/templates/jinja/defaults.py

@@ -10,7 +10,7 @@ class ObjectTemplateViewMixin:
 
     def get(self) -> HttpResponse:
         self.load_object()
-        return self.get_template_response()
+        return self.render_template()
 
     def load_object(self) -> None:
         try:
@@ -191,7 +191,7 @@ class ListView(TemplateView):
 
     def get(self) -> HttpResponse:
         self.objects = self.get_queryset()
-        return self.get_template_response()
+        return super().get()
 
     def get_queryset(self):  # Intentionally untyped... subclasses must override this.
         raise NotImplementedError(