django.forms.formsets.BaseFormSet

class documentation

class BaseFormSet(RenderableFormMixin):

Known subclasses: django.forms.models.BaseModelFormSet

View In Hierarchy

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 get​_context Undocumented
Method total​_error​_count Return the number of errors across all forms in the formset.
Class Variable template​_name Undocumented
Class Variable template​_name​_p Undocumented
Class Variable template​_name​_table Undocumented
Class Variable template​_name​_ul 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 ​_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.
Method add​_fields A hook for adding extra fields on to each form instance.
Method add​_prefix Undocumented
Method clean No summary
Method full​_clean Clean all of self.data and populate self._errors and self._non_form_errors.
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​_form​_count Return the total number of forms in this FormSet.
Class Variable default​_error​_messages Undocumented
Instance Variable ​_errors Undocumented
Instance Variable ​_non​_form​_errors 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.

Inherited from RenderableFormMixin:

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):
overridden in django.contrib.contenttypes.forms.BaseGenericInlineFormSet, django.forms.models.BaseInlineFormSet

Undocumented

@classmethod
def get_deletion_widget(cls):

Undocumented

@classmethod
def get_ordering_widget(cls):

Undocumented

def get_context(self):
overrides django.forms.utils.RenderableMixin.get_context

Undocumented

def total_error_count(self):
Return the number of errors across all forms in the formset.
template_name: str =

Undocumented

template_name_p: str =

Undocumented

template_name_table: str =

Undocumented

template_name_ul: str =

Undocumented

def __bool__(self):
Return True since all formsets have a management form which is not included in the length.
def __getitem__(self, index):
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):
overridden in django.forms.models.BaseModelFormSet

Undocumented

def __iter__(self):
Yield the forms in the order they should be rendered.
def __len__(self):

Undocumented

def _construct_form(self, i, **kwargs):
overridden in django.forms.models.BaseModelFormSet
Instantiate and return the i-th form instance in a formset.
def _should_delete_form(self, form):
Return whether or not the form was marked for deletion.
def add_fields(self, form, index):
overridden in django.forms.models.BaseModelFormSet
A hook for adding extra fields on to each form instance.
def add_prefix(self, index):

Undocumented

def clean(self):
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):
Clean all of self.data and populate self._errors and self._non_form_errors.
def get_form_kwargs(self, index):

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):
Return True if data in any form differs from initial.
def initial_form_count(self):
overridden in django.forms.models.BaseModelFormSet
Return the number of forms that are required in this FormSet.
def is_multipart(self):
Return True if the formset needs to be multipart, i.e. it has FileInput, or False otherwise.
def is_valid(self):
Return True if every form in self.forms is valid.
def non_form_errors(self):
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_form_count(self):
Return the total number of forms in this FormSet.
default_error_messages =

Undocumented

_errors: list =

Undocumented

_non_form_errors =

Undocumented

auto_id =

Undocumented

data =

Undocumented

error_class =

Undocumented

error_messages =

Undocumented

files =

Undocumented

form_kwargs =

Undocumented

initial =

Undocumented

is_bound =

Undocumented

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.
@cached_property
forms =
Instantiate forms at first property access.
@property
initial_forms =
Return a list of all the initial forms in this formset.
@cached_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.