summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJannis Leidel <jannis@leidel.info>2014-10-17 22:50:24 +0200
committerTim Graham <timograham@gmail.com>2014-11-26 09:41:52 -0500
commit6302893112a67343b3f5eff3f09f91b245346877 (patch)
tree977ea8f1194270b5d4b5621cabd990f5b340548f /docs
parent296860f791ecdebf1c9f81db778f4d5b855c420b (diff)
Updated formtools docs to point at new package outside the Django repo.
Refs #23677.
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py1
-rw-r--r--docs/index.txt4
-rw-r--r--docs/internals/deprecation.txt5
-rw-r--r--docs/ref/contrib/formtools/form-preview.txt120
-rw-r--r--docs/ref/contrib/formtools/form-wizard.txt762
-rw-r--r--docs/ref/contrib/formtools/index.txt43
-rw-r--r--docs/ref/contrib/index.txt21
-rw-r--r--docs/ref/settings.txt6
-rw-r--r--docs/releases/1.4.txt5
-rw-r--r--docs/releases/1.7.txt6
-rw-r--r--docs/releases/1.8.txt22
11 files changed, 58 insertions, 937 deletions
diff --git a/docs/conf.py b/docs/conf.py
index e6ced398e6..1896176340 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -129,6 +129,7 @@ intersphinx_mapping = {
'python': ('http://docs.python.org/3/', None),
'sphinx': ('http://sphinx-doc.org/', None),
'six': ('http://pythonhosted.org/six/', None),
+ 'formtools': ('http://django-formtools.readthedocs.org/en/latest/', None),
}
# Python's docs don't change every week.
diff --git a/docs/index.txt b/docs/index.txt
index 5ce5f69b19..fb8997a869 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -172,10 +172,6 @@ manipulation of form data.
:doc:`Formsets <topics/forms/formsets>` |
:doc:`Customizing validation <ref/forms/validation>`
-* **Extras:**
- :doc:`Form preview <ref/contrib/formtools/form-preview>` |
- :doc:`Form wizard <ref/contrib/formtools/form-wizard>`
-
The development process
=======================
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt
index 3750d469dd..1db9e23d4e 100644
--- a/docs/internals/deprecation.txt
+++ b/docs/internals/deprecation.txt
@@ -419,9 +419,8 @@ details on these changes.
superseded by :setting:`IGNORABLE_404_URLS` in the 1.4 release. They will be
removed.
-* The :doc:`form wizard </ref/contrib/formtools/form-wizard>` has been
- refactored to use class-based views with pluggable backends in 1.4.
- The previous implementation will be removed.
+* The form wizard has been refactored to use class-based views with pluggable
+ backends in 1.4. The previous implementation will be removed.
* Legacy ways of calling
:func:`~django.views.decorators.cache.cache_page` will be removed.
diff --git a/docs/ref/contrib/formtools/form-preview.txt b/docs/ref/contrib/formtools/form-preview.txt
deleted file mode 100644
index 2c8d44459f..0000000000
--- a/docs/ref/contrib/formtools/form-preview.txt
+++ /dev/null
@@ -1,120 +0,0 @@
-============
-Form preview
-============
-
-.. module:: django.contrib.formtools.preview
- :synopsis: Displays an HTML form, forces a preview, then does something
- with the submission.
-
-Django comes with an optional "form preview" application that helps automate
-the following workflow:
-
-"Display an HTML form, force a preview, then do something with the submission."
-
-To force a preview of a form submission, all you have to do is write a short
-Python class.
-
-Overview
-=========
-
-Given a :class:`django.forms.Form` subclass that you define, this
-application takes care of the following workflow:
-
-1. Displays the form as HTML on a Web page.
-2. Validates the form data when it's submitted via POST.
- a. If it's valid, displays a preview page.
- b. If it's not valid, redisplays the form with error messages.
-3. When the "confirmation" form is submitted from the preview page, calls
- a hook that you define -- a ``done()`` method that gets passed the valid
- data.
-
-The framework enforces the required preview by passing a shared-secret hash to
-the preview page via hidden form fields. If somebody tweaks the form parameters
-on the preview page, the form submission will fail the hash-comparison test.
-
-How to use ``FormPreview``
-==========================
-
-1. Point Django at the default FormPreview templates. There are two ways to
- do this:
-
- * Add ``'django.contrib.formtools'`` to your
- :setting:`INSTALLED_APPS` setting. This will work if your
- :setting:`TEMPLATE_LOADERS` setting includes the
- ``app_directories`` template loader (which is the case by
- default). See the :ref:`template loader docs <template-loaders>`
- for more.
-
- * Otherwise, determine the full filesystem path to the
- :file:`django/contrib/formtools/templates` directory, and add that
- directory to your :setting:`TEMPLATE_DIRS` setting.
-
-2. Create a :class:`~django.contrib.formtools.preview.FormPreview` subclass that
- overrides the ``done()`` method::
-
- from django.contrib.formtools.preview import FormPreview
- from django.http import HttpResponseRedirect
- from myapp.models import SomeModel
-
- class SomeModelFormPreview(FormPreview):
-
- def done(self, request, cleaned_data):
- # Do something with the cleaned_data, then redirect
- # to a "success" page.
- return HttpResponseRedirect('/form/success')
-
- This method takes an :class:`~django.http.HttpRequest` object and a
- dictionary of the form data after it has been validated and cleaned.
- It should return an :class:`~django.http.HttpResponseRedirect` that
- is the end result of the form being submitted.
-
-3. Change your URLconf to point to an instance of your
- :class:`~django.contrib.formtools.preview.FormPreview` subclass::
-
- from myapp.preview import SomeModelFormPreview
- from myapp.forms import SomeModelForm
- from django import forms
-
- ...and add the following line to the appropriate model in your URLconf::
-
- url(r'^post/$', SomeModelFormPreview(SomeModelForm)),
-
- where ``SomeModelForm`` is a Form or ModelForm class for the model.
-
-4. Run the Django server and visit :file:`/post/` in your browser.
-
-``FormPreview`` classes
-=======================
-
-.. class:: FormPreview
-
-A :class:`~django.contrib.formtools.preview.FormPreview` class is a simple Python class
-that represents the preview workflow.
-:class:`~django.contrib.formtools.preview.FormPreview` classes must subclass
-``django.contrib.formtools.preview.FormPreview`` and override the ``done()``
-method. They can live anywhere in your codebase.
-
-``FormPreview`` templates
-=========================
-
-.. attribute:: FormPreview.form_template
-.. attribute:: FormPreview.preview_template
-
-By default, the form is rendered via the template :file:`formtools/form.html`,
-and the preview page is rendered via the template :file:`formtools/preview.html`.
-These values can be overridden for a particular form preview by setting
-:attr:`~django.contrib.formtools.preview.FormPreview.preview_template` and
-:attr:`~django.contrib.formtools.preview.FormPreview.form_template` attributes on the
-FormPreview subclass. See :file:`django/contrib/formtools/templates` for the
-default templates.
-
-Advanced ``FormPreview`` methods
-================================
-
-.. method:: FormPreview.process_preview()
-
- Given a validated form, performs any extra processing before displaying the
- preview page, and saves any extra data in context.
-
- By default, this method is empty. It is called after the form is validated,
- but before the context is modified with hash information and rendered.
diff --git a/docs/ref/contrib/formtools/form-wizard.txt b/docs/ref/contrib/formtools/form-wizard.txt
deleted file mode 100644
index 173e3255ed..0000000000
--- a/docs/ref/contrib/formtools/form-wizard.txt
+++ /dev/null
@@ -1,762 +0,0 @@
-===========
-Form wizard
-===========
-
-.. module:: django.contrib.formtools.wizard.views
- :synopsis: Splits forms across multiple Web pages.
-
-Django comes with an optional "form wizard" application that splits
-:doc:`forms </topics/forms/index>` across multiple Web pages. It maintains
-state in one of the backends so that the full server-side processing can be
-delayed until the submission of the final form.
-
-You might want to use this if you have a lengthy form that would be too
-unwieldy for display on a single page. The first page might ask the user for
-core information, the second page might ask for less important information,
-etc.
-
-The term "wizard", in this context, is `explained on Wikipedia`_.
-
-.. _explained on Wikipedia: http://en.wikipedia.org/wiki/Wizard_%28software%29
-
-How it works
-============
-
-Here's the basic workflow for how a user would use a wizard:
-
-1. The user visits the first page of the wizard, fills in the form and
- submits it.
-2. The server validates the data. If it's invalid, the form is displayed
- again, with error messages. If it's valid, the server saves the current
- state of the wizard in the backend and redirects to the next step.
-3. Step 1 and 2 repeat, for every subsequent form in the wizard.
-4. Once the user has submitted all the forms and all the data has been
- validated, the wizard processes the data -- saving it to the database,
- sending an email, or whatever the application needs to do.
-
-Usage
-=====
-
-This application handles as much machinery for you as possible. Generally,
-you just have to do these things:
-
-1. Define a number of :class:`~django.forms.Form` classes -- one per
- wizard page.
-
-2. Create a :class:`WizardView` subclass that specifies what to do once
- all of your forms have been submitted and validated. This also lets
- you override some of the wizard's behavior.
-
-3. Create some templates that render the forms. You can define a single,
- generic template to handle every one of the forms, or you can define a
- specific template for each form.
-
-4. Add ``django.contrib.formtools`` to your
- :setting:`INSTALLED_APPS` list in your settings file.
-
-5. Point your URLconf at your :class:`WizardView` :meth:`~WizardView.as_view`
- method.
-
-Defining ``Form`` classes
--------------------------
-
-The first step in creating a form wizard is to create the
-:class:`~django.forms.Form` classes. These should be standard
-:class:`django.forms.Form` classes, covered in the :doc:`forms documentation
-</topics/forms/index>`. These classes can live anywhere in your codebase,
-but convention is to put them in a file called :file:`forms.py` in your
-application.
-
-For example, let's write a "contact form" wizard, where the first page's form
-collects the sender's email address and subject, and the second page collects
-the message itself. Here's what the :file:`forms.py` might look like::
-
- from django import forms
-
- class ContactForm1(forms.Form):
- subject = forms.CharField(max_length=100)
- sender = forms.EmailField()
-
- class ContactForm2(forms.Form):
- message = forms.CharField(widget=forms.Textarea)
-
-
-.. note::
-
- In order to use :class:`~django.forms.FileField` in any form, see the
- section :ref:`Handling files <wizard-files>` below to learn more about
- what to do.
-
-Creating a ``WizardView`` subclass
-----------------------------------
-
-.. class:: SessionWizardView
-.. class:: CookieWizardView
-
-The next step is to create a
-:class:`django.contrib.formtools.wizard.views.WizardView` subclass. You can
-also use the :class:`SessionWizardView` or :class:`CookieWizardView` classes
-which preselect the backend used for storing information during execution of the
-wizard (as their names indicate, server-side sessions and browser cookies
-respectively).
-
-.. note::
-
- To use the :class:`SessionWizardView` follow the instructions
- in the :doc:`sessions documentation </topics/http/sessions>` on
- how to enable sessions.
-
-We will use the :class:`SessionWizardView` in all examples but is completely
-fine to use the :class:`CookieWizardView` instead. As with your
-:class:`~django.forms.Form` classes, this :class:`WizardView` class can live
-anywhere in your codebase, but convention is to put it in :file:`views.py`.
-
-The only requirement on this subclass is that it implement a
-:meth:`~WizardView.done()` method.
-
-.. method:: WizardView.done(form_list, form_dict, **kwargs)
-
- This method specifies what should happen when the data for *every* form is
- submitted and validated. This method is passed a list and dictionary of
- validated :class:`~django.forms.Form` instances.
-
- In this simplistic example, rather than performing any database operation,
- the method simply renders a template of the validated data::
-
- from django.shortcuts import render_to_response
- from django.contrib.formtools.wizard.views import SessionWizardView
-
- class ContactWizard(SessionWizardView):
- def done(self, form_list, **kwargs):
- return render_to_response('done.html', {
- 'form_data': [form.cleaned_data for form in form_list],
- })
-
- Note that this method will be called via ``POST``, so it really ought to be a
- good Web citizen and redirect after processing the data. Here's another
- example::
-
- from django.http import HttpResponseRedirect
- from django.contrib.formtools.wizard.views import SessionWizardView
-
- class ContactWizard(SessionWizardView):
- def done(self, form_list, **kwargs):
- do_something_with_the_form_data(form_list)
- return HttpResponseRedirect('/page-to-redirect-to-when-done/')
-
- In addition to ``form_list``, the :meth:`~WizardView.done` method
- is passed a ``form_dict``, which allows you to access the wizard's
- forms based on their step names. This is especially useful when using
- :class:`NamedUrlWizardView`, for example::
-
- def done(self, form_list, form_dict, **kwargs):
- user = form_dict['user'].save()
- credit_card = form_dict['credit_card'].save()
- # ...
-
- .. versionchanged:: 1.7
-
- Previously, the ``form_dict`` argument wasn't passed to the
- ``done`` method.
-
-See the section :ref:`Advanced WizardView methods <wizardview-advanced-methods>`
-below to learn about more :class:`WizardView` hooks.
-
-Creating templates for the forms
---------------------------------
-
-Next, you'll need to create a template that renders the wizard's forms. By
-default, every form uses a template called
-:file:`formtools/wizard/wizard_form.html`. You can change this template name
-by overriding either the
-:attr:`~django.views.generic.base.TemplateResponseMixin.template_name` attribute
-or the
-:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names()`
-method, which are documented in the
-:class:`~django.views.generic.base.TemplateResponseMixin` documentation. The
-latter one allows you to use a different template for each form (:ref:`see the
-example below <wizard-template-for-each-form>`).
-
-This template expects a ``wizard`` object that has various items attached to
-it:
-
-* ``form`` -- The :class:`~django.forms.Form` or
- :class:`~django.forms.formsets.BaseFormSet` instance for the current step
- (either empty or with errors).
-
-* ``steps`` -- A helper object to access the various steps related data:
-
- * ``step0`` -- The current step (zero-based).
- * ``step1`` -- The current step (one-based).
- * ``count`` -- The total number of steps.
- * ``first`` -- The first step.
- * ``last`` -- The last step.
- * ``current`` -- The current (or first) step.
- * ``next`` -- The next step.
- * ``prev`` -- The previous step.
- * ``index`` -- The index of the current step.
- * ``all`` -- A list of all steps of the wizard.
-
-You can supply additional context variables by using the
-:meth:`~WizardView.get_context_data` method of your :class:`WizardView`
-subclass.
-
-Here's a full example template:
-
-.. code-block:: html+django
-
- {% extends "base.html" %}
- {% load i18n %}
-
- {% block head %}
- {{ wizard.form.media }}
- {% endblock %}
-
- {% block content %}
- <p>Step {{ wizard.steps.step1 }} of {{ wizard.steps.count }}</p>
- <form action="" method="post">{% csrf_token %}
- <table>
- {{ wizard.management_form }}
- {% if wizard.form.forms %}
- {{ wizard.form.management_form }}
- {% for form in wizard.form.forms %}
- {{ form }}
- {% endfor %}
- {% else %}
- {{ wizard.form }}
- {% endif %}
- </table>
- {% if wizard.steps.prev %}
- <button name="wizard_goto_step" type="submit" value="{{ wizard.steps.first }}">{% trans "first step" %}</button>
- <button name="wizard_goto_step" type="submit" value="{{ wizard.steps.prev }}">{% trans "prev step" %}</button>
- {% endif %}
- <input type="submit" value="{% trans "submit" %}"/>
- </form>
- {% endblock %}
-
-.. note::
-
- Note that ``{{ wizard.management_form }}`` **must be used** for
- the wizard to work properly.
-
-.. _wizard-urlconf:
-
-Hooking the wizard into a URLconf
----------------------------------
-
-.. method:: WizardView.as_view()
-
-Finally, we need to specify which forms to use in the wizard, and then
-deploy the new :class:`WizardView` object at a URL in the ``urls.py``. The
-wizard's ``as_view()`` method takes a list of your
-:class:`~django.forms.Form` classes as an argument during instantiation::
-
- from django.conf.urls import url
-
- from myapp.forms import ContactForm1, ContactForm2
- from myapp.views import ContactWizard
-
- urlpatterns = [
- url(r'^contact/$', ContactWizard.as_view([ContactForm1, ContactForm2])),
- ]
-
-You can also pass the form list as a class attribute named ``form_list``::
-
- class ContactWizard(WizardView):
- form_list = [ContactForm1, ContactForm2]
-
-.. _wizard-template-for-each-form:
-
-Using a different template for each form
-----------------------------------------
-
-As mentioned above, you may specify a different template for each form.
-Consider an example using a form wizard to implement a multi-step checkout
-process for an online store. In the first step, the user specifies a billing
-and shipping address. In the second step, the user chooses payment type. If
-they chose to pay by credit card, they will enter credit card information in
-the next step. In the final step, they will confirm the purchase.
-
-Here's what the view code might look like::
-
- from django.http import HttpResponseRedirect
- from django.contrib.formtools.wizard.views import SessionWizardView
-
- FORMS = [("address", myapp.forms.AddressForm),
- ("paytype", myapp.forms.PaymentChoiceForm),
- ("cc", myapp.forms.CreditCardForm),
- ("confirmation", myapp.forms.OrderForm)]
-
- TEMPLATES = {"address": "checkout/billingaddress.html",
- "paytype": "checkout/paymentmethod.html",
- "cc": "checkout/creditcard.html",
- "confirmation": "checkout/confirmation.html"}
-
- def pay_by_credit_card(wizard):
- """Return true if user opts to pay by credit card"""
- # Get cleaned data from payment step
- cleaned_data = wizard.get_cleaned_data_for_step('paytype') or {'method': 'none'}
- # Return true if the user selected credit card
- return cleaned_data['method'] == 'cc'
-
-
- class OrderWizard(SessionWizardView):
- def get_template_names(self):
- return [TEMPLATES[self.steps.current]]
-
- def done(self, form_list, **kwargs):
- do_something_with_the_form_data(form_list)
- return HttpResponseRedirect('/page-to-redirect-to-when-done/')
- ...
-
-The ``urls.py`` file would contain something like::
-
- urlpatterns = [
- url(r'^checkout/$', OrderWizard.as_view(FORMS, condition_dict={'cc': pay_by_credit_card})),
- ]
-
-The ``condition_dict`` can be passed as attribute for the ``as_view()`
-method or as a class attribute named ``condition_dict``::
-
- class OrderWizard(WizardView):
- condition_dict = {'cc': pay_by_credit_card}
-
-Note that the ``OrderWizard`` object is initialized with a list of pairs.
-The first element in the pair is a string that corresponds to the name of the
-step and the second is the form class.
-
-In this example, the
-:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names()`
-method returns a list containing a single template, which is selected based on
-the name of the current step.
-
-.. _wizardview-advanced-methods:
-
-Advanced ``WizardView`` methods
-===============================
-
-.. class:: WizardView
-
- Aside from the :meth:`~done()` method, :class:`WizardView` offers a few
- advanced method hooks that let you customize how your wizard works.
-
- Some of these methods take an argument ``step``, which is a zero-based
- counter as string representing the current step of the wizard. (E.g., the
- first form is ``'0'`` and the second form is ``'1'``)
-
-.. method:: WizardView.get_form_prefix(step=None, form=None)
-
- Returns the prefix which will be used when calling the form for the given
- step. ``step`` contains the step name, ``form`` the form class which will
- be called with the returned prefix.
-
- If no ``step`` is given, it will be determined automatically. By default,
- this simply uses the step itself and the ``form`` parameter is not used.
-
- For more, see the :ref:`form prefix documentation <form-prefix>`.
-
-.. method:: WizardView.get_form_initial(step)
-
- Returns a dictionary which will be passed as the
- :attr:`~django.forms.Form.initial` argument when instantiating the Form
- instance for step ``step``. If no initial data was provided while
- initializing the form wizard, an empty dictionary should be returned.
-
- The default implementation::
-
- def get_form_initial(self, step):
- return self.initial_dict.get(step, {})
-
-.. method:: WizardView.get_form_kwargs(step)
-
- Returns a dictionary which will be used as the keyword arguments when
- instantiating the form instance on given ``step``.
-
- The default implementation::
-
- def get_form_kwargs(self, step):
- return {}
-
-.. method:: WizardView.get_form_instance(step)
-
- This method will be called only if a :class:`~django.forms.ModelForm` is
- used as the form for step ``step``.
-
- Returns an :class:`~django.db.models.Model` object which will be passed as
- the ``instance`` argument when instantiating the ``ModelForm`` for step
- ``step``. If no instance object was provided while initializing the form
- wizard, ``None`` will be returned.
-
- The default implementation::
-
- def get_form_instance(self, step):
- return self.instance_dict.get(step, None)
-
-.. method:: WizardView.get_context_data(form, **kwargs)
-
- Returns the template context for a step. You can overwrite this method
- to add more data for all or some steps. This method returns a dictionary
- containing the rendered form step.
-
- The default template context variables are:
-
- * Any extra data the storage backend has stored
- * ``wizard`` -- a dictionary representation of the wizard instance with the
- following key/values:
-
- * ``form`` -- :class:`~django.forms.Form` or
- :class:`~django.forms.formsets.BaseFormSet` instance for the current step
- * ``steps`` -- A helper object to access the various steps related data
- * ``management_form`` -- all the management data for the current step
-
- Example to add extra variables for a specific step::
-
- def get_context_data(self, form, **kwargs):
- context = super(MyWizard, self).get_context_data(form=form, **kwargs)
- if self.steps.current == 'my_step_name':
- context.update({'another_var': True})
- return context
-
-.. method:: WizardView.get_prefix(*args, **kwargs)
-
- This method returns a prefix for use by the storage backends. Backends use
- the prefix as a mechanism to allow data to be stored separately for each
- wizard. This allows wizards to store their data in a single backend
- without overwriting each other.
-
- You can change this method to make the wizard data prefix more unique to,
- e.g. have multiple instances of one wizard in one session.
-
- Default implementation::
-
- def get_prefix(self, *args, **kwargs):
- # use the lowercase underscore version of the class name
- return normalize_name(self.__class__.__name__)
-
-.. method:: WizardView.get_form(step=None, data=None, files=None)
-
- This method constructs the form for a given ``step``. If no ``step`` is
- defined, the current step will be determined automatically. If you override
- ``get_form``, however, you will need to set ``step`` yourself using
- ``self.steps.current`` as in the example below. The method gets three
- arguments:
-
- * ``step`` -- The step for which the form instance should be generated.
- * ``data`` -- Gets passed to the form's data argument
- * ``files`` -- Gets passed to the form's files argument
-
- You can override this method to add extra arguments to the form instance.
-
- Example code to add a user attribute to the form on step 2::
-
- def get_form(self, step=None, data=None, files=None):
- form = super(MyWizard, self).get_form(step, data, files)
-
- # determine the step if not given
- if step is None:
- step = self.steps.current
-
- if step == '1':
- form.user = self.request.user
- return form
-
-.. method:: WizardView.process_step(form)
-
- Hook for modifying the wizard's internal state, given a fully validated
- :class:`~django.forms.Form` object. The Form is guaranteed to have clean,
- valid data.
-
- This method gives you a way to post-process the form data before the data
- gets stored within the storage backend. By default it just returns the
- ``form.data`` dictionary. You should not manipulate the data here but you
- can use it to do some extra work if needed (e.g. set storage extra data).
-
- Note that this method is called every time a page is rendered for *all*
- submitted steps.
-
- The default implementation::
-
- def process_step(self, form):
- return self.get_form_step_data(form)
-
-.. method:: WizardView.process_step_files(form)
-
- This method gives you a way to post-process the form files before the
- files gets stored within the storage backend. By default it just returns
- the ``form.files`` dictionary. You should not manipulate the data here
- but you can use it to do some extra work if needed (e.g. set storage
- extra data).
-
- Default implementation::
-
- def process_step_files(self, form):
- return self.get_form_step_files(form)
-
-.. method:: WizardView.render_goto_step(step, goto_step, **kwargs)
-
- This method is called when the step should be changed to something else
- than the next step. By default, this method just stores the requested
- step ``goto_step`` in the storage and then renders the new step.
-
- If you want to store the entered data of the current step before rendering
- the next step, you can overwrite this method.
-
-.. method:: WizardView.render_revalidation_failure(step, form, **kwargs)
-
- When the wizard thinks all steps have passed it revalidates all forms with
- the data from the backend storage.
-
- If any of the forms don't validate correctly, this method gets called.
- This method expects two arguments, ``step`` and ``form``.
-
- The default implementation resets the current step to the first failing
- form and redirects the user to the invalid form.
-
- Default implementation::
-
- def render_revalidation_failure(self, step, form, **kwargs):
- self.storage.current_step = step
- return self.render(form, **kwargs)
-
-.. method:: WizardView.get_form_step_data(form)
-
- This method fetches the data from the ``form`` Form instance and returns the
- dictionary. You can use this method to manipulate the values before the data
- gets stored in the storage backend.
-
- Default implementation::
-
- def get_form_step_data(self, form):
- return form.data
-
-.. method:: WizardView.get_form_step_files(form)
-
- This method returns the form files. You can use this method to manipulate
- the files before the data gets stored in the storage backend.
-
- Default implementation::
-
- def get_form_step_files(self, form):
- return form.files
-
-.. method:: WizardView.render(form, **kwargs)
-
- This method gets called after the GET or POST request has been handled. You
- can hook in this method to, e.g. change the type of HTTP response.
-
- Default implementation::
-
- def render(self, form=None, **kwargs):
- form = form or self.get_form()
- context = self.get_context_data(form=form, **kwargs)
- return self.render_to_response(context)
-
-.. method:: WizardView.get_cleaned_data_for_step(step)
-
- This method returns the cleaned data for a given ``step``. Before returning
- the cleaned data, the stored values are revalidated through the form. If
- the data doesn't validate, ``None`` will be returned.
-
-.. method:: WizardView.get_all_cleaned_data()
-
- This method returns a merged dictionary of all form steps' ``cleaned_data``
- dictionaries. If a step contains a ``FormSet``, the key will be prefixed
- with ``formset-`` and contain a list of the formset's ``cleaned_data``
- dictionaries. Note that if two or more steps have a field with the same
- name, the value for that field from the latest step will overwrite the
- value from any earlier steps.
-
-Providing initial data for the forms
-====================================
-
-.. attribute:: WizardView.initial_dict
-
- Initial data for a wizard's :class:`~django.forms.Form` objects can be
- provided using the optional :attr:`~WizardView.initial_dict` keyword
- argument. This argument should be a dictionary mapping the steps to
- dictionaries containing the initial data for each step. The dictionary of
- initial data will be passed along to the constructor of the step's
- :class:`~django.forms.Form`::
-
- >>> from myapp.forms import ContactForm1, ContactForm2
- >>> from myapp.views import ContactWizard
- >>> initial = {
- ... '0': {'subject': 'Hello', 'sender': 'user@example.com'},
- ... '1': {'message': 'Hi there!'}
- ... }
- >>> # This example is illustrative only and isn't meant to be run in
- >>> # the shell since it requires an HttpRequest to pass to the view.
- >>> wiz = ContactWizard.as_view([ContactForm1, ContactForm2], initial_dict=initial)(request)
- >>> form1 = wiz.get_form('0')
- >>> form2 = wiz.get_form('1')
- >>> form1.initial
- {'sender': 'user@example.com', 'subject': 'Hello'}
- >>> form2.initial
- {'message': 'Hi there!'}
-
- The ``initial_dict`` can also take a list of dictionaries for a specific
- step if the step is a ``FormSet``.
-
- The ``initial_dict`` can also be added as a class attribute named
- ``initial_dict`` to avoid having the initial data in the ``urls.py``.
-
-.. _wizard-files:
-
-Handling files
-==============
-
-.. attribute:: WizardView.file_storage
-
-To handle :class:`~django.forms.FileField` within any step form of the wizard,
-you have to add a ``file_storage`` to your :class:`WizardView` subclass.
-
-This storage will temporarily store the uploaded files for the wizard. The
-``file_storage`` attribute should be a
-:class:`~django.core.files.storage.Storage` subclass.
-
-Django provides a built-in storage class (see :ref:`the built-in filesystem
-storage class <builtin-fs-storage>`)::
-
- from django.conf import settings
- from django.core.files.storage import FileSystemStorage
-
- class CustomWizardView(WizardView):
- ...
- file_storage = FileSystemStorage(location=os.path.join(settings.MEDIA_ROOT, 'photos'))
-
-.. warning::
-
- Please remember to take care of removing old temporary files, as the
- :class:`WizardView` will only remove these files if the wizard finishes
- correctly.
-
-Conditionally view/skip specific steps
-======================================
-
-.. attribute:: WizardView.condition_dict
-
-The :meth:`~WizardView.as_view` method accepts a ``condition_dict`` argument.
-You can pass a dictionary of boolean values or callables. The key should match
-the steps names (e.g. '0', '1').
-
-If the value of a specific step is callable it will be called with the
-:class:`WizardView` instance as the only argument. If the return value is true,
-the step's form will be used.
-
-This example provides a contact form including a condition. The condition is
-used to show a message form only if a checkbox in the first step was checked.
-
-The steps are defined in a ``forms.py`` file::
-
- from django import forms
-
- class ContactForm1(forms.Form):
- subject = forms.CharField(max_length=100)
- sender = forms.EmailField()
- leave_message = forms.BooleanField(required=False)
-
- class ContactForm2(forms.Form):
- message = forms.CharField(widget=forms.Textarea)
-
-We define our wizard in a ``views.py``::
-
- from django.shortcuts import render_to_response
- from django.contrib.formtools.wizard.views import SessionWizardView
-
- def show_message_form_condition(wizard):
- # try to get the cleaned data of step 1
- cleaned_data = wizard.get_cleaned_data_for_step('0') or {}
- # check if the field ``leave_message`` was checked.
- return cleaned_data.get('leave_message', True)
-
- class ContactWizard(SessionWizardView):
-
- def done(self, form_list, **kwargs):
- return render_to_response('done.html', {
- 'form_data': [form.cleaned_data for form in form_list],
- })
-
-We need to add the ``ContactWizard`` to our ``urls.py`` file::
-
- from django.conf.urls import url
-
- from myapp.forms import ContactForm1, ContactForm2
- from myapp.views import ContactWizard, show_message_form_condition
-
- contact_forms = [ContactForm1, ContactForm2]
-
- urlpatterns = [
- url(r'^contact/$', ContactWizard.as_view(contact_forms,
- condition_dict={'1': show_message_form_condition}
- )),
- ]
-
-As you can see, we defined a ``show_message_form_condition`` next to our
-:class:`WizardView` subclass and added a ``condition_dict`` argument to the
-:meth:`~WizardView.as_view` method. The key refers to the second wizard step
-(because of the zero based step index).
-
-How to work with ModelForm and ModelFormSet
-===========================================
-
-.. attribute:: WizardView.instance_dict
-
-WizardView supports :doc:`ModelForms </topics/forms/modelforms>` and
-:ref:`ModelFormSets <model-formsets>`. Additionally to
-:attr:`~WizardView.initial_dict`, the :meth:`~WizardView.as_view` method takes
-an ``instance_dict`` argument that should contain model instances for steps
-based on ``ModelForm`` and querysets for steps based on ``ModelFormSet``.
-
-Usage of ``NamedUrlWizardView``
-===============================
-
-.. class:: NamedUrlWizardView
-.. class:: NamedUrlSessionWizardView
-.. class:: NamedUrlCookieWizardView
-
-``NamedUrlWizardView`` is a :class:`WizardView` subclass which adds named-urls
-support to the wizard. This allows you to have separate URLs for every step.
-You can also use the :class:`NamedUrlSessionWizardView` or :class:`NamedUrlCookieWizardView`
-classes which preselect the backend used for storing information (Django sessions and
-browser cookies respectively).
-
-To use the named URLs, you should not only use the :class:`NamedUrlWizardView` instead of
-:class:`WizardView`, but you will also have to change your ``urls.py``.
-
-The :meth:`~WizardView.as_view` method takes two additional arguments:
-
-* a required ``url_name`` -- the name of the url (as provided in the ``urls.py``)
-* an optional ``done_step_name`` -- the name of the done step, to be used in the URL
-
-This is an example of a ``urls.py`` for a contact wizard with two steps, step 1 named
-``contactdata`` and step 2 named ``leavemessage``::
-
- from django.conf.urls import url
-
- from myapp.forms import ContactForm1, ContactForm2
- from myapp.views import ContactWizard
-
- named_contact_forms = (
- ('contactdata', ContactForm1),
- ('leavemessage', ContactForm2),
- )
-
- contact_wizard = ContactWizard.as_view(named_contact_forms,
- url_name='contact_step', done_step_name='finished')
-
- urlpatterns = [
- url(r'^contact/(?P<step>.+)/$', contact_wizard, name='contact_step'),
- url(r'^contact/$', contact_wizard, name='contact'),
- ]
-
-Advanced ``NamedUrlWizardView`` methods
-=======================================
-
-.. method:: NamedUrlWizardView.get_step_url(step)
-
-This method returns the URL for a specific step.
-
-Default implementation::
-
- def get_step_url(self, step):
- return reverse(self.url_name, kwargs={'step': step})
diff --git a/docs/ref/contrib/formtools/index.txt b/docs/ref/contrib/formtools/index.txt
index e768c0e655..da5e02d4a3 100644
--- a/docs/ref/contrib/formtools/index.txt
+++ b/docs/ref/contrib/formtools/index.txt
@@ -1,12 +1,43 @@
django.contrib.formtools
========================
-.. module:: django.contrib.formtools
-
A set of high-level abstractions for Django forms (:mod:`django.forms`).
-.. toctree::
- :maxdepth: 1
+Historically, Django shipped with ``django.contrib.formtools`` -- a collection
+of assorted utilities that are useful for specific form use cases. This code is
+now distributed separately from Django, for easier maintenance and to trim the
+size of Django's codebase. In Django 1.8, importing from
+``django.contrib.formtools`` will no longer work.
+
+The new formtools package is named ``django-formtools``, with a main module
+called ``formtools``. Version 1.0 includes the same two primary features that
+the code included when it shipped with Django: a helper for form previews and a
+form wizard view.
+
+See the `official documentation`_ for more information.
+
+.. _official documentation: http://django-formtools.readthedocs.org/
+
+.. _formtools-how-to-migrate:
+
+How to migrate
+--------------
+
+If you've used the old ``django.contrib.formtools`` package follow these
+two easy steps to update your code:
+
+1. Install version 1.0 of the third-party ``django-formtools`` package.
+
+2. Change your app's import statements to reference the new packages.
+
+ For example, change::
+
+ from django.contrib.formtools.wizard.views import WizardView
+
+ to::
+
+ from formtools.wizard.views import WizardView
- form-preview
- form-wizard
+The code in version 1.0 of the new package is the same (it was copied directly
+from Django), so you don't have to worry about backwards compatibility in terms
+of functionality. Only the imports have changed.
diff --git a/docs/ref/contrib/index.txt b/docs/ref/contrib/index.txt
index a4787f8643..2cbc691c5b 100644
--- a/docs/ref/contrib/index.txt
+++ b/docs/ref/contrib/index.txt
@@ -71,27 +71,6 @@ See the :doc:`flatpages documentation </ref/contrib/flatpages>`.
Requires the sites_ contrib package to be installed as well.
-formtools
-=========
-
-A set of high-level abstractions for Django forms (django.forms).
-
-django.contrib.formtools.preview
---------------------------------
-
-An abstraction of the following workflow:
-
-"Display an HTML form, force a preview, then do something with the submission."
-
-See the :doc:`form preview documentation </ref/contrib/formtools/form-preview>`.
-
-django.contrib.formtools.wizard
--------------------------------
-
-Splits forms across multiple Web pages.
-
-See the :doc:`form wizard documentation </ref/contrib/formtools/form-wizard>`.
-
gis
====
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 58fc22eaa1..fc00ad2d57 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -2018,11 +2018,11 @@ The secret key is used for:
* All :doc:`messages </ref/contrib/messages>` if you are using
:class:`~django.contrib.messages.storage.cookie.CookieStorage` or
:class:`~django.contrib.messages.storage.fallback.FallbackStorage`.
-* :doc:`Form wizard </ref/contrib/formtools/form-wizard>` progress when using
+* :mod:`Form wizard <formtools.wizard.views>` progress when using
cookie storage with
- :class:`django.contrib.formtools.wizard.views.CookieWizardView`.
+ :class:`formtools.wizard.views.CookieWizardView`.
* All :func:`~django.contrib.auth.views.password_reset` tokens.
-* All in progress :doc:`form previews </ref/contrib/formtools/form-preview>`.
+* All in progress :mod:`form previews <formtools.preview>`.
* Any usage of :doc:`cryptographic signing </topics/signing>`, unless a
different key is provided.
diff --git a/docs/releases/1.4.txt b/docs/releases/1.4.txt
index 5b10f4c428..965a20a057 100644
--- a/docs/releases/1.4.txt
+++ b/docs/releases/1.4.txt
@@ -358,7 +358,7 @@ more information.
New form wizard
~~~~~~~~~~~~~~~
-The previous ``FormWizard`` from :mod:`django.contrib.formtools` has been
+The previous ``FormWizard`` from ``django.contrib.formtools`` has been
replaced with a new implementation based on the class-based views
introduced in Django 1.3. It features a pluggable storage API and doesn't
require the wizard to pass around hidden fields for every previous step.
@@ -368,9 +368,6 @@ storage backend. The latter uses the tools for
:doc:`cryptographic signing </topics/signing>` also introduced in
Django 1.4 to store the wizard's state in the user's cookies.
-See the :doc:`form wizard </ref/contrib/formtools/form-wizard>` docs for
-more information.
-
``reverse_lazy``
~~~~~~~~~~~~~~~~
diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt
index 3be203d229..e14fd8bc48 100644
--- a/docs/releases/1.7.txt
+++ b/docs/releases/1.7.txt
@@ -440,11 +440,11 @@ Minor features
enabled. See :ref:`session-invalidation-on-password-change` for more details
including upgrade considerations when enabling this new middleware.
-:mod:`django.contrib.formtools`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+``django.contrib.formtools``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* Calls to :meth:`WizardView.done()
- <django.contrib.formtools.wizard.views.WizardView.done>` now include a
+ <formtools.wizard.views.WizardView.done>` now include a
``form_dict`` to allow easier access to forms by their step name.
:mod:`django.contrib.gis`
diff --git a/docs/releases/1.8.txt b/docs/releases/1.8.txt
index b342234ef9..1593f26b79 100644
--- a/docs/releases/1.8.txt
+++ b/docs/releases/1.8.txt
@@ -122,17 +122,6 @@ Minor features
:attr:`~django.contrib.auth.models.CustomUser.REQUIRED_FIELDS` now supports
:class:`~django.db.models.ForeignKey`\s.
-:mod:`django.contrib.formtools`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-* A :doc:`form wizard </ref/contrib/formtools/form-wizard>` using the
- :class:`~django.contrib.formtools.wizard.views.CookieWizardView` will now ignore
- an invalid cookie, and the wizard will restart from the first step. An invalid
- cookie can occur in cases of intentional manipulation, but also after a secret
- key change. Previously, this would raise ``WizardViewCookieModified``, a
- ``SuspiciousOperation``, causing an exception for any user with an invalid cookie
- upon every request to the wizard, until the cookie is removed.
-
:mod:`django.contrib.gis`
^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -710,6 +699,17 @@ The decorators :func:`~django.test.override_settings` and
class decorators. As a consequence, when overriding ``setUpClass()`` or
``tearDownClass()``, the ``super`` implementation should always be called.
+Removal of ``django.contrib.formtools``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The formtools contrib app has been moved into a separate package.
+``django.contrib.formtools`` itself has been removed. The docs provide
+:ref:`migration instructions <formtools-how-to-migrate>`.
+
+The new package is available `on Github`_ and on PyPI.
+
+.. _on GitHub: https://github.com/django/django-formtools/
+
Miscellaneous
~~~~~~~~~~~~~