test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed #14835 -- Corrected a lack of indentation in the reST markup for docs/ref/contrib/admin/index.txt and reflowed the text accordingly. Thanks to cogat for the report. 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@14830 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Gabriel Hurley 2010-12-05 04:52:31 +00:00
parent 4a1f2129d0
commit 01f2081bb6
1 changed files with 626 additions and 604 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

454
docs/ref/contrib/admin/index.txt
View File

@ -62,8 +62,9 @@ Other topics
.. class:: ModelAdmin
The ``ModelAdmin`` class is the representation of a model in the admin
interface. These are stored in a file named ``admin.py`` in your application.
Let's take a look at a very simple example of the ``ModelAdmin``::
interface. These are stored in a file named ``admin.py`` in your
application. Let's take a look at a very simple example of
the ``ModelAdmin``::
from django.contrib import admin
from myproject.myapp.models import Author
@ -98,8 +99,8 @@ subclass::
.. attribute:: ModelAdmin.date_hierarchy
Set ``date_hierarchy`` to the name of a ``DateField`` or ``DateTimeField`` in
your model, and the change list page will include a date-based drilldown
Set ``date_hierarchy`` to the name of a ``DateField`` or ``DateTimeField``
in your model, and the change list page will include a date-based drilldown
navigation by that field.
Example::
@ -108,10 +109,10 @@ Example::
.. attribute:: ModelAdmin.form
By default a ``ModelForm`` is dynamically created for your model. It is used
to create the form presented on both the add/change pages. You can easily
provide your own ``ModelForm`` to override any default form behavior on the
add/change pages.
By default a ``ModelForm`` is dynamically created for your model. It is
used to create the form presented on both the add/change pages. You can
easily provide your own ``ModelForm`` to override any default form behavior
on the add/change pages.
For an example see the section `Adding custom validation to the admin`_.
@ -120,15 +121,16 @@ For an example see the section `Adding custom validation to the admin`_.
Set ``fieldsets`` to control the layout of admin "add" and "change" pages.
``fieldsets`` is a list of two-tuples, in which each two-tuple represents a
``<fieldset>`` on the admin form page. (A ``<fieldset>`` is a "section" of the
form.)
``<fieldset>`` on the admin form page. (A ``<fieldset>`` is a "section" of
the form.)
The two-tuples are in the format ``(name, field_options)``, where ``name`` is a
string representing the title of the fieldset and ``field_options`` is a
dictionary of information about the fieldset, including a list of fields to be
displayed in it.
The two-tuples are in the format ``(name, field_options)``, where ``name``
is a string representing the title of the fieldset and ``field_options`` is
a dictionary of information about the fieldset, including a list of fields
to be displayed in it.
A full example, taken from the ``django.contrib.flatpages.FlatPage`` model::
A full example, taken from the :class:`django.contrib.flatpages.FlatPage`
model::
class FlatPageAdmin(admin.ModelAdmin):
fieldsets = (
@ -146,8 +148,8 @@ This results in an admin page that looks like:
.. image:: _images/flatfiles_admin.png
If ``fieldsets`` isn't given, Django will default to displaying each field
that isn't an ``AutoField`` and has ``editable=True``, in a single fieldset,
in the same order as the fields are defined in the model.
that isn't an ``AutoField`` and has ``editable=True``, in a single
fieldset, in the same order as the fields are defined in the model.
The ``field_options`` dictionary can have the following keys:
@ -162,8 +164,8 @@ The ``field_options`` dictionary can have the following keys:
}
To display multiple fields on the same line, wrap those fields in
their own tuple. In this example, the ``first_name`` and ``last_name``
fields will display on the same line::
their own tuple. In this example, the ``first_name`` and
``last_name`` fields will display on the same line::
{
'fields': (('first_name', 'last_name'), 'address', 'city', 'state'),
@ -184,8 +186,8 @@ The ``field_options`` dictionary can have the following keys:
}
Two useful classes defined by the default admin site stylesheet are
``collapse`` and ``wide``. Fieldsets with the ``collapse`` style will
be initially collapsed in the admin and replaced with a small
``collapse`` and ``wide``. Fieldsets with the ``collapse`` style
will be initially collapsed in the admin and replaced with a small
"click to expand" link. Fieldsets with the ``wide`` style will be
given extra horizontal space.
@ -225,8 +227,8 @@ to be displayed as read-only.
.. attribute:: ModelAdmin.exclude
This attribute, if given, should be a list of field names to exclude from the
form.
This attribute, if given, should be a list of field names to exclude from
the form.
For example, let's consider the following model::
@ -236,7 +238,8 @@ For example, let's consider the following model::
birth_date = models.DateField(blank=True, null=True)
If you want a form for the ``Author`` model that includes only the ``name``
and ``title`` fields, you would specify ``fields`` or ``exclude`` like this::
and ``title`` fields, you would specify ``fields`` or ``exclude`` like
this::
class AuthorAdmin(admin.ModelAdmin):
fields = ('name', 'title')
@ -245,15 +248,15 @@ and ``title`` fields, you would specify ``fields`` or ``exclude`` like this::
exclude = ('birth_date',)
Since the Author model only has three fields, ``name``, ``title``, and
``birth_date``, the forms resulting from the above declarations will contain
exactly the same fields.
``birth_date``, the forms resulting from the above declarations will
contain exactly the same fields.
.. attribute:: ModelAdmin.filter_horizontal
Use a nifty unobtrusive JavaScript "filter" interface instead of the
usability-challenged ``<select multiple>`` in the admin form. The value is a
list of fields that should be displayed as a horizontal filter interface. See
``filter_vertical`` to use a vertical interface.
usability-challenged ``<select multiple>`` in the admin form. The value is
a list of fields that should be displayed as a horizontal filter interface.
See ``filter_vertical`` to use a vertical interface.
.. attribute:: ModelAdmin.filter_vertical
@ -262,15 +265,15 @@ interface.
.. attribute:: ModelAdmin.list_display
Set ``list_display`` to control which fields are displayed on the change list
page of the admin.
Set ``list_display`` to control which fields are displayed on the change
list page of the admin.
Example::
list_display = ('first_name', 'last_name')
If you don't set ``list_display``, the admin site will display a single column
that displays the ``__unicode__()`` representation of each object.
If you don't set ``list_display``, the admin site will display a single
column that displays the ``__unicode__()`` representation of each object.
You have four possible values that can be used in ``list_display``:
@ -289,8 +292,8 @@ You have four possible values that can be used in ``list_display``:
class PersonAdmin(admin.ModelAdmin):
list_display = (upper_case_name,)
* A string representing an attribute on the ``ModelAdmin``. This behaves
same as the callable. For example::
* A string representing an attribute on the ``ModelAdmin``. This
behaves same as the callable. For example::
class PersonAdmin(admin.ModelAdmin):
list_display = ('upper_case_name',)
@ -319,19 +322,20 @@ A few special cases to note about ``list_display``:
* If the field is a ``ForeignKey``, Django will display the
``__unicode__()`` of the related object.
* ``ManyToManyField`` fields aren't supported, because that would entail
executing a separate SQL statement for each row in the table. If you
want to do this nonetheless, give your model a custom method, and add
that method's name to ``list_display``. (See below for more on custom
methods in ``list_display``.)
* ``ManyToManyField`` fields aren't supported, because that would
entail executing a separate SQL statement for each row in the table.
If you want to do this nonetheless, give your model a custom method,
and add that method's name to ``list_display``. (See below for more
on custom methods in ``list_display``.)
* If the field is a ``BooleanField`` or ``NullBooleanField``, Django will
display a pretty "on" or "off" icon instead of ``True`` or ``False``.
* If the field is a ``BooleanField`` or ``NullBooleanField``, Django
will display a pretty "on" or "off" icon instead of ``True`` or
``False``.
* If the string given is a method of the model, ``ModelAdmin`` or a
callable, Django will HTML-escape the output by default. If you'd rather
not escape the output of the method, give the method an ``allow_tags``
attribute whose value is ``True``.
callable, Django will HTML-escape the output by default. If you'd
rather not escape the output of the method, give the method an
``allow_tags`` attribute whose value is ``True``.
Here's a full example model::
@ -348,9 +352,9 @@ A few special cases to note about ``list_display``:
list_display = ('first_name', 'last_name', 'colored_name')
* If the string given is a method of the model, ``ModelAdmin`` or a
callable that returns True or False Django will display a pretty "on" or
"off" icon if you give the method a ``boolean`` attribute whose value is
``True``.
callable that returns True or False Django will display a pretty
"on" or "off" icon if you give the method a ``boolean`` attribute
whose value is ``True``.
Here's a full example model::
@ -367,18 +371,18 @@ A few special cases to note about ``list_display``:
* The ``__str__()`` and ``__unicode__()`` methods are just as valid in
``list_display`` as any other model method, so it's perfectly OK to do
this::
``list_display`` as any other model method, so it's perfectly OK to
do this::
list_display = ('__unicode__', 'some_other_field')
* Usually, elements of ``list_display`` that aren't actual database fields
can't be used in sorting (because Django does all the sorting at the
database level).
* Usually, elements of ``list_display`` that aren't actual database
fields can't be used in sorting (because Django does all the sorting
at the database level).
However, if an element of ``list_display`` represents a certain database
field, you can indicate this fact by setting the ``admin_order_field``
attribute of the item.
However, if an element of ``list_display`` represents a certain
database field, you can indicate this fact by setting the
``admin_order_field`` attribute of the item.
For example::
@ -399,22 +403,22 @@ A few special cases to note about ``list_display``:
.. attribute:: ModelAdmin.list_display_links
Set ``list_display_links`` to control which fields in ``list_display`` should
be linked to the "change" page for an object.
Set ``list_display_links`` to control which fields in ``list_display``
should be linked to the "change" page for an object.
By default, the change list page will link the first column -- the first field
specified in ``list_display`` -- to the change page for each item. But
``list_display_links`` lets you change which columns are linked. Set
``list_display_links`` to a list or tuple of field names (in the same format as
``list_display``) to link.
By default, the change list page will link the first column -- the first
field specified in ``list_display`` -- to the change page for each item.
But ``list_display_links`` lets you change which columns are linked. Set
``list_display_links`` to a list or tuple of field names (in the same
format as ``list_display``) to link.
``list_display_links`` can specify one or many field names. As long as the
field names appear in ``list_display``, Django doesn't care how many (or how
few) fields are linked. The only requirement is: If you want to use
field names appear in ``list_display``, Django doesn't care how many (or
how few) fields are linked. The only requirement is: If you want to use
``list_display_links``, you must define ``list_display``.
In this example, the ``first_name`` and ``last_name`` fields will be linked on
the change list page::
In this example, the ``first_name`` and ``last_name`` fields will be
linked on the change list page::
class PersonAdmin(admin.ModelAdmin):
list_display = ('first_name', 'last_name', 'birthday')
@ -426,33 +430,34 @@ the change list page::
.. versionadded:: 1.1
Set ``list_editable`` to a list of field names on the model which will allow
editing on the change list page. That is, fields listed in ``list_editable``
will be displayed as form widgets on the change list page, allowing users to
edit and save multiple rows at once.
Set ``list_editable`` to a list of field names on the model which will
allow editing on the change list page. That is, fields listed in
``list_editable`` will be displayed as form widgets on the change list
page, allowing users to edit and save multiple rows at once.
.. note::
``list_editable`` interacts with a couple of other options in particular
ways; you should note the following rules:
``list_editable`` interacts with a couple of other options in
particular ways; you should note the following rules:
* Any field in ``list_editable`` must also be in ``list_display``. You
can't edit a field that's not displayed!
* Any field in ``list_editable`` must also be in ``list_display``.
You can't edit a field that's not displayed!
* The same field can't be listed in both ``list_editable`` and
``list_display_links`` -- a field can't be both a form and a link.
``list_display_links`` -- a field can't be both a form and
a link.
You'll get a validation error if either of these rules are broken.
.. attribute:: ModelAdmin.list_filter
Set ``list_filter`` to activate filters in the right sidebar of the change list
page of the admin. This should be a list of field names, and each specified
field should be either a ``BooleanField``, ``CharField``, ``DateField``,
``DateTimeField``, ``IntegerField`` or ``ForeignKey``.
Set ``list_filter`` to activate filters in the right sidebar of the change
list page of the admin. This should be a list of field names, and each
specified field should be either a ``BooleanField``, ``CharField``,
``DateField``, ``DateTimeField``, ``IntegerField`` or ``ForeignKey``.
This example, taken from the ``django.contrib.auth.models.User`` model, shows
how both ``list_display`` and ``list_filter`` work::
This example, taken from the ``django.contrib.auth.models.User`` model,
shows how both ``list_display`` and ``list_filter`` work::
class UserAdmin(admin.ModelAdmin):
list_display = ('username', 'email', 'first_name', 'last_name', 'is_staff')
@ -471,33 +476,34 @@ The above code results in an admin change list page that looks like this:
.. attribute:: ModelAdmin.list_per_page
Set ``list_per_page`` to control how many items appear on each paginated admin
change list page. By default, this is set to ``100``.
Set ``list_per_page`` to control how many items appear on each paginated
admin change list page. By default, this is set to ``100``.
.. attribute:: ModelAdmin.list_select_related
Set ``list_select_related`` to tell Django to use
:meth:`~django.db.models.QuerySet.select_related` in retrieving the list of
objects on the admin change list page. This can save you a bunch of database
queries.
objects on the admin change list page. This can save you a bunch of
database queries.
The value should be either ``True`` or ``False``. Default is ``False``.
Note that Django will use :meth:`~django.db.models.QuerySet.select_related`,
regardless of this setting, if one of the ``list_display`` fields is a
regardless of this setting if one of the ``list_display`` fields is a
``ForeignKey``.
.. attribute:: ModelAdmin.inlines
See ``InlineModelAdmin`` objects below.
See :class:`InlineModelAdmin` objects below.
.. attribute:: ModelAdmin.ordering
Set ``ordering`` to specify how objects on the admin change list page should be
ordered. This should be a list or tuple in the same format as a model's
``ordering`` parameter.
Set ``ordering`` to specify how objects on the admin change list page
should be ordered. This should be a list or tuple in the same format as a
model's ``ordering`` parameter.
If this isn't provided, the Django admin will use the model's default ordering.
If this isn't provided, the Django admin will use the model's default
ordering.
.. admonition:: Note
@ -506,28 +512,28 @@ If this isn't provided, the Django admin will use the model's default ordering.
.. attribute:: ModelAdmin.prepopulated_fields
Set ``prepopulated_fields`` to a dictionary mapping field names to the fields
it should prepopulate from::
Set ``prepopulated_fields`` to a dictionary mapping field names to the
fields it should prepopulate from::
class ArticleAdmin(admin.ModelAdmin):
prepopulated_fields = {"slug": ("title",)}
When set, the given fields will use a bit of JavaScript to populate from the
fields assigned. The main use for this functionality is to automatically
generate the value for ``SlugField`` fields from one or more other fields. The
generated value is produced by concatenating the values of the source fields,
and then by transforming that result into a valid slug (e.g. substituting
dashes for spaces).
When set, the given fields will use a bit of JavaScript to populate from
the fields assigned. The main use for this functionality is to
automatically generate the value for ``SlugField`` fields from one or more
other fields. The generated value is produced by concatenating the values
of the source fields, and then by transforming that result into a valid
slug (e.g. substituting dashes for spaces).
``prepopulated_fields`` doesn't accept ``DateTimeField``, ``ForeignKey``, nor
``ManyToManyField`` fields.
``prepopulated_fields`` doesn't accept ``DateTimeField``, ``ForeignKey``,
nor ``ManyToManyField`` fields.
.. attribute:: ModelAdmin.radio_fields
By default, Django's admin uses a select-box interface (<select>) for
fields that are ``ForeignKey`` or have ``choices`` set. If a field is present
in ``radio_fields``, Django will use a radio-button interface instead.
Assuming ``group`` is a ``ForeignKey`` on the ``Person`` model::
fields that are ``ForeignKey`` or have ``choices`` set. If a field is
present in ``radio_fields``, Django will use a radio-button interface
instead. Assuming ``group`` is a ``ForeignKey`` on the ``Person`` model::
class PersonAdmin(admin.ModelAdmin):
radio_fields = {"group": admin.VERTICAL}
@ -546,7 +552,8 @@ overhead of having to select all the related instances to display in the
drop-down.
``raw_id_fields`` is a list of fields you would like to change
into a ``Input`` widget for either a ``ForeignKey`` or ``ManyToManyField``::
into an ``Input`` widget for either a ``ForeignKey`` or
``ManyToManyField``::
class ArticleAdmin(admin.ModelAdmin):
raw_id_fields = ("newspaper",)
@ -555,24 +562,24 @@ into a ``Input`` widget for either a ``ForeignKey`` or ``ManyToManyField``::
.. versionadded:: 1.2
By default the admin shows all fields as editable. Any fields in this option
(which should be a ``list`` or ``tuple``) will display its data as-is and
non-editable. This option behaves nearly identical to :attr:`ModelAdmin.list_display`.
Usage is the same, however, when you specify :attr:`ModelAdmin.fields` or
:attr:`ModelAdmin.fieldsets` the read-only fields must be present to be shown
(they are ignored otherwise).
By default the admin shows all fields as editable. Any fields in this
option (which should be a ``list`` or ``tuple``) will display its data
as-is and non-editable. This option behaves nearly identical to
:attr:`ModelAdmin.list_display`. Usage is the same, however, when you
specify :attr:`ModelAdmin.fields` or :attr:`ModelAdmin.fieldsets` the
read-only fields must be present to be shown (they are ignored otherwise).
If ``readonly_fields`` is used without defining explicit ordering through
:attr:`ModelAdmin.fields` or :attr:`ModelAdmin.fieldsets` they will be added
last after all editable fields.
:attr:`ModelAdmin.fields` or :attr:`ModelAdmin.fieldsets` they will be
added last after all editable fields.
.. attribute:: ModelAdmin.save_as
Set ``save_as`` to enable a "save as" feature on admin change forms.
Normally, objects have three save options: "Save", "Save and continue editing"
and "Save and add another". If ``save_as`` is ``True``, "Save and add another"
will be replaced by a "Save as" button.
Normally, objects have three save options: "Save", "Save and continue
editing" and "Save and add another". If ``save_as`` is ``True``, "Save
and add another" will be replaced by a "Save as" button.
"Save as" means the object will be saved as a new object (with a new ID),
rather than the old object.
@ -584,8 +591,9 @@ By default, ``save_as`` is set to ``False``.
Set ``save_on_top`` to add save buttons across the top of your admin change
forms.
Normally, the save buttons appear only at the bottom of the forms. If you set
``save_on_top``, the buttons will appear both on the top and the bottom.
Normally, the save buttons appear only at the bottom of the forms. If you
set ``save_on_top``, the buttons will appear both on the top and the
bottom.
By default, ``save_on_top`` is set to ``False``.
@ -601,17 +609,18 @@ These fields should be some kind of text field, such as ``CharField`` or
search_fields = ['foreign_key__related_fieldname']
For example, if you have a blog entry with an author, the following definition
would enable search blog entries by the email address of the author::
For example, if you have a blog entry with an author, the following
definition would enable search blog entries by the email address of the
author::
search_fields = ['user__email']
When somebody does a search in the admin search box, Django splits the search
query into words and returns all objects that contain each of the words, case
insensitive, where each word must be in at least one of ``search_fields``. For
example, if ``search_fields`` is set to ``['first_name', 'last_name']`` and a
user searches for ``john lennon``, Django will do the equivalent of this SQL
``WHERE`` clause::
When somebody does a search in the admin search box, Django splits the
search query into words and returns all objects that contain each of the
words, case insensitive, where each word must be in at least one of
``search_fields``. For example, if ``search_fields`` is set to
``['first_name', 'last_name']`` and a user searches for ``john lennon``,
Django will do the equivalent of this SQL ``WHERE`` clause::
WHERE (first_name ILIKE '%john%' OR last_name ILIKE '%john%')
AND (first_name ILIKE '%lennon%' OR last_name ILIKE '%lennon%')
@ -620,19 +629,19 @@ For faster and/or more restrictive searches, prefix the field name
with an operator:
``^``
Matches the beginning of the field. For example, if ``search_fields`` is
set to ``['^first_name', '^last_name']`` and a user searches for
Matches the beginning of the field. For example, if ``search_fields``
is set to ``['^first_name', '^last_name']`` and a user searches for
``john lennon``, Django will do the equivalent of this SQL ``WHERE``
clause::
WHERE (first_name ILIKE 'john%' OR last_name ILIKE 'john%')
AND (first_name ILIKE 'lennon%' OR last_name ILIKE 'lennon%')
This query is more efficient than the normal ``'%john%'`` query, because
the database only needs to check the beginning of a column's data, rather
than seeking through the entire column's data. Plus, if the column has an
index on it, some databases may be able to use the index for this query,
even though it's a ``LIKE`` query.
This query is more efficient than the normal ``'%john%'`` query,
because the database only needs to check the beginning of a column's
data, rather than seeking through the entire column's data. Plus, if
the column has an index on it, some databases may be able to use the
index for this query, even though it's a ``LIKE`` query.
``=``
Matches exactly, case-insensitive. For example, if
@ -643,13 +652,13 @@ with an operator:
WHERE (first_name ILIKE 'john' OR last_name ILIKE 'john')
AND (first_name ILIKE 'lennon' OR last_name ILIKE 'lennon')
Note that the query input is split by spaces, so, following this example,
it's currently not possible to search for all records in which
Note that the query input is split by spaces, so, following this
example, it's currently not possible to search for all records in which
``first_name`` is exactly ``'john winston'`` (containing a space).
``@``
Performs a full-text match. This is like the default search method but uses
an index. Currently this is only available for MySQL.
Performs a full-text match. This is like the default search method but
uses an index. Currently this is only available for MySQL.
.. attribute:: ModelAdmin.formfield_overrides
@ -660,11 +669,11 @@ This provides a quick-and-dirty way to override some of the
``formfield_overrides`` is a dictionary mapping a field class to a dict of
arguments to pass to the field at construction time.
Since that's a bit abstract, let's look at a concrete example. The most common
use of ``formfield_overrides`` is to add a custom widget for a certain type of
field. So, imagine we've written a ``RichTextEditorWidget`` that we'd like to
use for large text fields instead of the default ``<textarea>``. Here's how we'd
do that::
Since that's a bit abstract, let's look at a concrete example. The most
common use of ``formfield_overrides`` is to add a custom widget for a
certain type of field. So, imagine we've written a ``RichTextEditorWidget``
that we'd like to use for large text fields instead of the default
``<textarea>``. Here's how we'd do that::
from django.db import models
from django.contrib import admin
@ -678,20 +687,22 @@ do that::
models.TextField: {'widget': RichTextEditorWidget},
}
Note that the key in the dictionary is the actual field class, *not* a string.
The value is another dictionary; these arguments will be passed to
:meth:`~django.forms.Field.__init__`. See :doc:`/ref/forms/api` for details.
Note that the key in the dictionary is the actual field class, *not* a
string. The value is another dictionary; these arguments will be passed to
:meth:`~django.forms.Field.__init__`. See :doc:`/ref/forms/api` for
details.
.. warning::
If you want to use a custom widget with a relation field (i.e.
:class:`~django.db.models.ForeignKey` or
:class:`~django.db.models.ManyToManyField`), make sure you haven't included
that field's name in ``raw_id_fields`` or ``radio_fields``.
:class:`~django.db.models.ManyToManyField`), make sure you haven't
included that field's name in ``raw_id_fields`` or ``radio_fields``.
``formfield_overrides`` won't let you change the widget on relation fields
that have ``raw_id_fields`` or ``radio_fields`` set. That's because
``raw_id_fields`` and ``radio_fields`` imply custom widgets of their own.
``formfield_overrides`` won't let you change the widget on relation
fields that have ``raw_id_fields`` or ``radio_fields`` set. That's
because ``raw_id_fields`` and ``radio_fields`` imply custom widgets of
their own.
.. attribute:: ModelAdmin.actions
@ -771,8 +782,8 @@ templates used by the :class:`ModelAdmin` views:
.. method:: ModelAdmin.save_model(self, request, obj, form, change)
The ``save_model`` method is given the ``HttpRequest``, a model instance,
a ``ModelForm`` instance and a boolean value based on whether it is adding or
changing the object. Here you can do any pre- or post-save operations.
a ``ModelForm`` instance and a boolean value based on whether it is adding
or changing the object. Here you can do any pre- or post-save operations.
For example to attach ``request.user`` to the object prior to saving::
@ -785,8 +796,8 @@ For example to attach ``request.user`` to the object prior to saving::
.. versionadded:: 1.3
The ``delete_model`` method is given the ``HttpRequest`` and a model instance.
Use this method to do pre- or post-delete operations.
The ``delete_model`` method is given the ``HttpRequest`` and a model
instance. Use this method to do pre- or post-delete operations.
.. method:: ModelAdmin.save_formset(self, request, form, formset, change)
@ -810,17 +821,17 @@ model instance::
.. versionadded:: 1.2
The ``get_readonly_fields`` method is given the ``HttpRequest`` and the
``obj`` being edited (or ``None`` on an add form) and is expected to return a
``list`` or ``tuple`` of field names that will be displayed as read-only, as
described above in the :attr:`ModelAdmin.readonly_fields` section.
``obj`` being edited (or ``None`` on an add form) and is expected to return
a ``list`` or ``tuple`` of field names that will be displayed as read-only,
as described above in the :attr:`ModelAdmin.readonly_fields` section.
.. method:: ModelAdmin.get_urls(self)
.. versionadded:: 1.1
The ``get_urls`` method on a ``ModelAdmin`` returns the URLs to be used for
that ModelAdmin in the same way as a URLconf. Therefore you can extend them as
documented in :doc:`/topics/http/urls`::
that ModelAdmin in the same way as a URLconf. Therefore you can extend
them as documented in :doc:`/topics/http/urls`::
class MyModelAdmin(admin.ModelAdmin):
def get_urls(self):
@ -834,22 +845,23 @@ documented in :doc:`/topics/http/urls`::
Notice that the custom patterns are included *before* the regular admin
URLs: the admin URL patterns are very permissive and will match nearly
anything, so you'll usually want to prepend your custom URLs to the built-in
ones.
anything, so you'll usually want to prepend your custom URLs to the
built-in ones.
However, the ``self.my_view`` function registered above suffers from two
problems:
* It will *not* perform any permission checks, so it will be accessible to
the general public.
* It will *not* provide any header details to prevent caching. This means if
the page retrieves data from the database, and caching middleware is
* It will *not* perform any permission checks, so it will be accessible
to the general public.
* It will *not* provide any header details to prevent caching. This means
if the page retrieves data from the database, and caching middleware is
active, the page could show outdated information.
Since this is usually not what you want, Django provides a convenience wrapper
to check permissions and mark the view as non-cacheable. This wrapper is
:meth:`AdminSite.admin_view` (i.e. ``self.admin_site.admin_view`` inside a
``ModelAdmin`` instance); use it like so::
Since this is usually not what you want, Django provides a convenience
wrapper to check permissions and mark the view as non-cacheable. This
wrapper is :meth:`AdminSite.admin_view` (i.e.
``self.admin_site.admin_view`` inside a ``ModelAdmin`` instance); use it
like so::
class MyModelAdmin(admin.ModelAdmin):
def get_urls(self):
@ -863,12 +875,13 @@ Notice the wrapped view in the fifth line above::
(r'^my_view/$', self.admin_site.admin_view(self.my_view))
This wrapping will protect ``self.my_view`` from unauthorized access and will
apply the ``django.views.decorators.cache.never_cache`` decorator to make sure
it is not cached if the cache middleware is active.
This wrapping will protect ``self.my_view`` from unauthorized access and
will apply the ``django.views.decorators.cache.never_cache`` decorator to
make sure it is not cached if the cache middleware is active.
If the page is cacheable, but you still want the permission check to be performed,
you can pass a ``cacheable=True`` argument to :meth:`AdminSite.admin_view`::
If the page is cacheable, but you still want the permission check to be
performed, you can pass a ``cacheable=True`` argument to
:meth:`AdminSite.admin_view`::
(r'^my_view/$', self.admin_site.admin_view(self.my_view, cacheable=True))
@ -886,18 +899,19 @@ return a subset of objects for this foreign key field based on the user::
kwargs["queryset"] = Car.objects.filter(owner=request.user)
return super(MyModelAdmin, self).formfield_for_foreignkey(db_field, request, **kwargs)
This uses the ``HttpRequest`` instance to filter the ``Car`` foreign key field
to only display the cars owned by the ``User`` instance.
This uses the ``HttpRequest`` instance to filter the ``Car`` foreign key
field to only display the cars owned by the ``User`` instance.
.. method:: ModelAdmin.formfield_for_manytomany(self, db_field, request, **kwargs)
.. versionadded:: 1.1
Like the ``formfield_for_foreignkey`` method, the ``formfield_for_manytomany``
method can be overridden to change the default formfield for a many to many
field. For example, if an owner can own multiple cars and cars can belong
to multiple owners -- a many to many relationship -- you could filter the
``Car`` foreign key field to only display the cars owned by the ``User``::
Like the ``formfield_for_foreignkey`` method, the
``formfield_for_manytomany`` method can be overridden to change the
default formfield for a many to many field. For example, if an owner can
own multiple cars and cars can belong to multiple owners -- a many to
many relationship -- you could filter the ``Car`` foreign key field to
only display the cars owned by the ``User``::
class MyModelAdmin(admin.ModelAdmin):
def formfield_for_manytomany(self, db_field, request, **kwargs):
@ -932,16 +946,18 @@ Django view for the model instance edition page. See note below.
.. method:: ModelAdmin.changelist_view(self, request, extra_context=None)
Django view for the model instances change list/actions page. See note below.
Django view for the model instances change list/actions page. See note
below.
.. method:: ModelAdmin.delete_view(self, request, object_id, extra_context=None)
Django view for the model instance(s) deletion confirmation page. See note below.
Django view for the model instance(s) deletion confirmation page. See note
below.
.. method:: ModelAdmin.history_view(self, request, object_id, extra_context=None)
Django view for the page that shows the modification history for a given model
instance.
Django view for the page that shows the modification history for a given
model instance.
Unlike the hook-type ``ModelAdmin`` methods detailed in the previous section,
these five methods are in reality designed to be invoked as Django views from
@ -997,9 +1013,9 @@ JavaScript without including a second copy, you can use the
Adding custom validation to the admin
-------------------------------------
Adding custom validation of data in the admin is quite easy. The automatic admin
interface reuses :mod:`django.forms`, and the ``ModelAdmin`` class gives you
the ability define your own form::
Adding custom validation of data in the admin is quite easy. The automatic
admin interface reuses :mod:`django.forms`, and the ``ModelAdmin`` class gives
you the ability define your own form::
class ArticleAdmin(admin.ModelAdmin):
form = MyArticleAdminForm
@ -1016,8 +1032,8 @@ any field::
# do something that validates your data
return self.cleaned_data["name"]
It is important you use a ``ModelForm`` here otherwise things can break. See the
:doc:`forms </ref/forms/index>` documentation on :doc:`custom validation
It is important you use a ``ModelForm`` here otherwise things can break. See
the :doc:`forms </ref/forms/index>` documentation on :doc:`custom validation
</ref/forms/validation>` and, more specifically, the
:ref:`model form validation notes <overriding-modelform-clean-method>` for more
information.
@ -1055,7 +1071,8 @@ Django provides two subclasses of ``InlineModelAdmin`` and they are:
* ``TabularInline``
* ``StackedInline``
The difference between these two is merely the template used to render them.
The difference between these two is merely the template used to render
them.
``InlineModelAdmin`` options
-----------------------------
@ -1090,9 +1107,10 @@ all the same functionality as well as some of its own:
.. attribute:: InlineModelAdmin.extra
This controls the number of extra forms the formset will display in addition
to the initial forms. See the
:doc:`formsets documentation </topics/forms/formsets>` for more information.
This controls the number of extra forms the formset will display in
addition to the initial forms. See the
:doc:`formsets documentation </topics/forms/formsets>` for more
information.
.. versionadded:: 1.2
@ -1322,8 +1340,8 @@ Overriding Admin Templates
==========================
It is relatively easy to override many of the templates which the admin module
uses to generate the various pages of an admin site. You can even override a few
of these templates for a specific app, or a specific model.
uses to generate the various pages of an admin site. You can even override a
few of these templates for a specific app, or a specific model.
Set up your projects admin template directories
-----------------------------------------------
@ -1331,15 +1349,15 @@ Set up your projects admin template directories
The admin template files are located in the ``contrib/admin/templates/admin``
directory.
In order to override one or more of them, first create an ``admin`` directory in
your project's ``templates`` directory. This can be any of the directories you
specified in ``TEMPLATE_DIRS``.
In order to override one or more of them, first create an ``admin`` directory
in your project's ``templates`` directory. This can be any of the directories
you specified in ``TEMPLATE_DIRS``.
Within this ``admin`` directory, create sub-directories named after your app.
Within these app subdirectories create sub-directories named after your models.
Note, that the admin app will lowercase the model name when looking for the
directory, so make sure you name the directory in all lowercase if you are going
to run your app on a case-sensitive filesystem.
directory, so make sure you name the directory in all lowercase if you are
going to run your app on a case-sensitive filesystem.
To override an admin template for a specific app, copy and edit the template
from the ``django/contrib/admin/templates/admin`` directory, and save it to one
@ -1409,8 +1427,9 @@ and 500 pages.
Some of the admin templates, such as ``change_list_request.html`` are used
to render custom inclusion tags. These may be overridden, but in such cases
you are probably better off creating your own version of the tag in question
and giving it a different name. That way you can use it selectively.
you are probably better off creating your own version of the tag in
question and giving it a different name. That way you can use it
selectively.
Root and login templates
------------------------
@ -1453,7 +1472,8 @@ Templates can override or extend base admin templates as described in
.. attribute:: AdminSite.index_template
Path to a custom template that will be used by the admin site main index view.
Path to a custom template that will be used by the admin site main index
view.
.. attribute:: AdminSite.login_template
@ -1463,8 +1483,8 @@ Path to a custom template that will be used by the admin site login view.
.. attribute:: AdminSite.login_form
Subclass of :class:`~django.contrib.auth.forms.AuthenticationForm` that will
be used by the admin site login view.
Subclass of :class:`~django.contrib.auth.forms.AuthenticationForm` that
will be used by the admin site login view.
.. attribute:: AdminSite.logout_template
@ -1476,15 +1496,15 @@ Path to a custom template that will be used by the admin site logout view.
.. versionadded:: 1.2
Path to a custom template that will be used by the admin site password change
view.
Path to a custom template that will be used by the admin site password
change view.
.. attribute:: AdminSite.password_change_done_template
.. versionadded:: 1.2
Path to a custom template that will be used by the admin site password change
done view.
Path to a custom template that will be used by the admin site password
change done view.
Hooking ``AdminSite`` instances into your URLconf
-------------------------------------------------
@ -1619,12 +1639,14 @@ call::
>>> c = Choice.objects.get(...)
>>> change_url = urlresolvers.reverse('admin:polls_choice_change', args=(c.id,))
This will find the first registered instance of the admin application (whatever the instance
name), and resolve to the view for changing ``poll.Choice`` instances in that instance.
This will find the first registered instance of the admin application
(whatever the instance name), and resolve to the view for changing
``poll.Choice`` instances in that instance.
If you want to find a URL in a specific admin instance, provide the name of that instance
as a ``current_app`` hint to the reverse call. For example, if you specifically wanted
the admin view from the admin instance named ``custom``, you would need to call::
If you want to find a URL in a specific admin instance, provide the name of
that instance as a ``current_app`` hint to the reverse call. For example,
if you specifically wanted the admin view from the admin instance named
``custom``, you would need to call::
>>> change_url = urlresolvers.reverse('custom:polls_choice_change', args=(c.id,))