Rename templates module, return Template type

Author: davegaeddert

bolt-auth/bolt/auth/forms.py

@@ -1,6 +1,7 @@
 import unicodedata
 
-from bolt import forms, jinja
+from bolt import forms
+from bolt.templates import Template
 from bolt.auth import authenticate, get_user_model, password_validation
 from bolt.auth.models import User
 from bolt.auth.tokens import default_token_generator
@@ -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

@@ -6,21 +6,18 @@
 class HTMXViewMixin:
     htmx_template_name = ""
 
-    def get_template_response(self, context=None) -> HttpResponse:
+    def get_template(self):
         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 = super().get_template()
+            return HTMXFragmentExtension.render_template_fragment(
                 template=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 super().get_template()
 
     def get_response(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-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-toolbar/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/http/response.py

@@ -717,3 +717,117 @@ def __init__(
         kwargs.setdefault("content_type", "application/json")
         data = json.dumps(data, cls=encoder, **json_dumps_params)
         super().__init__(content=data, **kwargs)
+
+
+class ContentNotRenderedError(Exception):
+    pass
+
+
+class RenderableResponse(HttpResponse):
+    non_picklable_attrs = HttpResponse.non_picklable_attrs | frozenset(
+        ["render_func", "context_data", "_post_render_callbacks", "_request"]
+    )
+
+    def __init__(
+        self,
+        render_func,
+        context=None,
+        content_type=None,
+        status=None,
+        charset=None,
+        headers=None,
+    ):
+        self.render_func = render_func
+
+        # It would seem obvious to call these next two members 'template' and
+        # 'context', but those names are reserved as part of the test Client
+        # API. To avoid the name collision, we use different names.
+        self.context_data = context
+
+        self._post_render_callbacks = []
+
+        # content argument doesn't make sense here because it will be replaced
+        # with rendered template so we always pass empty string in order to
+        # prevent errors and provide shorter signature.
+        super().__init__("", content_type, status, charset=charset, headers=headers)
+
+        # _is_rendered tracks whether the template and context has been baked
+        # into a final response.
+        # Super __init__ doesn't know any better than to set self.content to
+        # the empty string we just gave it, which wrongly sets _is_rendered
+        # True, so we initialize it to False after the call to super __init__.
+        self._is_rendered = False
+
+    def __getstate__(self):
+        """
+        Raise an exception if trying to pickle an unrendered response. Pickle
+        only rendered data, not the data used to construct the response.
+        """
+        if not self._is_rendered:
+            raise ContentNotRenderedError(
+                "The response content must be rendered before it can be pickled."
+            )
+        return super().__getstate__()
+
+    @property
+    def rendered_content(self):
+        """Return the freshly rendered content for the template and context
+        described by the TemplateResponse.
+
+        This *does not* set the final content of the response. To set the
+        response content, you must either call render(), or set the
+        content explicitly using the value of this property.
+        """
+        return self.render_func(self.context_data)
+
+    def add_post_render_callback(self, callback):
+        """Add a new post-rendering callback.
+
+        If the response has already been rendered,
+        invoke the callback immediately.
+        """
+        if self._is_rendered:
+            callback(self)
+        else:
+            self._post_render_callbacks.append(callback)
+
+    def render(self):
+        """Render (thereby finalizing) the content of the response.
+
+        If the content has already been rendered, this is a no-op.
+
+        Return the baked response instance.
+        """
+        retval = self
+        if not self._is_rendered:
+            self.content = self.rendered_content
+            for post_callback in self._post_render_callbacks:
+                newretval = post_callback(retval)
+                if newretval is not None:
+                    retval = newretval
+        return retval
+
+    @property
+    def is_rendered(self):
+        return self._is_rendered
+
+    def __iter__(self):
+        if not self._is_rendered:
+            raise ContentNotRenderedError(
+                "The response content must be rendered before it can be iterated over."
+            )
+        return super().__iter__()
+
+    @property
+    def content(self):
+        if not self._is_rendered:
+            raise ContentNotRenderedError(
+                "The response content must be rendered before it can be accessed."
+            )
+        return super().content
+
+    @content.setter
+    def content(self, value):
+        """Set the content for the response."""
+        HttpResponse.content.fset(self, value)
+        self._is_rendered = True