class documentation
class User(AbstractUser): (source)
Users within the Django authentication system are represented by this model. Username and password are required. Other fields are optional.
Class |
|
Undocumented |
Inherited from AbstractUser
:
Method | clean |
Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS. |
Method | email |
Send an email to this user. |
Method | get |
Return the first_name plus the last_name, with a space in between. |
Method | get |
Return the short name for the user. |
Constant | EMAIL |
Undocumented |
Constant | REQUIRED |
Undocumented |
Constant | USERNAME |
Undocumented |
Class Variable | date |
Undocumented |
Class Variable | first |
Undocumented |
Class Variable | is |
Undocumented |
Class Variable | is |
Undocumented |
Class Variable | last |
Undocumented |
Class Variable | objects |
Undocumented |
Class Variable | username |
Undocumented |
Class Variable | username |
Undocumented |
Instance Variable | email |
Undocumented |
Inherited from AbstractBaseUser
(via AbstractUser
):
Class Method | get |
Undocumented |
Class Method | normalize |
Undocumented |
Method | __str__ |
Undocumented |
Method | check |
Return a boolean of whether the raw_password was correct. Handles hashing formats behind the scenes. |
Method | get |
Return an HMAC of the password field. |
Method | get |
Return the username for this User. |
Method | has |
Return False if set_unusable_password() has been called for this user. |
Method | natural |
Undocumented |
Method | save |
Save the current instance. Override this in a subclass if you want to control the saving process. |
Method | set |
Undocumented |
Method | set |
Undocumented |
Class Variable | last |
Undocumented |
Instance Variable | password |
Undocumented |
Property | is |
Always return False. This is a way of comparing User objects to anonymous users. |
Property | is |
Always return True. This is a way to tell if the user has been authenticated in templates. |
Instance Variable | _password |
Undocumented |
Inherited from PermissionsMixin
(via AbstractUser
, AbstractBaseUser
):
Method | get |
Undocumented |
Method | get |
Return a list of permission strings that this user has through their groups. Query all available auth backends. If an object is passed in, return only permissions matching this object. |
Method | get |
Return a list of permission strings that this user has directly. Query all available auth backends. If an object is passed in, return only permissions matching this object. |
Method | has |
Return True if the user has any permissions in the given app label. Use similar logic as has_perm(), above. |
Method | has |
Return True if the user has the specified permission. Query all available auth backends, but return immediately if any backend returns True. Thus, a user who has permission from a single auth backend is assumed to have permission in general... |
Method | has |
Return True if the user has each of the specified permissions. If object is passed, check if the user has all required perms for it. |
Class Variable | groups |
Undocumented |
Class Variable | is |
Undocumented |
Class Variable | user |
Undocumented |
Inherited from Model
(via AbstractUser
, AbstractBaseUser
, PermissionsMixin
):
Class Method | check |
Undocumented |
Class Method | from |
Undocumented |
Method | __eq__ |
Undocumented |
Method | __getstate__ |
Hook to allow choosing the attributes to pickle. |
Method | __hash__ |
Undocumented |
Method | __init__ |
Undocumented |
Method | __reduce__ |
Undocumented |
Method | __repr__ |
Undocumented |
Method | __setstate__ |
Undocumented |
Method | clean |
Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur. |
Method | date |
Undocumented |
Method | delete |
Undocumented |
Method | full |
Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur. |
Method | get |
Undocumented |
Method | get |
Return a set containing names of deferred fields for this instance. |
Method | prepare |
Undocumented |
Method | refresh |
Reload field values from the database. |
Method | save |
Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending. |
Method | serializable |
Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there's no Field object with this name on the model, return the model attribute's value. |
Method | unique |
Undocumented |
Method | validate |
Undocumented |
Method | validate |
Check unique constraints on the model and raise ValidationError if any failed. |
Class Variable | pk |
Undocumented |
Class Method | _check |
Undocumented |
Class Method | _check |
Undocumented |
Class Method | _check |
Undocumented |
Class Method | _check |
Forbid field shadowing in multi-table inheritance. |
Class Method | _check |
Perform all field checks. |
Class Method | _check |
Check if `id` field is a primary key. |
Class Method | _check |
Check the value of "index_together" option. |
Class Method | _check |
Check fields, names, and conditions of indexes. |
Class Method | _check |
Undocumented |
Class Method | _check |
Check that any auto-generated column names are shorter than the limits for each database in which the model will be created. |
Class Method | _check |
Check if no relationship model is used by more than one m2m field. |
Class Method | _check |
Perform all manager checks. |
Class Method | _check |
Undocumented |
Class Method | _check |
Undocumented |
Class Method | _check |
Check "ordering" option -- is it a list of strings and do all fields exist? |
Class Method | _check |
Undocumented |
Class Method | _check |
Undocumented |
Class Method | _check |
Check if the swapped model exists. |
Class Method | _check |
Check the value of "unique_together" option. |
Class Method | _get |
Undocumented |
Method | _do |
Do an INSERT. If returning_fields is defined then this method should return the newly created data for the model. |
Method | _do |
Try to update the model. Return True if the model was updated (if an update query was done and a matching row was found in the DB). |
Method | _get_ |
Undocumented |
Method | _get |
Undocumented |
Method | _get_next_or_previous_by_ |
Undocumented |
Method | _get |
Undocumented |
Method | _get |
Undocumented |
Method | _get |
Return a list of checks to perform. Since validate_unique() could be called from a ModelForm, some fields may have been excluded; we can't perform a unique check on a model that is missing fields involved in that check... |
Method | _perform |
Undocumented |
Method | _perform |
Undocumented |
Method | _prepare |
Undocumented |
Method | _save |
Save all the parents of cls using values from self. |
Method | _save |
Do the heavy-lifting involved in saving. Update or insert the data for a single table. |
Method | _set |
Undocumented |
Instance Variable | _order |
Undocumented |
Instance Variable | _prefetched |
Undocumented |
Instance Variable | _state |
Undocumented |