summaryrefslogtreecommitdiff
path: root/docs/ref/class-based-views.txt
diff options
context:
space:
mode:
authorRussell Keith-Magee <russell@keith-magee.com>2010-12-07 13:57:01 +0000
committerRussell Keith-Magee <russell@keith-magee.com>2010-12-07 13:57:01 +0000
commite0dcd7666aec15a2348bef346b4ce683ddf376b3 (patch)
tree05cc89c8d3f3c44dfc70cfcb053ec7f819fb3536 /docs/ref/class-based-views.txt
parent22fc30be5a54d1027956a9ae668eb24d401483bc (diff)
Fixed #12815 -- Added TemplateResponse, a lazy-evaluated Response class. Thanks to Simon Willison for the original idea, and to Mikhail Korobov and Ivan Sagalaev for their assistance, including the draft patch from Mikhail.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14850 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/ref/class-based-views.txt')
-rw-r--r--docs/ref/class-based-views.txt46
1 files changed, 14 insertions, 32 deletions
diff --git a/docs/ref/class-based-views.txt b/docs/ref/class-based-views.txt
index 1b9a9f99ea..150ffff2e1 100644
--- a/docs/ref/class-based-views.txt
+++ b/docs/ref/class-based-views.txt
@@ -76,39 +76,25 @@ TemplateResponseMixin
The path to the template to use when rendering the view.
- .. method:: render_to_response(context)
+ .. attribute:: response_class
- Returns a full composed HttpResponse instance, ready to be returned to
- the user.
+ The response class to be returned by ``render_to_response`` method.
+ Default is
+ :class:`TemplateResponse <django.template.response.TemplateResponse>`.
+ The template and context of TemplateResponse instances can be
+ altered later (e.g. in
+ :ref:`template response middleware <template-response-middleware>`).
- Calls :meth:`~TemplateResponseMixin.render_template()` to build the
- content of the response, and
- :meth:`~TemplateResponseMixin.get_response()` to construct the
- :class:`~django.http.HttpResponse` object.
+ Create TemplateResponse subclass and pass set it to
+ ``template_response_class`` if you need custom template loading or
+ custom context object instantiation.
- .. method:: get_response(content, **httpresponse_kwargs)
+ .. method:: render_to_response(context, **response_kwargs)
- Constructs the :class:`~django.http.HttpResponse` object around the
- given content. If any keyword arguments are provided, they will be
- passed to the constructor of the :class:`~django.http.HttpResponse`
- instance.
+ Returns a ``self.template_response_class`` instance.
- .. method:: render_template(context)
-
- Calls :meth:`~TemplateResponseMixin.get_context_instance()` to obtain
- the :class:`Context` instance to use for rendering, and calls
- :meth:`TemplateReponseMixin.get_template()` to load the template that
- will be used to render the final content.
-
- .. method:: get_context_instance(context)
-
- Turns the data dictionary ``context`` into an actual context instance
- that can be used for rendering.
-
- By default, constructs a :class:`~django.template.RequestContext`
- instance.
-
- .. method:: get_template()
+ If any keyword arguments are provided, they will be
+ passed to the constructor of the response instance.
Calls :meth:`~TemplateResponseMixin.get_template_names()` to obtain the
list of template names that will be searched looking for an existent
@@ -123,10 +109,6 @@ TemplateResponseMixin
default implementation will return a list containing
:attr:`TemplateResponseMixin.template_name` (if it is specified).
- .. method:: load_template(names)
-
- Loads and returns a template found by searching the list of ``names``
- for a match. Uses Django's default template loader.
Single object mixins
--------------------