デフォルトのユーザーは後々変更を加えられえないのでカスタムユーザーを使う。というわけで、一番最初にしておいたほうがいい。AbstractUserを継承する方法とAbstractBaseUserを継承する方法があるが、AbstractBaseUserを継承するほうがカスタマイズ性が高い。いらなければ作るだけ作っておいて使わないという方法もあるのだが、色々と散らかるので好きじゃない。
目次
仮想環境作って、djangoとかインストール
まずはここから。
python -m venv venv
source venv/bin/activate
pip install django django-allauth django-environ mysqlclientプロジェクトとアプリを作成
プロジェクトはconfigで作っておくと、ディレクトリ構成がわかりやすい。
認証用にaccountsを作成する。
django-admin startproject config .
python manage.py startapp accountsファイル作成
accounts/models.py
createsuperuserのためにUserManagerを作成。
UserモデルをAbstractBaseUserとPermissionsMixinを継承して作成する。今回e-mail認証のみでusernameは不要だったが、allauth関係でusernameが必要だったので、emailを返すようにpropertyを付け加えた。
from django.db import models
from django.contrib.auth.models import PermissionsMixin
from django.contrib.auth.models import AbstractUser
from django.contrib.auth.base_user import AbstractBaseUser, BaseUserManager
from django.core.mail import send_mail
from django.utils import timezone
from django.utils.translation import gettext_lazy as _
import uuid
# Create your models here.
class UserManager(BaseUserManager):
use_in_migrations = True
def _create_user(self, email, password, **extra_fields):
if not email:
raise ValueError('The given email must be set')
email = self.normalize_email(email)
user = self.model(email=email, **extra_fields)
user.set_password(password)
user.save(using=self.db)
return user
def create_user(self, email, password=None, **extra_fields):
extra_fields.setdefault('is_staff', False)
extra_fields.setdefault('is_superuser', False)
return self._create_user(email, password, **extra_fields)
def create_superuser(self, email, password, **extra_fields):
extra_fields.setdefault('is_staff', True)
extra_fields.setdefault('is_superuser', True)
if extra_fields.get('is_staff') is not True:
raise ValueError('Superuser must have is_staff=True.')
if extra_fields.get('is_superuser') is not True:
raise ValueError('Superuser must have is_superuser=True.')
return self._create_user(email, password, **extra_fields)
class User(AbstractBaseUser, PermissionsMixin):
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
email = models.EmailField(_('email_address'), unique=True)
is_staff = models.BooleanField(_('staff_status'), default=False)
is_active = models.BooleanField(_('active'), default=True)
created_at = models.DateTimeField(_('created_date'), default=timezone.now)
updated_at = models.DateTimeField(_('updated_date'), default=timezone.now)
objects = UserManager()
USERNAME_FIELD = 'email'
EMAIL_FIELD = 'email'
REQUIRED_FIELDS = []
class Meta:
verbose_name = _('user')
verbose_name_plural = _('users')
swappable = 'AUTH_USER_MODEL'
def clean(self):
super().clean()
self.email = self.__class__.objects.normalize_email(self.email)
def email_user(self, subject, message, from_email=None, **kwargs):
send_mail(subject, message, from_email, [self.email], **kwargs)
# allauthでusernameが必要になるので。
@property
def username(self):
return self.emailaccounts/admin.py
管理ページのあれこれ。
from django.contrib import admin
from django.contrib.auth.admin import UserAdmin
from django.contrib.auth.forms import UserCreationForm, UserChangeForm
from django.utils.translation import gettext_lazy as _
from .models import User
# Register your models here.
class MyUserChangeForm(UserChangeForm):
class Meta:
model = User
fields = '__all__'
class MyUserCreationForm(UserCreationForm):
class Meta:
model = User
fields = ('email',)
class MyUserAdmin(UserAdmin):
fieldsets = (
(None, {'fields': ('email', 'password')}),
(_('Permissions'), {'fields': ('is_active', 'is_staff', 'is_superuser',)}),
(_('Important dates'), {'fields': ('last_login', 'created_at', 'updated_at')}),
)
add_fieldsets = (
(None, {
'classes': ('wide',),
'fields': ('email', 'password1', 'password2')
})
)
form = MyUserChangeForm
add_form = MyUserCreationForm
list_display = ('email', 'is_staff')
list_filter = ('is_staff', 'is_superuser', 'is_active',)
search_fields = ('email',)
ordering = ('email',)
admin.site.register(User, MyUserAdmin)accounts/forms.py
form関係。
from django.contrib.auth import get_user_model
from django.contrib.auth.forms import UserCreationForm, UserChangeForm
class CustomUserCreationForm(UserCreationForm):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.fields['email'].required = True
class Meta:
model = get_user_model()
fields = ['email']
labels = {'email': 'メールアドレス'}
help_texts = {'email': ''}
class CustomUserChangeForm(UserChangeForm):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.fields['email'].required = True
class Meta:
model = get_user_model()
fields = ['email', ]
labels = {
'email': 'メールアドレス',
}
help_texts = {
'email': '',
}accounts/adapter.py
カスタムフィールドを保存する際に、デフォルトのsave_userを上書きする必要がある。
from allauth.account.adapter import DefaultAccountAdapter
class AccountAdapter(DefaultAccountAdapter):
def save_user(self, request, user, form, commit):
user = super().save_user(request, user, form, commit=False)
# user.age = form.cleaned_data.get('age') # example
user.save()django-rest-authを使うとき、save_userの引数にcommitが入っているとエラーが出た。
TypeError: AccountAdapter.save_user() missing 1 required positional argument: 'commit'ので、django-rest-authを使うときは、引数のcommitは削除する。
