django/docs/ref/forms/formsets.txt

=================
Formset Functions
=================

Formset API reference. For introductory material about formsets, see the
:doc:`/topics/forms/formsets` topic guide.

.. module:: django.forms.formsets
   :synopsis: Django's functions for building formsets.

``formset_factory``
===================

.. function:: formset_factory(form, formset=BaseFormSet, extra=1, can_order=False, can_delete=False, max_num=None, validate_max=False, min_num=None, validate_min=False, absolute_max=None, can_delete_extra=True)

    Returns a ``FormSet`` class for the given ``form`` class.

    See :doc:`formsets </topics/forms/formsets>` for example usage.

    .. versionchanged:: 3.2

        The ``absolute_max`` and ``can_delete_extra`` arguments were added.
Fixed #17638 -- Added crosslinks between topic and reference guides. Thanks oinopion for the suggestion and jarus for the initial patch. 2014-09-27 16:12:34 -06:00			`=================`
Fixed #20084 -- Provided option to validate formset max_num on server. This is provided as a new "validate_max" formset_factory option defaulting to False, since the non-validating behavior of max_num is longstanding, and there is certainly code relying on it. (In fact, even the Django admin relies on it for the case where there are more existing inlines than the given max_num). It may be that at some point we want to deprecate validate_max=False and eventually remove the option, but this commit takes no steps in that direction. This also fixes the DoS-prevention absolute_max enforcement so that it causes a form validation error rather than an IndexError, and ensures that absolute_max is always 1000 more than max_num, to prevent surprising changes in behavior with max_num close to absolute_max. Lastly, this commit fixes the previous inconsistency between a regular formset and a model formset in the precedence of max_num and initial data. Previously in a regular formset, if the provided initial data was longer than max_num, it was truncated; in a model formset, all initial forms would be displayed regardless of max_num. Now regular formsets are the same as model formsets; all initial forms are displayed, even if more than max_num. (But if validate_max is True, submitting these forms will result in a "too many forms" validation error!) This combination of behaviors was chosen to keep the max_num validation simple and consistent, and avoid silent data loss due to truncation of initial data. Thanks to Preston for discussion of the design choices. 2013-03-20 23:27:06 -07:00			`Formset Functions`
Fixed #17638 -- Added crosslinks between topic and reference guides. Thanks oinopion for the suggestion and jarus for the initial patch. 2014-09-27 16:12:34 -06:00			`=================`

			`Formset API reference. For introductory material about formsets, see the`
			:doc:`/topics/forms/formsets` topic guide.
Fixed #20084 -- Provided option to validate formset max_num on server. This is provided as a new "validate_max" formset_factory option defaulting to False, since the non-validating behavior of max_num is longstanding, and there is certainly code relying on it. (In fact, even the Django admin relies on it for the case where there are more existing inlines than the given max_num). It may be that at some point we want to deprecate validate_max=False and eventually remove the option, but this commit takes no steps in that direction. This also fixes the DoS-prevention absolute_max enforcement so that it causes a form validation error rather than an IndexError, and ensures that absolute_max is always 1000 more than max_num, to prevent surprising changes in behavior with max_num close to absolute_max. Lastly, this commit fixes the previous inconsistency between a regular formset and a model formset in the precedence of max_num and initial data. Previously in a regular formset, if the provided initial data was longer than max_num, it was truncated; in a model formset, all initial forms would be displayed regardless of max_num. Now regular formsets are the same as model formsets; all initial forms are displayed, even if more than max_num. (But if validate_max is True, submitting these forms will result in a "too many forms" validation error!) This combination of behaviors was chosen to keep the max_num validation simple and consistent, and avoid silent data loss due to truncation of initial data. Thanks to Preston for discussion of the design choices. 2013-03-20 23:27:06 -07:00
			`.. module:: django.forms.formsets`
			`:synopsis: Django's functions for building formsets.`

Fixed #26124 -- Added missing code formatting to docs headers. 2016-01-24 22:26:11 +01:00			``formset_factory``
			`===================`

Fixed #9061 -- Allowed FormSets to disable deleting extra forms. Thanks to Dan Ward for the initial patch. 2020-06-19 22:46:25 +01:00			`.. function:: formset_factory(form, formset=BaseFormSet, extra=1, can_order=False, can_delete=False, max_num=None, validate_max=False, min_num=None, validate_min=False, absolute_max=None, can_delete_extra=True)`
Fixed #20084 -- Provided option to validate formset max_num on server. This is provided as a new "validate_max" formset_factory option defaulting to False, since the non-validating behavior of max_num is longstanding, and there is certainly code relying on it. (In fact, even the Django admin relies on it for the case where there are more existing inlines than the given max_num). It may be that at some point we want to deprecate validate_max=False and eventually remove the option, but this commit takes no steps in that direction. This also fixes the DoS-prevention absolute_max enforcement so that it causes a form validation error rather than an IndexError, and ensures that absolute_max is always 1000 more than max_num, to prevent surprising changes in behavior with max_num close to absolute_max. Lastly, this commit fixes the previous inconsistency between a regular formset and a model formset in the precedence of max_num and initial data. Previously in a regular formset, if the provided initial data was longer than max_num, it was truncated; in a model formset, all initial forms would be displayed regardless of max_num. Now regular formsets are the same as model formsets; all initial forms are displayed, even if more than max_num. (But if validate_max is True, submitting these forms will result in a "too many forms" validation error!) This combination of behaviors was chosen to keep the max_num validation simple and consistent, and avoid silent data loss due to truncation of initial data. Thanks to Preston for discussion of the design choices. 2013-03-20 23:27:06 -07:00
			Returns a ``FormSet`` class for the given ``form`` class.

Fixed #26020 -- Normalized header stylings in docs. 2016-01-03 12:56:22 +02:00			See :doc:`formsets </topics/forms/formsets>` for example usage.
Fixed #20347 -- Allowed customizing the maximum number of instantiated forms in formsets. Co-authored-by: ethurgood <ethurgood@gmail.com> 2020-04-30 08:34:53 +01:00
			`.. versionchanged:: 3.2`

Fixed #9061 -- Allowed FormSets to disable deleting extra forms. Thanks to Dan Ward for the initial patch. 2020-06-19 22:46:25 +01:00			The ``absolute_max`` and ``can_delete_extra`` arguments were added.