django.forms.formsets.BaseFormSet

class documentation

class BaseFormSet(RenderableFormMixin): (source)

Known subclasses: django.forms.models.BaseModelFormSet

A collection of instances of the same Form class.

Class Method	`get_default_prefix`	Undocumented
Class Method	`get_deletion_widget`	Undocumented
Class Method	`get_ordering_widget`	Undocumented
Method	`__bool__`	Return True since all formsets have a management form which is not included in the length.
Method	`__getitem__`	Return the form at the given index, based on the rendering order.
Method	`__init__`	Undocumented
Method	`__iter__`	Yield the forms in the order they should be rendered.
Method	`__len__`	Undocumented
Method	`__repr__`	Undocumented
Method	`add_fields`	A hook for adding extra fields on to each form instance.
Method	`add_prefix`	Undocumented
Method	`clean`	Hook for doing any extra formset-wide cleaning after Form.clean() has been called on every form. Any ValidationError raised by this method will not be associated with a particular form; it will be accessible via formset...
Method	`full_clean`	Clean all of self.data and populate self._errors and self._non_form_errors.
Method	`get_context`	Undocumented
Method	`get_form_kwargs`	Return additional keyword arguments for each individual formset form.
Method	`has_changed`	Return True if data in any form differs from initial.
Method	`initial_form_count`	Return the number of forms that are required in this FormSet.
Method	`is_multipart`	Return True if the formset needs to be multipart, i.e. it has FileInput, or False otherwise.
Method	`is_valid`	Return True if every form in self.forms is valid.
Method	`non_form_errors`	Return an ErrorList of errors that aren't associated with a particular form -- i.e., from formset.clean(). Return an empty ErrorList if there are none.
Method	`total_error_count`	Return the number of errors across all forms in the formset.
Method	`total_form_count`	Return the total number of forms in this FormSet.
Class Variable	`default_error_messages`	Undocumented
Class Variable	`template_name_div`	Undocumented
Class Variable	`template_name_p`	Undocumented
Class Variable	`template_name_table`	Undocumented
Class Variable	`template_name_ul`	Undocumented
Instance Variable	`auto_id`	Undocumented
Instance Variable	`data`	Undocumented
Instance Variable	`error_class`	Undocumented
Instance Variable	`error_messages`	Undocumented
Instance Variable	`files`	Undocumented
Instance Variable	`form_kwargs`	Undocumented
Instance Variable	`initial`	Undocumented
Instance Variable	`is_bound`	Undocumented
Instance Variable	`prefix`	Undocumented
Property	`cleaned_data`	Return a list of form.cleaned_data dicts for every form in self.forms.
Property	`deleted_forms`	Return a list of forms that have been marked for deletion.
Property	`empty_form`	Undocumented
Property	`errors`	Return a list of form.errors for every form in self.forms.
Property	`extra_forms`	Return a list of all the extra forms in this formset.
Property	`forms`	Instantiate forms at first property access.
Property	`initial_forms`	Return a list of all the initial forms in this formset.
Property	`management_form`	Return the ManagementForm instance for this FormSet.
Property	`media`	Undocumented
Property	`ordered_forms`	Return a list of form in the order specified by the incoming data. Raise an AttributeError if ordering is not allowed.
Property	`template_name`	Undocumented
Method	`_construct_form`	Instantiate and return the i-th form instance in a formset.
Method	`_should_delete_form`	Return whether or not the form was marked for deletion.
Instance Variable	`_errors`	Undocumented
Instance Variable	`_non_form_errors`	Undocumented

Inherited from RenderableFormMixin:

Method	`as_div`	Render as <div> elements.
Method	`as_p`	Render as <p> elements.
Method	`as_table`	Render as <tr> elements excluding the surrounding <table> tag.
Method	`as_ul`	Render as <li> elements excluding the surrounding <ul> tag.

Inherited from RenderableMixin (via RenderableFormMixin):

Method render Undocumented

@classmethod
def get_default_prefix(cls): (source) ¶

overridden in django.contrib.contenttypes.forms.BaseGenericInlineFormSet, django.forms.models.BaseInlineFormSet

Undocumented

@classmethod
def get_deletion_widget(cls): (source) ¶

Undocumented

@classmethod
def get_ordering_widget(cls): (source) ¶

Undocumented

def __bool__(self): (source) ¶

Return True since all formsets have a management form which is not included in the length.

def __getitem__(self, index): (source) ¶

Return the form at the given index, based on the rendering order.

def __init__(self, data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, form_kwargs=None, error_messages=None): (source) ¶

overridden in django.forms.models.BaseModelFormSet

Undocumented

def __iter__(self): (source) ¶

Yield the forms in the order they should be rendered.

def __len__(self): (source) ¶

Undocumented

def __repr__(self): (source) ¶

Undocumented

def add_fields(self, form, index): (source) ¶

overridden in django.forms.models.BaseModelFormSet

A hook for adding extra fields on to each form instance.

def add_prefix(self, index): (source) ¶

Undocumented

def clean(self): (source) ¶

overridden in django.forms.models.BaseModelFormSet

Hook for doing any extra formset-wide cleaning after Form.clean() has been called on every form. Any ValidationError raised by this method will not be associated with a particular form; it will be accessible via formset.non_form_errors()

def full_clean(self): (source) ¶

Clean all of self.data and populate self._errors and self._non_form_errors.

def get_context(self): (source) ¶

overrides django.forms.utils.RenderableMixin.get_context

Undocumented

def get_form_kwargs(self, index): (source) ¶

Return additional keyword arguments for each individual formset form. index will be None if the form being constructed is a new empty form.

def has_changed(self): (source) ¶

Return True if data in any form differs from initial.

def initial_form_count(self): (source) ¶

overridden in django.forms.models.BaseModelFormSet

Return the number of forms that are required in this FormSet.

def is_multipart(self): (source) ¶

Return True if the formset needs to be multipart, i.e. it has FileInput, or False otherwise.

def is_valid(self): (source) ¶

Return True if every form in self.forms is valid.

def non_form_errors(self): (source) ¶

Return an ErrorList of errors that aren't associated with a particular form -- i.e., from formset.clean(). Return an empty ErrorList if there are none.

def total_error_count(self): (source) ¶

Return the number of errors across all forms in the formset.

def total_form_count(self): (source) ¶

Return the total number of forms in this FormSet.

default_error_messages = (source) ¶

Undocumented

template_name_div: str = (source) ¶

Undocumented

template_name_p: str = (source) ¶

Undocumented

template_name_table: str = (source) ¶

Undocumented