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

Fixed #11128 -- Misc. fixes and improvements to the model forms doc. Thanks Ramiro and Alex. 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@10795 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Karen Tracey 2009-05-17 16:12:05 +00:00
parent 975ec181ea
commit 7ba62f2c15
1 changed files with 22 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/topics/forms/modelforms.txt
View File

@ -400,10 +400,10 @@ Overriding the clean() method
You can override the ``clean()`` method on a model form to provide additional You can override the ``clean()`` method on a model form to provide additional
validation in the same way you can on a normal form. However, by default the validation in the same way you can on a normal form. However, by default the
``clean()`` method validates the uniqueness of fields that are marked as unique ``clean()`` method validates the uniqueness of fields that are marked as
or unique_together on the model. Therefore, if you would like to override ``unique``, ``unique_together`` or ``unique_for_date|month|year`` on the model.
the ``clean()`` method and maintain the default validation, you must call the Therefore, if you would like to override the ``clean()`` method and maintain the
parent class's ``clean()`` method. default validation, you must call the parent class's ``clean()`` method.
Form inheritance Form inheritance
---------------- ----------------
@ -515,22 +515,6 @@ exclude::
.. _saving-objects-in-the-formset: .. _saving-objects-in-the-formset:
Overriding clean() method
-------------------------
You can override the ``clean()`` method to provide custom validation to
the whole formset at once. By default, the ``clean()`` method will validate
that none of the data in the formsets violate the unique constraints on your
model (both field ``unique`` and model ``unique_together``). To maintain this
default behavior be sure you call the parent's ``clean()`` method::
class MyModelFormSet(BaseModelFormSet):
def clean(self):
super(MyModelFormSet, self).clean()
# example custom validation across forms in the formset:
for form in self.forms:
# your custom formset validation
Saving objects in the formset Saving objects in the formset
----------------------------- -----------------------------
@ -615,19 +599,25 @@ than that of a "normal" formset. The only difference is that we call
``formset.save()`` to save the data into the database. (This was described ``formset.save()`` to save the data into the database. (This was described
above, in :ref:`saving-objects-in-the-formset`.) above, in :ref:`saving-objects-in-the-formset`.)
Overiding ``clean()`` on a ``model_formset`` Overiding ``clean()`` on a ``model_formset``
-------------------------------------------- --------------------------------------------
Just like with ``ModelForms``, by default the ``clean()`` method of a Just like with ``ModelForms``, by default the ``clean()`` method of a
``model_formset`` will validate that none of the items in the formset validate ``model_formset`` will validate that none of the items in the formset violate
the unique constraints on your model(either unique or unique_together). If you the unique constraints on your model (either ``unique``, ``unique_together`` or
want to overide the ``clean()`` method on a ``model_formset`` and maintain this ``unique_for_date|month|year``). If you want to overide the ``clean()`` method
validation, you must call the parent classes ``clean`` method. on a ``model_formset`` and maintain this validation, you must call the parent
classes ``clean`` method::
class MyModelFormSet(BaseModelFormSet):
def clean(self):
super(MyModelFormSet, self).clean()
# example custom validation across forms in the formset:
for form in self.forms:
# your custom formset validation
Using a custom queryset Using a custom queryset
~~~~~~~~~~~~~~~~~~~~~~~ -----------------------
As stated earlier, you can override the default queryset used by the model As stated earlier, you can override the default queryset used by the model
formset:: formset::
@ -650,7 +640,9 @@ Note that we pass the ``queryset`` argument in both the ``POST`` and ``GET``
cases in this example. cases in this example.
Using the formset in the template Using the formset in the template
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ---------------------------------
.. highlight:: html+django
There are three ways to render a formset in a Django template. There are three ways to render a formset in a Django template.
@ -705,6 +697,8 @@ the model formset, in the ``POST`` case, will work correctly. (This example
assumes a primary key named ``id``. If you've explicitly defined your own assumes a primary key named ``id``. If you've explicitly defined your own
primary key that isn't called ``id``, make sure it gets rendered.) primary key that isn't called ``id``, make sure it gets rendered.)
.. highlight:: python
Inline formsets Inline formsets
=============== ===============
@ -745,7 +739,7 @@ the following model::
To resolve this, you can use ``fk_name`` to ``inlineformset_factory``:: To resolve this, you can use ``fk_name`` to ``inlineformset_factory``::
>>> FrienshipFormSet = inlineformset_factory(Friend, Friendship, fk_name="from_friend") >>> FriendshipFormSet = inlineformset_factory(Friend, Friendship, fk_name="from_friend")
Using an inline formset in a view Using an inline formset in a view
--------------------------------- ---------------------------------