Example ¶

Given the following URLconf:

from django.conf.urls.defaults import *
from django.views.generic.simple import direct_to_template

urlpatterns = patterns('',
    (r'^foo/$',             direct_to_template, {'template': 'foo_index.html'}),
    (r'^foo/(?P<id>\d+)/$', direct_to_template, {'template': 'foo_detail.html'}),
)

a request to /foo/ would render the template foo_index.html , and a request to /foo/15/ would render foo_detail.html with a context variable {{ params.id }} that is set to 15 .

Required Arguments ¶

• template : The full name of a template to use.

Example ¶

This URLconf redirects from /foo/<id>/ to /bar/<id>/ :

from django.conf.urls.defaults import *
from django.views.generic.simple import redirect_to

urlpatterns = patterns('django.views.generic.simple',
    ('^foo/(?p<id>\d+)/$', redirect_to, {'url': '/bar/%(id)s/'}),
)

This example returns a “Gone” response for requests to /bar/ :

from django.views.generic.simple import redirect_to

urlpatterns = patterns('django.views.generic.simple',
    ('^bar/$', redirect_to, {'url': None}),
)

Required Arguments ¶

• url : The URL to redirect to, as a string. Or None to return a 410 (“Gone”) HTTP response.

Example ¶

Given the Author object from Chapter 5, we can use the object_list view to show a simple list of all authors given the following URLconf snippet:

from mysite.books.models import Author
from django.conf.urls.defaults import *
from django.views.generic import list_detail

author_list_info = {
    'queryset':   Author.objects.all(),
}

urlpatterns = patterns('',
    (r'authors/$', list_detail.object_list, author_list_info)
)

Required Arguments ¶

• queryset : A QuerySet of objects to list (see Table C-1).

Optional Arguments ¶

• paginate_by : An integer specifying how many objects should be displayed per page. If this is given, the view will paginate objects with paginate_by objects per page. The view will expect either a page query string parameter (via GET ) containing a zero-indexed page number, or a page variable specified in the URLconf. See the following “Notes on Pagination” section.

Additionally, this view may take any of these common arguments described in Table C-1:

• allow_empty

• context_processors

• extra_context

• mimetype

• template_loader

• template_name

• template_object_name

Template Name ¶

If template_name isn’t specified, this view will use the template <app_label>/<model_name>_list.html by default. Both the application label and the model name are derived from the queryset parameter. The application label is the name of the application that the model is defined in, and the model name is the lowercased version of the name of the model class.

In the previous example using Author.objects.all() as the queryset , the application label would be books and the model name would be author . This means the default template would be books/author_list.html .

Template Context ¶

In addition to extra_context , the template’s context will contain the following:

• object_list : The list of objects. This variable’s name depends on the template_object_name parameter, which is 'object' by default. If template_object_name is 'foo' , this variable’s name will be foo_list .

• is_paginated : A Boolean representing whether the results are paginated. Specifically, this is set to False if the number of available objects is less than or equal to paginate_by .

If the results are paginated, the context will contain these extra variables:

• results_per_page : The number of objects per page. (This is the same as the paginate_by parameter.)

• has_next : A Boolean representing whether there’s a next page.

• has_previous : A Boolean representing whether there’s a previous page.

• page : The current page number, as an integer. This is 1-based.

• next : The next page number, as an integer. If there’s no next page, this will still be an integer representing the theoretical next-page number. This is 1-based.

• previous : The previous page number, as an integer. This is 1-based.

• pages : The total number of pages, as an integer.

• hits : The total number of objects across all pages, not just this page.

Example ¶

Continuing the previous object_list example, we could add a detail view for a given author by modifying the URLconf:

from mysite.books.models import Author
from django.conf.urls.defaults import *
from django.views.generic import list_detail

author_list_info = {
    'queryset' :   Author.objects.all(),
}
author_detail_info = {
    "queryset" : Author.objects.all(),
    "template_object_name" : "author",
}

urlpatterns = patterns('',
    (r'authors/$', list_detail.object_list, author_list_info),
    (r'^authors/(?P<object_id>d+)/$', list_detail.object_detail, author_detail_info),
)

Required Arguments ¶

• queryset : A QuerySet that will be searched for the object (see Table C-1).

and either

• object_id : The value of the primary-key field for the object.

or

• slug : The slug of the given object. If you pass this field, then the slug_field argument (see the following section) is also required.

Optional Arguments ¶

• slug_field : The name of the field on the object containing the slug. This is required if you are using the slug argument, but it must be absent if you’re using the object_id argument.

• template_name_field : The name of a field on the object whose value is the template name to use. This lets you store template names in your data.

  In other words, if your object has a field 'the_template' that contains a string 'foo.html' , and you set template_name_field to 'the_template' , then the generic view for this object will use the template 'foo.html' .

  If the template named by template_name_field doesn’t exist, the one named by template_name is used instead. It’s a bit of a brain-bender, but it’s useful in some cases.

This view may also take these common arguments (see Table C-1):

• context_processors

• extra_context

• mimetype

• template_loader

• template_name

• template_object_name

Template Name ¶

If template_name and template_name_field aren’t specified, this view will use the template <app_label>/<model_name>_detail.html by default.

Template Context ¶

In addition to extra_context , the template’s context will be as follows:

• object : The object. This variable’s name depends on the template_object_name parameter, which is 'object' by default. If template_object_name is 'foo' , this variable’s name will be foo .

Example ¶

Say a typical book publisher wants a page of recently published books. Given some Book object with a publication_date field, we can use the archive_index view for this common task:

from mysite.books.models import Book
from django.conf.urls.defaults import *
from django.views.generic import date_based

book_info = {
    "queryset"   : Book.objects.all(),
    "date_field" : "publication_date"
}

urlpatterns = patterns('',
    (r'^books/$', date_based.archive_index, book_info),
)

Required Arguments ¶

• date_field : The name of the DateField or DateTimeField in the QuerySet ’s model that the date-based archive should use to determine the objects on the page.

• queryset : A QuerySet of objects for which the archive serves.

Optional Arguments ¶

• allow_future : A Boolean specifying whether to include “future” objects on this page, as described in the previous note.

• num_latest : The number of latest objects to send to the template context. By default, it’s 15.

This view may also take these common arguments (see Table C-1):

• allow_empty

• context_processors

• extra_context

• mimetype

• template_loader

• template_name

Template Name ¶

If template_name isn’t specified, this view will use the template <app_label>/<model_name>_archive.html by default.

Template Context ¶

In addition to extra_context , the template’s context will be as follows:

• date_list : A list of datetime.date objects representing all years that have objects available according to queryset . These are ordered in reverse.

  For example, if you have blog entries from 2003 through 2006, this list will contain four datetime.date objects: one for each of those years.

• latest : The num_latest objects in the system, in descending order by date_field . For example, if num_latest is 10 , then latest will be a list of the latest ten objects in queryset .

Example ¶

Extending the archive_index example from earlier, we’ll add a way to view all the books published in a given year:

from mysite.books.models import Book
from django.conf.urls.defaults import *
from django.views.generic import date_based

book_info = {
    "queryset"   : Book.objects.all(),
    "date_field" : "publication_date"
}

urlpatterns = patterns('',
    (r'^books/$', date_based.archive_index, book_info),
    (r'^books/(?P<year>d{4})/?$', date_based.archive_year, book_info),
)

Required Arguments ¶

• date_field : As for archive_index (see the previous section).

• queryset : A QuerySet of objects for which the archive serves.

• year : The four-digit year for which the archive serves (as in our example, this is usually taken from a URL parameter).

Optional Arguments ¶

• make_object_list : A Boolean specifying whether to retrieve the full list of objects for this year and pass those to the template. If True , this list of objects will be made available to the template as object_list . (The name object_list may be different; see the information about object_list in the following “Template Context” section.) By default, this is False .

• allow_future : A Boolean specifying whether to include “future” objects on this page.

This view may also take these common arguments (see Table C-1):

• allow_empty

• context_processors

• extra_context

• mimetype

• template_loader

• template_name

• template_object_name

Template Name ¶

If template_name isn’t specified, this view will use the template <app_label>/<model_name>_archive_year.html by default.

Template Context ¶

In addition to extra_context , the template’s context will be as follows:

• date_list : A list of datetime.date objects representing all months that have objects available in the given year, according to queryset , in ascending order.

• year : The given year, as a four-character string.

• object_list : If the make_object_list parameter is True , this will be set to a list of objects available for the given year, ordered by the date field. This variable’s name depends on the template_object_name parameter, which is 'object' by default. If template_object_name is 'foo' , this variable’s name will be foo_list .

  If make_object_list is False , object_list will be passed to the template as an empty list.

Example ¶

Continuing with our example, adding month views should look familiar:

urlpatterns = patterns('',
    (r'^books/$', date_based.archive_index, book_info),
    (r'^books/(?P<year>d{4})/?$', date_based.archive_year, book_info),
    (
        r'^(?P<year>d{4})/(?P<month>[a-z]{3})/$',
        date_based.archive_month,
        book_info
    ),
)

Required Arguments ¶

• year : The four-digit year for which the archive serves (a string).

• month : The month for which the archive serves, formatted according to the month_format argument.

• queryset : A QuerySet of objects for which the archive serves.

• date_field : The name of the DateField or DateTimeField in the QuerySet ’s model that the date-based archive should use to determine the objects on the page.

Optional Arguments ¶

• month_format : A format string that regulates what format the month parameter uses. This should be in the syntax accepted by Python’s time.strftime . (See Python’s strftime documentation at http://docs.python.org/library/time.html#time.strftime .) It’s set to "%b" by default, which is a three-letter month abbreviation (i.e., “jan”, “feb”, etc.). To change it to use numbers, use "%m" .

• allow_future : A Boolean specifying whether to include “future” objects on this page, as described in the previous note.

This view may also take these common arguments (see Table C-1):

• allow_empty

• context_processors

• extra_context

• mimetype

• template_loader

• template_name

• template_object_name

Template Name ¶

If template_name isn’t specified, this view will use the template <app_label>/<model_name>_archive_month.html by default.

Template Context ¶

In addition to extra_context , the template’s context will be as follows:

• month : A datetime.date object representing the given month.

• next_month : A datetime.date object representing the first day of the next month. If the next month is in the future, this will be None .

• previous_month : A datetime.date object representing the first day of the previous month. Unlike next_month , this will never be None .

• object_list : A list of objects available for the given month. This variable’s name depends on the template_object_name parameter, which is 'object' by default. If template_object_name is 'foo' , this variable’s name will be foo_list .

Example ¶

urlpatterns = patterns('',
    # ...
    (
        r'^(?P<year>d{4})/(?P<week>d{2})/$',
        date_based.archive_week,
        book_info
    ),
)

Required Arguments ¶

• year : The four-digit year for which the archive serves (a string).

• week : The week of the year for which the archive serves (a string).

• queryset : A QuerySet of objects for which the archive serves.

• date_field : The name of the DateField or DateTimeField in the QuerySet ’s model that the date-based archive should use to determine the objects on the page.

Optional Arguments ¶

• allow_future : A Boolean specifying whether to include “future” objects on this page, as described in the previous note.

This view may also take these common arguments (see Table C-1):

• allow_empty

• context_processors

• extra_context

• mimetype

• template_loader

• template_name

• template_object_name

Template Name ¶

If template_name isn’t specified, this view will use the template <app_label>/<model_name>_archive_week.html by default.

Template Context ¶

In addition to extra_context , the template’s context will be as follows:

• week : A datetime.date object representing the first day of the given week.

• object_list : A list of objects available for the given week. This variable’s name depends on the template_object_name parameter, which is 'object' by default. If template_object_name is 'foo' , this variable’s name will be foo_list .

Example ¶

urlpatterns = patterns('',
    # ...
    (
        r'^(?P<year>d{4})/(?P<month>[a-z]{3})/(?P<day>d{2})/$',
        date_based.archive_day,
        book_info
    ),
)

Required Arguments ¶

• year : The four-digit year for which the archive serves (a string).

• month : The month for which the archive serves, formatted according to the month_format argument.

• day : The day for which the archive serves, formatted according to the day_format argument.

• queryset : A QuerySet of objects for which the archive serves.

• date_field : The name of the DateField or DateTimeField in the QuerySet ’s model that the date-based archive should use to determine the objects on the page.

Optional Arguments ¶

• month_format : A format string that regulates what format the month parameter uses. See the detailed explanation in the “Month Archives” section, above.

• day_format : Like month_format , but for the day parameter. It defaults to "%d" (the day of the month as a decimal number, 01-31).

• allow_future : A Boolean specifying whether to include “future” objects on this page, as described in the previous note.

This view may also take these common arguments (see Table C-1):

• allow_empty

• context_processors

• extra_context

• mimetype

• template_loader

• template_name

• template_object_name

Template Name ¶

If template_name isn’t specified, this view will use the template <app_label>/<model_name>_archive_day.html by default.

Template Context ¶

In addition to extra_context , the template’s context will be as follows:

• day : A datetime.date object representing the given day.

• next_day : A datetime.date object representing the next day. If the next day is in the future, this will be None .

• previous_day : A datetime.date object representing the previous day. Unlike next_day , this will never be None .

• object_list : A list of objects available for the given day. This variable’s name depends on the template_object_name parameter, which is 'object' by default. If template_object_name is 'foo' , this variable’s name will be foo_list .

Example ¶

urlpatterns = patterns('',
    # ...
    (r'^books/today/$', date_based.archive_today, book_info),
)

Example ¶

This one differs (slightly) from all the other date-based examples in that we need to provide either an object ID or a slug so that Django can look up the object in question.

Since the object we’re using doesn’t have a slug field, we’ll use ID-based URLs. It’s considered a best practice to use a slug field, but in the interest of simplicity we’ll let it go.

urlpatterns = patterns('',
    # ...
    (
        r'^(?P<year>d{4})/(?P<month>[a-z]{3})/(?P<day>d{2})/(?P<object_id>[w-]+)/$',
        date_based.object_detail,
        book_info
    ),
)

Required Arguments ¶

• year : The object’s four-digit year (a string).

• month : The object’s month, formatted according to the month_format argument.

• day : The object’s day, formatted according to the day_format argument.

• queryset : A QuerySet that contains the object.

• date_field : The name of the DateField or DateTimeField in the QuerySet ’s model that the generic view should use to look up the object according to year , month , and day .

You’ll also need either:

• object_id : The value of the primary-key field for the object.

or:

• slug : The slug of the given object. If you pass this field, then the slug_field argument (described in the following section) is also required.

Optional Arguments ¶

• allow_future : A Boolean specifying whether to include “future” objects on this page, as described in the previous note.

• day_format : Like month_format , but for the day parameter. It defaults to "%d" (the day of the month as a decimal number, 01-31).

• month_format : A format string that regulates what format the month parameter uses. See the detailed explanation in the “Month Archives” section, above.

• slug_field : The name of the field on the object containing the slug. This is required if you are using the slug argument, but it must be absent if you’re using the object_id argument.

• template_name_field : The name of a field on the object whose value is the template name to use. This lets you store template names in the data. In other words, if your object has a field 'the_template' that contains a string 'foo.html' , and you set template_name_field to 'the_template' , then the generic view for this object will use the template 'foo.html' .

This view may also take these common arguments (see Table C-1):

• context_processors

• extra_context

• mimetype

• template_loader

• template_name

• template_object_name

Template Name ¶

If template_name and template_name_field aren’t specified, this view will use the template <app_label>/<model_name>_detail.html by default.

Template Context ¶

In addition to extra_context , the template’s context will be as follows:

• object : The object. This variable’s name depends on the template_object_name parameter, which is 'object' by default. If template_object_name is 'foo' , this variable’s name will be foo .