class BaseForm(RenderableFormMixin): (source)
Known subclasses: django.forms.forms.Form
, django.forms.models.BaseModelForm
The main implementation of all the Form logic. Note that this class is different than Form. See the comments by the Form class for more info. Any improvements to the form API should be made to this class, not to the Form class.
Method | __getitem__ |
Return a BoundField with the given name. |
Method | __init__ |
Undocumented |
Method | __iter__ |
Yield the form's fields as BoundField objects. |
Method | __repr__ |
Undocumented |
Method | add |
Update the content of `self._errors`. |
Method | add |
Add an 'initial' prefix for checking dynamic initial values. |
Method | add |
Return the field name with a prefix appended, if this Form has a prefix set. |
Method | clean |
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__'. |
Method | full |
Clean all of self.data and populate self._errors and self.cleaned_data. |
Method | get |
Undocumented |
Method | get |
Return initial data for field on form. Use initial data from the form or the field, in that order. Evaluate callable values. |
Method | has |
Return True if data differs from initial. |
Method | has |
Undocumented |
Method | hidden |
Return a list of all the BoundField objects that are hidden fields. Useful for manual form layout in templates. |
Method | is |
Return True if the form needs to be multipart-encoded, i.e. it has FileInput, or False otherwise. |
Method | is |
Return True if the form has no errors, or False otherwise. |
Method | non |
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 |
Rearrange the fields according to field_order. |
Method | visible |
Return a list of BoundField objects that aren't hidden fields. The opposite of the hidden_fields() method. |
Class Variable | default |
Undocumented |
Class Variable | field |
Undocumented |
Class Variable | template |
Undocumented |
Class Variable | template |
Undocumented |
Class Variable | template |
Undocumented |
Class Variable | template |
Undocumented |
Class Variable | template |
Undocumented |
Instance Variable | auto |
Undocumented |
Instance Variable | cleaned |
Undocumented |
Instance Variable | data |
Undocumented |
Instance Variable | empty |
Undocumented |
Instance Variable | error |
Undocumented |
Instance Variable | fields |
Undocumented |
Instance Variable | files |
Undocumented |
Instance Variable | initial |
Undocumented |
Instance Variable | is |
Undocumented |
Instance Variable | label |
Undocumented |
Instance Variable | prefix |
Undocumented |
Instance Variable | renderer |
Undocumented |
Instance Variable | use |
Undocumented |
Property | changed |
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. |
Property | template |
Undocumented |
Method | _bound |
Yield (name, bf) pairs, where bf is a BoundField object. |
Method | _clean |
Undocumented |
Method | _clean |
Undocumented |
Method | _html |
Output HTML. Used by as_table(), as_ul(), as_p(). |
Method | _post |
An internal hook for performing additional cleaning after form cleaning is complete. Used for model validation in model forms. |
Method | _widget |
Undocumented |
Instance Variable | _bound |
Undocumented |
Instance Variable | _errors |
Undocumented |
Inherited from RenderableFormMixin
:
Method | as |
Render as <div> elements. |
Method | as |
Render as <p> elements. |
Method | as |
Render as <tr> elements excluding the surrounding <table> tag. |
Method | as |
Render as <li> elements excluding the surrounding <ul> tag. |
Inherited from RenderableMixin
(via RenderableFormMixin
):
Method | render |
Undocumented |
Update the content of `self._errors`. The `field` argument is the name of the field to which the errors should be added. If it's None, treat the errors as NON_FIELD_ERRORS. The `error` argument can be a single error, a list of errors, or a dictionary that maps field names to lists of errors. An "error" can be either a simple string or an instance of ValidationError with its message attribute set and a "list or dictionary" can be an actual `list` or `dict` or an instance of ValidationError with its `error_list` or `error_dict` attribute set. If `error` is a dictionary, the `field` argument *must* be None and errors will be added to the fields that correspond to the keys of the dictionary.
Return the field name with a prefix appended, if this Form has a prefix set. Subclasses may wish to override.
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__'.
Return initial data for field on form. Use initial data from the form or the field, in that order. Evaluate callable values.
Return a list of all the BoundField objects that are hidden fields. Useful for manual form layout in templates.
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.
Rearrange the fields according to field_order. field_order is a list of field names specifying the order. Append fields not included in the list in the default order for backward compatibility with subclasses not overriding field_order. If field_order is None, keep all fields in the order defined in the class. Ignore unknown fields in field_order to allow disabling fields in form subclasses without redefining ordering.
Return a list of BoundField objects that aren't hidden fields. The opposite of the hidden_fields() method.
Output HTML. Used by as_table(), as_ul(), as_p().
django.forms.models.BaseModelForm
An internal hook for performing additional cleaning after form cleaning is complete. Used for model validation in model forms.