Django のカスタムフィールドを使用して User モデルを拡張する

https://stackoverflow.com/questions/44109

09-06-2019
|

質問

ユーザーモデル (Django の認証アプリにバンドルされている) をカスタムフィールドで拡張する最善の方法は何ですか?また、(認証目的で) 電子メールをユーザー名として使用したいと考えています。

私はすでに見ました少し方法やろうとしているのですが、どれが一番良いのか決められません。

解決

これを行う最も苦痛が少なく、実際に Django が推奨する方法は、 OneToOneField(User) 財産。

既存のユーザーモデルの拡張

…

関連情報を保存したい場合は、 User, を使用できます。一対一の関係追加情報のフィールドを含むモデルにコピーします。この 1 対 1 モデルは、サイトユーザーに関する非認証関連情報を保存する可能性があるため、プロファイルモデルと呼ばれることがよくあります。

とは言え、延長すると、 django.contrib.auth.models.User それを置き換えることも機能します...

カスタム User モデルの置き換え

一部の種類のプロジェクトには、Django の組み込みの認証要件がある場合があります。 User モデルが常に適切であるとは限りません。たとえば、一部のサイトでは、ユーザー名の代わりに電子メールアドレスを識別トークンとして使用する方が合理的です。

[編集: 2 つの警告と通知が続きます, 、これは かなり思い切った.]

私は、Django ソースツリー内の実際の User クラスを変更したり、認証モジュールをコピーして変更したりすることは絶対に避けたいと思います。

他のヒント

注記：この回答は非推奨です。Django 1.7 以降を使用している場合は、他の回答を参照してください。

これが私のやり方です。

#in models.py
from django.contrib.auth.models import User
from django.db.models.signals import post_save

class UserProfile(models.Model):  
    user = models.OneToOneField(User)  
    #other fields here

    def __str__(self):  
          return "%s's profile" % self.user  

def create_user_profile(sender, instance, created, **kwargs):  
    if created:  
       profile, created = UserProfile.objects.get_or_create(user=instance)  

post_save.connect(create_user_profile, sender=User) 

#in settings.py
AUTH_PROFILE_MODULE = 'YOURAPP.UserProfile'

これにより、ユーザーが作成された場合、保存されるたびにユーザープロファイルが作成されます。その後、使用できます

  user.get_profile().whatever

ドキュメントからの詳細情報は次のとおりです

http://docs.djangoproject.com/en/dev/topics/auth/#storing-Additional-information-about-users

アップデート： その点に注意してください AUTH_PROFILE_MODULE v1.5 以降は非推奨になりました。 https://docs.djangoproject.com/en/1.5/ref/settings/#auth-profile-module

2008 年から時間が経ち、新たな答えが求められる時期が来ました。Django 1.5 以降、カスタム User クラスを作成できるようになりました。実際、これを書いている時点ではすでに master にマージされているので、試してみることができます。

それに関する情報がいくつかありますドキュメントまたは、さらに深く掘り下げたい場合は、このコミット.

あなたがしなければならないのは追加することだけです AUTH_USER_MODEL カスタムユーザークラスへのパスを含む設定に、次のいずれかを拡張します。 AbstractBaseUser (よりカスタマイズ可能なバージョン) または AbstractUser (拡張できる古い User クラス)。

クリックするのが面倒な人のために、コード例を示します (以下から引用) ドキュメント):

from django.db import models
from django.contrib.auth.models import (
    BaseUserManager, AbstractBaseUser
)


class MyUserManager(BaseUserManager):
    def create_user(self, email, date_of_birth, password=None):
        """
        Creates and saves a User with the given email, date of
        birth and password.
        """
        if not email:
            raise ValueError('Users must have an email address')

        user = self.model(
            email=MyUserManager.normalize_email(email),
            date_of_birth=date_of_birth,
        )

        user.set_password(password)
        user.save(using=self._db)
        return user

    def create_superuser(self, username, date_of_birth, password):
        """
        Creates and saves a superuser with the given email, date of
        birth and password.
        """
        u = self.create_user(username,
                        password=password,
                        date_of_birth=date_of_birth
                    )
        u.is_admin = True
        u.save(using=self._db)
        return u


class MyUser(AbstractBaseUser):
    email = models.EmailField(
                        verbose_name='email address',
                        max_length=255,
                        unique=True,
                    )
    date_of_birth = models.DateField()
    is_active = models.BooleanField(default=True)
    is_admin = models.BooleanField(default=False)

    objects = MyUserManager()

    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = ['date_of_birth']

    def get_full_name(self):
        # The user is identified by their email address
        return self.email

    def get_short_name(self):
        # The user is identified by their email address
        return self.email

    def __unicode__(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

Django 1.5 以降では、ユーザーモデルを簡単に拡張して、データベース上に 1 つのテーブルを保持できるようになりました。

from django.contrib.auth.models import AbstractUser
from django.db import models
from django.utils.translation import ugettext_lazy as _

class UserProfile(AbstractUser):
    age = models.PositiveIntegerField(_("age"))

また、設定ファイルで現在のユーザークラスとして構成する必要があります。

# supposing you put it in apps/profiles/models.py
AUTH_USER_MODEL = "profiles.UserProfile"

多くのユーザーの設定を追加したい場合は、OneToOneField オプションを選択することをお勧めします。

サードパーティのライブラリを開発している人向けのメモ:ユーザークラスにアクセスする必要がある場合は、ユーザークラスが変更できることに注意してください。公式ヘルパーを使用して適切なクラスを取得する

from django.contrib.auth import get_user_model

User = get_user_model()

公式の推奨事項がありますユーザーに関する追加情報を保存する。Django Book のセクションでもこの問題について説明しています。プロフィール.

以下は、User を拡張する別のアプローチです。上記の 2 つのアプローチよりも明確で、簡単で、読みやすいと思います。

http://scottbarnham.com/blog/2008/08/21/extending-the-django-user-model-with-inheritance/

上記のアプローチを使用すると、次のようになります。

使う必要はありませんuser.get_profile().newattribute ユーザーに関連する追加情報にアクセスします
追加の新しい属性を介して直接アクセスできますユーザー.新しい属性

Django post save シグナルを使用してユーザーが作成されるたびに新しいエントリを作成することで、ユーザープロファイルを簡単に拡張できます

モデル.py

from django.db.models.signals import *
from __future__ import unicode_literals

class userProfile(models.Model):

    userName = models.OneToOneField(User, related_name='profile')
    city = models.CharField(max_length=100, null=True)

    def __unicode__(self):  # __str__
        return unicode(self.userName)

def create_user_profile(sender, instance, created, **kwargs):
    if created:
    userProfile.objects.create(userName=instance)

post_save.connect(create_user_profile, sender=User)

これにより、新しいユーザーが作成されたときに従業員インスタンスが自動的に作成されます。

ユーザーモデルを拡張し、ユーザーの作成中にさらに情報を追加したい場合は、django-betterforms (http://django-betterforms.readthedocs.io/en/latest/multiform.html）。これにより、userProfile モデルで定義されたすべてのフィールドを含むユーザー追加フォームが作成されます。

モデル.py

from django.db.models.signals import *
from __future__ import unicode_literals

class userProfile(models.Model):

    userName = models.OneToOneField(User)
    city = models.CharField(max_length=100)

    def __unicode__(self):  # __str__
        return unicode(self.userName)

フォーム.py

from django import forms
from django.forms import ModelForm
from betterforms.multiform import MultiModelForm
from django.contrib.auth.forms import UserCreationForm
from .models import *

class profileForm(ModelForm):

    class Meta:
        model = Employee
        exclude = ('userName',)


class addUserMultiForm(MultiModelForm):
    form_classes = {
        'user':UserCreationForm,
        'profile':profileForm,
    }

views.py

from django.shortcuts import redirect
from .models import *
from .forms import *
from django.views.generic import CreateView

class addUser(CreateView):
    form_class = addUserMultiForm
    template_name = "addUser.html"
    success_url = '/your url after user created'

    def form_valid(self, form):
        user = form['user'].save()
        profile = form['profile'].save(commit=False)
        profile.userName = User.objects.get(username= user.username)
        profile.save()
        return redirect(self.success_url)

addUser.html

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <form action="." method="post">
            {% csrf_token %}
            {{ form }}     
            <button type="submit">Add</button>
        </form>
     </body>
</html>

URL.py

from django.conf.urls import url, include
from appName.views import *
urlpatterns = [
        url(r'^add-user/$', addUser.as_view(), name='addDistributor'),
]

Django ユーザーモデル (UserProfile) を Pro のように拡張する

これはとても便利だと思いました: リンク

抜粋:

django.contrib.auth.models からのインポートユーザー

class Employee(models.Model):
    user = models.OneToOneField(User)
    department = models.CharField(max_length=100)

>>> u = User.objects.get(username='fsmith')
>>> freds_department = u.employee.department

Django 1.5 の新機能により、独自のカスタムユーザーモデルを作成できるようになりました (上記の場合、これを行うのは良いことだと思われます)。参照する「Django での認証のカスタマイズ」

おそらく 1.5 リリースで最もクールな新機能です。

これが私がやっていることであり、私の意見では、これを行うための最も簡単な方法です。新しいカスタマイズされたモデルのオブジェクトマネージャーを定義してから、モデルを定義します。

from django.db import models
from django.contrib.auth.models import PermissionsMixin, AbstractBaseUser, BaseUserManager

class User_manager(BaseUserManager):
    def create_user(self, username, email, gender, nickname, password):
        email = self.normalize_email(email)
        user = self.model(username=username, email=email, gender=gender, nickname=nickname)
        user.set_password(password)
        user.save(using=self.db)
        return user

    def create_superuser(self, username, email, gender, password, nickname=None):
        user = self.create_user(username=username, email=email, gender=gender, nickname=nickname, password=password)
        user.is_superuser = True
        user.is_staff = True
        user.save()
        return user



  class User(PermissionsMixin, AbstractBaseUser):
    username = models.CharField(max_length=32, unique=True, )
    email = models.EmailField(max_length=32)
    gender_choices = [("M", "Male"), ("F", "Female"), ("O", "Others")]
    gender = models.CharField(choices=gender_choices, default="M", max_length=1)
    nickname = models.CharField(max_length=32, blank=True, null=True)

    is_active = models.BooleanField(default=True)
    is_staff = models.BooleanField(default=False)
    REQUIRED_FIELDS = ["email", "gender"]
    USERNAME_FIELD = "username"
    objects = User_manager()

    def __str__(self):
        return self.username

このコード行を忘れずに追加してください。 settings.py:

AUTH_USER_MODEL = 'YourApp.User'

これは私がやっていることであり、常に機能します。

ライセンス： CC-BY-SA と帰属

所属していません StackOverflow

Django のカスタム フィールドを使用して User モデルを拡張する

既存のユーザーモデルの拡張

カスタム User モデルの置き換え

モデル.py

モデル.py

フォーム.py

views.py

addUser.html

URL.py

Django のカスタムフィールドを使用して User モデルを拡張する