Package django :: Package contrib :: Package auth :: Module models :: Class User

Class User

db.models.Model --+
                  |
                 User

Users within the Django authentication system are represented by this model.

Username and password are required. Other fields are optional.

Nested Classes

[hide private]

is_anonymous(self)

source code

Always returns False. This is a way of comparing User objects to anonymous users.

is_authenticated(self)

source code

Always return True. This is a way to tell if the user has been authenticated in templates.

check_password(self, raw_password)

source code

Returns a boolean of whether the raw_password was correct. Handles encryption formats behind the scenes.

get_group_permissions(self)

source code

Returns a list of permission strings that this user has through his/her groups. This method queries all available auth backends.

has_perm(self, perm)

source code

Returns True if the user has the specified permission. This method queries all available auth backends, but returns immediately if any backend returns True. Thus, a user who has permission from a single auth backend is assumed to have permission in general.

has_module_perms(self, app_label)

source code

Returns True if the user has any permissions in the given app label. Uses pretty much the same logic as has_perm, above.

get_profile(self)

source code

Returns site-specific profile for this user. Raises SiteProfileNotAvailable if this site does not allow profiles.

Class Variable Details

[hide private]

username

Value:

models.CharField(_('username'), max_length= 30, unique= True, validato
r_list= [validators.isAlphaNumeric], help_text= _("Required. 30 charac
ters or fewer. Alphanumeric characters only (letters, digits and under
scores)."))

first_name

Value:

models.CharField(_('first name'), max_length= 30, blank= True)

last_name

Value:

models.CharField(_('last name'), max_length= 30, blank= True)

password

Value:

models.CharField(_('password'), max_length= 128, help_text= _("Use '[a
lgo]$[salt]$[hexdigest]' or use the <a href=\"password/\">change passw
ord form</a>."))

is_staff

Value:

models.BooleanField(_('staff status'), default= False, help_text= _("D
esignates whether the user can log into this admin site."))

is_active

Value:

models.BooleanField(_('active'), default= True, help_text= _("Designat
es whether this user should be treated as active. Unselect this instea
d of deleting accounts."))

is_superuser

Value:

models.BooleanField(_('superuser status'), default= False, help_text= 
_("Designates that this user has all permissions without explicitly as
signing them."))

last_login

Value:

models.DateTimeField(_('last login'), default= datetime.datetime.now)

date_joined

Value:

models.DateTimeField(_('date joined'), default= datetime.datetime.now)

groups

Value:

models.ManyToManyField(Group, verbose_name= _('groups'), blank= True, 
help_text= _("In addition to the permissions manually assigned, this u
ser will also get all permissions granted to each group he/she is in."
))

user_permissions

Value:

models.ManyToManyField(Permission, verbose_name= _('user permissions')
, blank= True, filter_interface= models.HORIZONTAL)