summaryrefslogtreecommitdiff
path: root/docs/topics/forms/formsets.txt
diff options
context:
space:
mode:
authorBryan Marty <bryanmarty@gmail.com>2015-10-27 18:37:35 -0700
committerTim Graham <timograham@gmail.com>2015-10-28 15:46:45 -0400
commit44f177b5cdab82ffefa81abd3e9c2a13aaab256f (patch)
treece72d8da48851b69948d0295cd4b80b0bb197075 /docs/topics/forms/formsets.txt
parent46850e2c850b50279c946b4078601f2b41ef7554 (diff)
[1.9.x] Fixed #21516 -- Updated imports paths for some formset functions/classes.
Since refs #21489, FormSet classes and factories are exposed on the django.forms package. Backport of 455034d4df048010de4ae0a9a2392b70d1463c61 from master
Diffstat (limited to 'docs/topics/forms/formsets.txt')
-rw-r--r--docs/topics/forms/formsets.txt36
1 files changed, 18 insertions, 18 deletions
diff --git a/docs/topics/forms/formsets.txt b/docs/topics/forms/formsets.txt
index 6d22118a40..3e28e3fec7 100644
--- a/docs/topics/forms/formsets.txt
+++ b/docs/topics/forms/formsets.txt
@@ -20,7 +20,7 @@ form::
You might want to allow the user to create several articles at once. To create
a formset out of an ``ArticleForm`` you would do::
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import formset_factory
>>> ArticleFormSet = formset_factory(ArticleForm)
You now have created a formset named ``ArticleFormSet``. The formset gives you
@@ -60,7 +60,7 @@ number of forms it generates from the initial data. Let's take a look at an
example::
>>> import datetime
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import formset_factory
>>> from myapp.forms import ArticleForm
>>> ArticleFormSet = formset_factory(ArticleForm, extra=2)
>>> formset = ArticleFormSet(initial=[
@@ -93,7 +93,7 @@ Limiting the maximum number of forms
The ``max_num`` parameter to :func:`~django.forms.formsets.formset_factory`
gives you the ability to limit the number of forms the formset will display::
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import formset_factory
>>> from myapp.forms import ArticleForm
>>> ArticleFormSet = formset_factory(ArticleForm, extra=2, max_num=1)
>>> formset = ArticleFormSet()
@@ -130,7 +130,7 @@ Validation with a formset is almost identical to a regular ``Form``. There is
an ``is_valid`` method on the formset to provide a convenient way to validate
all forms in the formset::
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import formset_factory
>>> from myapp.forms import ArticleForm
>>> ArticleFormSet = formset_factory(ArticleForm)
>>> data = {
@@ -253,8 +253,8 @@ Custom formset validation
A formset has a ``clean`` method similar to the one on a ``Form`` class. This
is where you define your own validation that works at the formset level::
- >>> from django.forms.formsets import BaseFormSet
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import BaseFormSet
+ >>> from django.forms import formset_factory
>>> from myapp.forms import ArticleForm
>>> class BaseArticleFormSet(BaseFormSet):
@@ -309,7 +309,7 @@ If ``validate_max=True`` is passed to
that the number of forms in the data set, minus those marked for
deletion, is less than or equal to ``max_num``.
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import formset_factory
>>> from myapp.forms import ArticleForm
>>> ArticleFormSet = formset_factory(ArticleForm, max_num=1, validate_max=True)
>>> data = {
@@ -351,7 +351,7 @@ If ``validate_min=True`` is passed to
that the number of forms in the data set, minus those marked for
deletion, is greater than or equal to ``min_num``.
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import formset_factory
>>> from myapp.forms import ArticleForm
>>> ArticleFormSet = formset_factory(ArticleForm, min_num=3, validate_min=True)
>>> data = {
@@ -388,7 +388,7 @@ Default: ``False``
Lets you create a formset with the ability to order::
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import formset_factory
>>> from myapp.forms import ArticleForm
>>> ArticleFormSet = formset_factory(ArticleForm, can_order=True)
>>> formset = ArticleFormSet(initial=[
@@ -448,7 +448,7 @@ Default: ``False``
Lets you create a formset with the ability to select forms for deletion::
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import formset_factory
>>> from myapp.forms import ArticleForm
>>> ArticleFormSet = formset_factory(ArticleForm, can_delete=True)
>>> formset = ArticleFormSet(initial=[
@@ -519,8 +519,8 @@ accomplished. The formset base class provides an ``add_fields`` method. You
can simply override this method to add your own fields or even redefine the
default fields/attributes of the order and deletion fields::
- >>> from django.forms.formsets import BaseFormSet
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import BaseFormSet
+ >>> from django.forms import formset_factory
>>> from myapp.forms import ArticleForm
>>> class BaseArticleFormSet(BaseFormSet):
... def add_fields(self, form, index):
@@ -543,8 +543,8 @@ Passing custom parameters to formset forms
Sometimes your form class takes custom parameters, like ``MyArticleForm``.
You can pass this parameter when instantiating the formset::
- >>> from django.forms.formsets import BaseFormSet
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import BaseFormSet
+ >>> from django.forms import formset_factory
>>> from myapp.forms import ArticleForm
>>> class MyArticleForm(ArticleForm):
@@ -560,8 +560,8 @@ base class provides a ``get_form_kwargs`` method. The method takes a single
argument - the index of the form in the formset. The index is ``None`` for the
:ref:`empty_form`::
- >>> from django.forms.formsets import BaseFormSet
- >>> from django.forms.formsets import formset_factory
+ >>> from django.forms import BaseFormSet
+ >>> from django.forms import formset_factory
>>> class BaseArticleFormSet(BaseFormSet):
... def get_form_kwargs(self, index):
@@ -581,7 +581,7 @@ Using a formset inside a view is as easy as using a regular ``Form`` class.
The only thing you will want to be aware of is making sure to use the
management form inside the template. Let's look at a sample view::
- from django.forms.formsets import formset_factory
+ from django.forms import formset_factory
from django.shortcuts import render_to_response
from myapp.forms import ArticleForm
@@ -658,7 +658,7 @@ borrow much of its behavior from forms. With that said you are able to use
more than one formset to be sent to a view without name clashing. Lets take
a look at how this might be accomplished::
- from django.forms.formsets import formset_factory
+ from django.forms import formset_factory
from django.shortcuts import render_to_response
from myapp.forms import ArticleForm, BookForm