naritoブログ

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

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

約316日前 2017年7月14日0:04
プログラミング関連
Django Python

概要


Djangoで、会員登録機能を自作するの1つです。

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


継承を使う際、大まかに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):
        """メールアドレスでの登録を必須にする"""
        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):
        """is_staff(管理サイトにログインできるか)と、is_superuer(全ての権限)をFalseに"""
        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):
        """スーパーユーザーは、is_staffとis_superuserをTrueに"""
        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)

    @property
    def username(self):
        """username属性のゲッター

        他アプリケーションが、username属性にアクセスした場合に備えて定義
        メールアドレスを返す
        """
        return self.email



settings.py


自分で作ったUserモデルをデフォルトで使用するように宣言する必要があります。
settings.pyに、以下を付け加えましょう。INSTALLED_APPSに、モデルを定義したアプリケーションを追加するのも忘れないでください。
# registerというアプリケーションです
AUTH_USER_MODEL = 'register.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)




デフォルトUserを使うか選ばせる場合


デフォルトのUserか、このカスタムユーザーかをユーザーに選択させる場合は、settings.pyに書いたAUTH_USER_MODELの値で判別ができます。
models.pyとadmin.pyにて以下のようにするだけです。
# registerのUserモデルを使う場合だけ、登録する
if settings.AUTH_USER_MODEL == 'register.User':
    # 以降、カスタムユーザーを使う際のモデル定義や、管理サイトのカスタマイズ


途中からユーザーをカスタムユーザーにしたい、といった場合は複雑になるので、どちらを使うか最初に選択してもらう必要があります。

参考
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/
django見習い 約30日前 2018年4月26日12:43 返信する
添付ファイルダウンロード(0FF53700-B9CC-48F8-9C18-107E0047D6C6.jpeg)
何度かデフォルトユーザーのままマイグレーションをし、途中からカスタムユーザーを使いたいなと思い、ファイルの書き換えをおこないました。
そしてマイグレーションファイルとキャッシュを全て削除したのちmigrateしようとすると次のようなエラーになるのですが、データベースのテーブルの削除か何かをしなければならないのでしょうか?
なりと 約29日前 2018年4月26日19:49
途中からカスタムユーザーに切り替えるのは中々に難しいです。手動でテーブルを変更したり、データの移行処理が必要になることもあります。ベストプラクティクスの1つとして「最初からカスタムユーザーモデルを定義だけしておく」というものがありますが、それもこのためです。
SQLに明るくない場合の楽な方法として、マイグレーションフォルダとdb.sqlite3(SQLiteの場合)を削除してしまい、初めから作り直すことです。移行するデータがあるのならば、各データの中身だけ取り出し、後でそれを入力します。入力作業はPythonスクリプトで自動で行うこともでき、個人的にはオススメな方法です。
django見習い 約29日前 2018年4月27日14:42 返信する
settings.pyの一部をコメントアウトする方法で解決しました。
最初からカスタムユーザーの定義だけしておくというやり方、とても参考になります。
現在このサイトを参考にウェブアプリケーションを作成していて、エラーと格闘しているので、近いうちにまた質問をさせていただくかもしれません。
その時はまたアドバイスを宜しくお願い致します。