naritoブログ

このブログはDjangoとBootstrap4で作成されました
ソースコード

Djangoで、Userモデルのカスタマイズ(継承)

プログラミング関連 Django Python 約34日前
2017年7月14日0:04
以前に
Djangoで、Userモデルのカスタマイズ(OneToOneで、別モデルと紐づける)
https://torina.top/detail/282/

という記事を書きました。
今回はもう少し見栄えの良い方法、継承を使ってUserモデルをカスタマイズしていきます。

DjangoのデフォルトのUserモデルでは、usernameというフィールドがあります。
しかし、Webアプリによってはusernameとしてemailを利用することも多く、この場合はusernameというフィールドが邪魔です。
今回はusernameをなくし、emailをメインに扱うモデルを作成します。

Django1.11
Python3.6
です。

継承を使う際、大まかに2つの方法があります。
django.contrib.auth.base_user.AbstractBaseUserを継承するか、
django.contrib.auth.models.AbstractUserを継承するか、です。

AbstractUserはデフォルトのUserモデルが持っている機能を全て持っているので、元々のUserモデルに何か修正をするというよりは、profileやphone_number、といった新しいフィールドを追加したい場合に継承するのが良さそうです。

AbstractBaseUserの継承は色々と面倒な部分が多いのですが、挙動を柔軟にカスタマイズできます。
今回はこちらを使います。

models.py


models.pyを、以下のように変更します。
https://github.com/django/django/blob/master/django/contrib/auth/models.py
AbstractUserのソースコードを殆ど借用しつつ、usernameの代わりにemailを使うようにしています。
from django.db import models
from django.core.mail import send_mail
from django.contrib.auth.models import PermissionsMixin
from django.contrib.auth.base_user import AbstractBaseUser
from django.utils.translation import ugettext_lazy as _
from django.utils import timezone
from django.contrib.auth.base_user import BaseUserManager


class UserManager(BaseUserManager):
    """ユーザーマネージャー."""

    use_in_migrations = True

    def _create_user(self, email, password, **extra_fields):
        """Create and save a user with the given username, email, and
        password."""
        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):
    """カスタムユーザーモデル."""

    email = models.EmailField(_('email address'), unique=True)
    first_name = models.CharField(_('first name'), max_length=30, blank=True)
    last_name = models.CharField(_('last name'), max_length=150, blank=True)

    is_staff = models.BooleanField(
        _('staff status'),
        default=False,
        help_text=_(
            'Designates whether the user can log into this admin site.'),
    )
    is_active = models.BooleanField(
        _('active'),
        default=True,
        help_text=_(
            'Designates whether this user should be treated as active. '
            'Unselect this instead of deleting accounts.'
        ),
    )
    date_joined = models.DateTimeField(_('date joined'), default=timezone.now)

    objects = UserManager()

    EMAIL_FIELD = 'email'
    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = []

    class Meta:
        verbose_name = _('user')
        verbose_name_plural = _('users')

    def get_full_name(self):
        """Return the first_name plus the last_name, with a space in
        between."""
        full_name = '%s %s' % (self.first_name, self.last_name)
        return full_name.strip()

    def get_short_name(self):
        """Return the short name for the user."""
        return self.first_name

    def email_user(self, subject, message, from_email=None, **kwargs):
        """Send an email to this user."""
        send_mail(subject, message, from_email, [self.email], **kwargs)



settings.py


自分で作ったUserモデルをデフォルトで使用するように宣言する必要があります。
settings.pyに、以下を付け加えましょう。
AUTH_USER_MODEL = 'app.User'



自作のログイン画面等を使う場合は問題ないのですが、デフォルトの/adminでこのカスタムユーザーを使う場合は少し処理を加える必要があります。

admin.py


複雑に見えるかもしれませんが、これも
https://github.com/django/django/blob/master/django/contrib/auth/admin.py
のコードが殆どです。
元々のUserモデルが使っていたusernameをemailに置き換え、使用しているFormもカスタムユーザーに合わせたものにしているだけです。
from django.contrib import admin
from django.contrib.auth.admin import UserAdmin
from django.contrib.auth.forms import UserChangeForm, UserCreationForm
from django.utils.translation import ugettext_lazy as _
from .models import User


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')}),
        (_('Personal info'), {'fields': ('first_name', 'last_name')}),
        (_('Permissions'), {'fields': ('is_active', 'is_staff', 'is_superuser',
                                       'groups', 'user_permissions')}),
        (_('Important dates'), {'fields': ('last_login', 'date_joined')}),
    )
    add_fieldsets = (
        (None, {
            'classes': ('wide',),
            'fields': ('email', 'password1', 'password2'),
        }),
    )
    form = MyUserChangeForm
    add_form = MyUserCreationForm
    list_display = ('email', 'first_name', 'last_name', 'is_staff')
    list_filter = ('is_staff', 'is_superuser', 'is_active', 'groups')
    search_fields = ('email', 'first_name', 'last_name')
    ordering = ('email',)


admin.site.register(User, MyUserAdmin)




参考
https://simpleisbetterthancomplex.com/tutorial/2016/07/22/how-to-extend-django-user-model.html
https://www.caktusgroup.com/blog/2013/08/07/migrating-custom-user-model-django/