class documentation

class BaseModelForm(BaseForm):

Known subclasses: django.forms.models.ModelForm

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method ​_get​_validation​_exclusions For backwards-compatibility, exclude several types of fields from model validation. See tickets #12507, #12521, #12553.
Method ​_post​_clean An internal hook for performing additional cleaning after form cleaning is complete. Used for model validation in model forms.
Method ​_save​_m2m Save the many-to-many fields and generic relations for this form.
Method ​_update​_errors Undocumented
Method clean No summary
Method save Save this form's self.instance object if commit=True. Otherwise, add a save_m2m() method to the form which can be called after the instance is saved manually at a later time. Return the model instance.
Method validate​_unique Call the instance's validate_unique() method and update the form's validation errors if any were raised.
Instance Variable ​_validate​_unique Undocumented
Instance Variable instance Undocumented

Inherited from BaseForm:

Method __getitem__ Return a BoundField with the given name.
Method __iter__ Yield the form's fields as BoundField objects.
Method __repr__ Undocumented
Method ​_bound​_items Yield (name, bf) pairs, where bf is a BoundField object.
Method ​_clean​_fields Undocumented
Method ​_clean​_form Undocumented
Method ​_html​_output Output HTML. Used by as_table(), as_ul(), as_p().
Method ​_widget​_data​_value Undocumented
Method add​_error Update the content of self._errors.
Method add​_initial​_prefix Add an 'initial' prefix for checking dynamic initial values.
Method add​_prefix Return the field name with a prefix appended, if this Form has a prefix set.
Method full​_clean Clean all of self.data and populate self._errors and self.cleaned_data.
Method get​_context Undocumented
Method get​_initial​_for​_field Return initial data for field on form. Use initial data from the form or the field, in that order. Evaluate callable values.
Method has​_changed Return True if data differs from initial.
Method has​_error Undocumented
Method hidden​_fields Return a list of all the BoundField objects that are hidden fields. Useful for manual form layout in templates.
Method is​_multipart Return True if the form needs to be multipart-encoded, i.e. it has FileInput, or False otherwise.
Method is​_valid Return True if the form has no errors, or False otherwise.
Method non​_field​_errors Return an ErrorList of errors that aren't associated with a particular field -- i.e., from Form.clean(). Return an empty ErrorList if there are none.
Method order​_fields Rearrange the fields according to field_order.
Method visible​_fields Return a list of BoundField objects that aren't hidden fields. The opposite of the hidden_fields() method.
Class Variable default​_renderer Undocumented
Class Variable field​_order Undocumented
Class Variable template​_name Undocumented
Class Variable template​_name​_label Undocumented
Class Variable template​_name​_p Undocumented
Class Variable template​_name​_table Undocumented
Class Variable template​_name​_ul Undocumented
Instance Variable ​_bound​_fields​_cache Undocumented
Instance Variable ​_errors Undocumented
Instance Variable auto​_id Undocumented
Instance Variable cleaned​_data Undocumented
Instance Variable data Undocumented
Instance Variable empty​_permitted Undocumented
Instance Variable error​_class Undocumented
Instance Variable fields Undocumented
Instance Variable files Undocumented
Instance Variable initial Undocumented
Instance Variable is​_bound Undocumented
Instance Variable label​_suffix Undocumented
Instance Variable prefix Undocumented
Instance Variable renderer Undocumented
Instance Variable use​_required​_attribute Undocumented
Property changed​_data Undocumented
Property errors Return an ErrorDict for the data provided for the form.
Property media Return all media required to render the widgets on this form.

Inherited from RenderableFormMixin (via BaseForm):

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 BaseForm, RenderableFormMixin):

Method render Undocumented
def __init__(self, data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None):
def _get_validation_exclusions(self):
For backwards-compatibility, exclude several types of fields from model validation. See tickets #12507, #12521, #12553.
def _post_clean(self):
An internal hook for performing additional cleaning after form cleaning is complete. Used for model validation in model forms.
def _save_m2m(self):
Save the many-to-many fields and generic relations for this form.
def _update_errors(self, errors):

Undocumented

def clean(self):
Hook for doing any extra form-wide cleaning after Field.clean() has been called on every field. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field named '__all__'.
def save(self, commit=True):
Save this form's self.instance object if commit=True. Otherwise, add a save_m2m() method to the form which can be called after the instance is saved manually at a later time. Return the model instance.
def validate_unique(self):
Call the instance's validate_unique() method and update the form's validation errors if any were raised.
_validate_unique: bool =

Undocumented

instance =

Undocumented