class documentation

class AdminAuthenticationForm(AuthenticationForm): (source)

View In Hierarchy

A custom authentication form used in the admin app.

Method confirm_login_allowed Controls whether the given User may log in. This is a policy setting, independent of end-user authentication. This default behavior is to allow login by active users, and reject login by inactive users.
Class Variable error_messages Undocumented
Class Variable required_css_class Undocumented

Inherited from AuthenticationForm:

Method __init__ The 'request' parameter is set for custom auth use by subclasses. The form data comes in via the standard 'data' kwarg.
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 get_invalid_login_error Undocumented
Method get_user Undocumented
Class Variable password Undocumented
Class Variable username Undocumented
Instance Variable request Undocumented
Instance Variable user_cache Undocumented
Instance Variable username_field Undocumented

Inherited from BaseForm (via AuthenticationForm, Form):

Method __getitem__ Return a BoundField with the given name.
Method __iter__ Yield the form's fields as BoundField objects.
Method __repr__ 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_div 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 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.
Property template_name 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 _post_clean An internal hook for performing additional cleaning after form cleaning is complete. Used for model validation in model forms.
Method _widget_data_value Undocumented
Instance Variable _bound_fields_cache Undocumented
Instance Variable _errors Undocumented

Inherited from RenderableFormMixin (via AuthenticationForm, Form, BaseForm):

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

Method render Undocumented
def confirm_login_allowed(self, user): (source)

Controls whether the given User may log in. This is a policy setting, independent of end-user authentication. This default behavior is to allow login by active users, and reject login by inactive users. If the given user cannot log in, this method should raise a ``ValidationError``. If the given user may log in, this method should return None.

required_css_class: str = (source)

Undocumented