Class FormWizard

form_list should be a list of Form classes (not instances).

Overrides: object.__init__

repr(x)

Overrides: object.__repr__

(inherited documentation)

Hook for rendering a template if a hash check failed.

step is the step that failed. Any previous step is guaranteed to be valid.

This default implementation simply renders the form for the given step, but subclasses may want to display an error message, etc.

Hook for rendering a template if final revalidation failed.

It is highly unlikely that this point would ever be reached, but See the comment in __call__() for an explanation.

Calculates the security hash for the given HttpRequest and Form instances.

This creates a list of the form field names/values in a deterministic order, pickles the result with the SECRET_KEY setting and takes an md5 hash of that.

Subclasses may want to take into account request-specific information, such as the IP address.

Given the request object and whatever *args and **kwargs were passed to __call__(), returns the current step (which is zero-based).

Note that the result should not be trusted. It may even be a completely invalid number. It's not the job of this method to validate it.

Hook for setting some state, given the request object and whatever *args and **kwargs were passed to __call__(), sets some state.

This is called at the beginning of __call__().

Hook for specifying the name of the template to use for a given step.

Note that this can return a tuple of template names if you'd like to use the template system's select_template() hook.

Renders the template for the given step, returning an HttpResponse object.

Override this method if you want to add a custom context, return a
different MIME type, etc. If you only need to override the template
name, use get_template() instead.

The template will be rendered with the following context:
    step_field -- The name of the hidden field containing the step.
    step0      -- The current step (zero-based).
    step       -- The current step (one-based).
    step_count -- The total number of steps.
    form       -- The Form instance for the current step (either empty
                  or with errors).
    previous_fields -- A string representing every previous data field,
                  plus hashes for completed forms, all in the form of
                  hidden fields. Note that you'll need to run this
                  through the "safe" template filter, to prevent
                  auto-escaping, because it's raw HTML.

Hook for modifying the FormWizard's internal state, given a fully validated Form object. The Form is guaranteed to have clean, valid data.

This method should *not* modify any of that data. Rather, it might want to set self.extra_context or dynamically alter self.form_list, based on previously submitted forms.

Note that this method is called every time a page is rendered for *all* submitted steps.

Hook for doing something with the validated data. This is responsible for the final processing.

form_list is a list of Form instances, each containing clean, valid data.