innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Clarified how extra_context values are evaluated and, in particular, how to 

pass in a "live" QuerySet. Thanks to Jay Parlar for pointing out the potential
for confusion.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@2931 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Malcolm Tredinnick 2006-05-17 04:01:00 +00:00
parent 93201c89b4
commit eb707d8c43
1 changed files with 88 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

132
docs/generic_views.txt
View File

@ -160,10 +160,14 @@ a date in the *future* are not included.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``allow_empty``: A boolean specifying whether to display the page if no * ``allow_empty``: A boolean specifying whether to display the page if no
objects are available. If this is ``False`` and no objects are available, objects are available. If this is ``False`` and no objects are available,
@ -225,10 +229,14 @@ with a date in the *future* are not displayed.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``allow_empty``: A boolean specifying whether to display the page if no * ``allow_empty``: A boolean specifying whether to display the page if no
objects are available. If this is ``False`` and no objects are available, objects are available. If this is ``False`` and no objects are available,
@ -287,10 +295,14 @@ date in the *future* are not displayed.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``allow_empty``: A boolean specifying whether to display the page if no * ``allow_empty``: A boolean specifying whether to display the page if no
objects are available. If this is ``False`` and no objects are available, objects are available. If this is ``False`` and no objects are available,
@ -360,10 +372,14 @@ in the *future* are not displayed.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``allow_empty``: A boolean specifying whether to display the page if no * ``allow_empty``: A boolean specifying whether to display the page if no
objects are available. If this is ``False`` and no objects are available, objects are available. If this is ``False`` and no objects are available,
@ -436,10 +452,14 @@ a 404 error, regardless of whether any objects exist for future days.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``allow_empty``: A boolean specifying whether to display the page if no * ``allow_empty``: A boolean specifying whether to display the page if no
objects are available. If this is ``False`` and no objects are available, objects are available. If this is ``False`` and no objects are available,
@ -543,10 +563,14 @@ A page representing an individual object.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``context_processors``: A list of template-context processors to apply to * ``context_processors``: A list of template-context processors to apply to
the view's template. See the `RequestContext docs`_. the view's template. See the `RequestContext docs`_.
@ -600,10 +624,14 @@ A page representing a list of objects.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``allow_empty``: A boolean specifying whether to display the page if no * ``allow_empty``: A boolean specifying whether to display the page if no
objects are available. If this is ``False`` and no objects are available, objects are available. If this is ``False`` and no objects are available,
@ -697,10 +725,14 @@ A page representing an individual object.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``context_processors``: A list of template-context processors to apply to * ``context_processors``: A list of template-context processors to apply to
the view's template. See the `RequestContext docs`_. the view's template. See the `RequestContext docs`_.
@ -764,10 +796,14 @@ automatic manipulators that come with Django models.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``context_processors``: A list of template-context processors to apply to * ``context_processors``: A list of template-context processors to apply to
the view's template. See the `RequestContext docs`_. the view's template. See the `RequestContext docs`_.
@ -843,10 +879,14 @@ object. This uses the automatic manipulators that come with Django models.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``context_processors``: A list of template-context processors to apply to * ``context_processors``: A list of template-context processors to apply to
the view's template. See the `RequestContext docs`_. the view's template. See the `RequestContext docs`_.
@ -924,10 +964,14 @@ contain a form that POSTs to the same URL.
* ``template_loader``: The template loader to use when loading the * ``template_loader``: The template loader to use when loading the
template. By default, it's ``django.template.loader``. template. By default, it's ``django.template.loader``.
* ``extra_context``: A dictionary of values to add to the template context. * ``extra_context``: A dictionary of values to add to the template
If a value in the dictionary is callable, the generic view will call it context. By default, this is an empty dictionary. If a value in the
just before rendering the template. By default, this is an empty dictionary is callable, the generic view will call it
dictionary. just before rendering the template. If it is not callable, it will be
evaluated once, at import time. Note that QuerySets are not callable, so
if you want to pass in a QuerySet in ``extra_context`` and have it
evaluated at render time, you need to wrap it in a function (that
returns the QuerySet).
* ``context_processors``: A list of template-context processors to apply to * ``context_processors``: A list of template-context processors to apply to
the view's template. See the `RequestContext docs`_. the view's template. See the `RequestContext docs`_.