Created
January 26, 2018 16:55
-
-
Save MasterKale/ef4ed0d0057af58de8600bec983a8150 to your computer and use it in GitHub Desktop.
Django - User Model w/Email Username
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
from django import forms | |
from django.contrib import admin | |
from django.contrib.auth.admin import UserAdmin as BaseUserAdmin | |
from django.contrib.auth.forms import ReadOnlyPasswordHashField | |
from .models import ApiUser | |
class UserCreationForm(forms.ModelForm): | |
"""A form for creating new users. Includes all the required | |
fields, plus a repeated password.""" | |
password1 = forms.CharField(label="Password", widget=forms.PasswordInput) | |
password2 = forms.CharField(label="Password confirmation", widget=forms.PasswordInput) | |
class Meta: | |
model = ApiUser | |
fields = ( | |
"email", | |
) | |
def clean_password2(self): | |
# Check that the two password entries match | |
password1 = self.cleaned_data.get("password1") | |
password2 = self.cleaned_data.get("password2") | |
if password1 and password2 and password1 != password2: | |
raise forms.ValidationError("Passwords don't match") | |
return password2 | |
def save(self, commit=True): | |
# Save the provided password in hashed format | |
user = super(UserCreationForm, self).save(commit=False) | |
user.set_password(self.cleaned_data["password1"]) | |
if commit: | |
user.save() | |
return user | |
class UserChangeForm(forms.ModelForm): | |
"""A form for updating users. Includes all the fields on | |
the user, but replaces the password field with admin's | |
password hash display field. | |
""" | |
password = ReadOnlyPasswordHashField() | |
class Meta: | |
model = ApiUser | |
fields = ("email", "password", "is_active", "is_admin") | |
def clean_password(self): | |
# Regardless of what the user provides, return the initial value. | |
# This is done here, rather than on the field, because the | |
# field does not have access to the initial value | |
return self.initial["password"] | |
class UserAdmin(BaseUserAdmin): | |
# Forms for creating and editing users | |
form = UserChangeForm | |
add_form = UserCreationForm | |
list_display = ("email", "is_active", "is_admin") | |
list_filter = ("is_active",) | |
# Specify how to display users in the admin console | |
fieldsets = ( | |
(None, {"fields": ("email", "password")}), | |
("Permissions", {"fields": ("is_admin",)}), | |
) | |
# add_fieldsets is not a standard ModelAdmin attribute. Django"s UserAdmin | |
# overrides get_fieldsets to use this attribute when creating a user. | |
add_fieldsets = ( | |
( | |
None, | |
{ | |
"classes": ("wide",), | |
"fields": ("email", "password1", "password2") | |
} | |
), | |
) | |
search_fields = ("email",) | |
ordering = ("email",) | |
filter_horizontal = () | |
admin.site.register(ApiUser, UserAdmin) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
from django.db import models | |
from django.contrib.auth.models import AbstractBaseUser, BaseUserManager | |
class ApiUserManager(BaseUserManager): | |
def create_user(self, email, password=None): | |
if not email: | |
raise ValueError("An email address is required") | |
user = self.model( | |
email=self.normalize_email(email), | |
) | |
user.set_password(password) | |
user.save(using=self._db) | |
return user | |
def create_superuser(self, email, password): | |
user = self.create_user( | |
email=email, | |
password=password, | |
) | |
user.is_admin = True | |
user.save(using=self._db) | |
return user | |
class ApiUser(AbstractBaseUser): | |
""" | |
A user class that uses an email address as the user's username | |
""" | |
email = models.EmailField( | |
verbose_name="email address", | |
max_length=255, | |
unique=True, | |
) | |
is_active = models.BooleanField(default=True) | |
is_admin = models.BooleanField(default=False) | |
objects = ApiUserManager() | |
USERNAME_FIELD = "email" | |
REQUIRED_FIELDS = [] | |
def get_full_name(self): | |
return self.email | |
def get_short_name(self): | |
return self.email | |
def __str__(self): | |
return self.email | |
def has_perm(self, perm, obj=None): | |
"""Does the user have a specific permission?""" | |
# Simplest possible answer: Yes, always | |
return True | |
def has_module_perms(self, app_label): | |
"""Does the user have permissions to view the app `app_label`?""" | |
# Simplest possible answer: Yes, always | |
return True | |
@property | |
def is_staff(self): | |
"""Is the user a member of staff?""" | |
# Simplest possible answer: All admins are staff | |
return self.is_admin | |
class Meta: | |
verbose_name = "Dashboard User" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
""" | |
Place this at the bottom of the project's settings.py | |
""" | |
AUTH_USER_MODEL = "app_label.ApiUser" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment