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


442

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

すでにいくつかの 方法を見てきましたが、どれが最適かを判断できません。


24
ほとんどの回答は時代遅れ/非推奨です。stackoverflow.com/a/22856042/781695とstackoverflow.com/q/14104677/781695とstackoverflow.com/q/16880461/781695を参照してください
ユーザー

@buffer-リンクした最初の質問(stackoverflow.com/a/22856042/781695)が削除されました。他はまだ有効です。
Tony

3
認証にユーザー名の代わりにメールを使用するには、この記事が役立ちます。


質問はDjangoがリリースされる前の2008年に@Farinha
Tessaracter

回答:


253

最も苦痛が少なく、実際にDjangoが推奨する方法は、OneToOneField(User)プロパティを使用する方法です。

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

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

とはdjango.contrib.auth.models.Userいえ、それを拡張して置き換えることもうまくいきます...

カスタムユーザーモデルの置き換え

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

[編集:2つの警告と1つの通知が続き、これはかなり劇的だと述べています。]

私は間違いなく、Djangoソースツリーの実際のUserクラスを変更したり、authモジュールをコピーしたり変更したりすることは避けます。


50
FYI新しい(1.0+)が推奨する方法は、(ユーザー)OneToOneFieldさdocs.djangoproject.com/en/dev/topics/auth/...
デイブForgac

2
PBSのShawn Riderは、django.contrib.auth.models.Userを拡張してはならない理由をいくつか示しました。代わりにOneToOneField(User)を使用してください。
pydanny 2011年

2
user = models.ForeignKey(User, unique=True)これは同じuser = models.OneToOneField(User)ですか?最終的な効果は同じだと思いますか?しかし、おそらくバックエンドでの実装は異なります。
Sam Stoelinga

7
だれでもそれのためのショーンライダーの議論/推論にリンクできますか?
Jeremy Blanchard、

1
django 1.7ドキュメントのユーザーモデルの拡張に関する追加情報を次に示します
Derek Adair

226

注:この回答は非推奨です。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バージョン1.5で廃止されました:https://docs.djangoproject.com/en/1.5/ref/settings/#auth-profile-module


6
明確な例をありがとう、def create_user ....はUserProfileクラスの一部ではなく、左揃えにする必要があることに注意してください。
PhoebeB 2010

5
このソリューションでは、他のモデルのForeignKeyをUserまたはUserProfileにする必要がありますか?
andrewrk

9
他のモデルはを使用しuser = models.ForeignKey( User )、を介してプロファイルオブジェクトを取得する必要がありますuser.get_profile()。を忘れないでくださいfrom django.contrib.admin.models import User
クレイグトレーダー

1
この方法を使用すると、通常の情報(名前、パスワード)とカスタム情報を取得するときに分離する必要がありますか、それを一度に行う方法はありますか?新しいユーザーの作成についても同じですか?
Martin Trigaux、

5
この回答とコメントは古くなっています。たとえば、AUTH_PROFILE_MODULEは廃止されましたUser
ユーザー

196

さて、2008年からしばらく経ちましたが、今こそ新たな答えを出す時です。Django 1.5以降では、カスタムUserクラスを作成できます。実際、これを書いている時点では、すでにマスターにマージされているので、試してみることができます。

ドキュメントにそれに関するいくつかの情報があります、またはあなたがそれをより深く掘り下げたいならば、このコミットで

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

クリックするのが面倒な人のために、次のコード例(docsから取得)を示します。

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

create_user関数はユーザー名を保存していないようですが、どうですか?
オルカ2013

6
この例でemailは、ユーザー名です。
OndrejSlinták2013

5
unique=Trueメールフィールドに追加してUSERNAME_FIELD受け入れる必要があります
Richard de Wit

こんにちは、私はあなたが言ったようにカスタムユーザーを作成しようとしていましたが、カスタムユーザーのメールのメールを使用してログインできませんでした。理由を言ってもいいですか?
ライオネル

詳細なしでは、私は本当にあなたを助けることはできません。新しい質問を作成した方がよいでしょう。
OndrejSlinták14年

47

Django 1.5以降では、ユーザーモデルを簡単に拡張して、データベースに単一のテーブルを保持できます。

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()

3
を使用する予定がある場合はdjango_social_auth、OneToOne関係を使用することをお勧めします。この方法は使用しないでください。使用すると、移行が失敗します。
Nimo 2014年

@Nimo:参考文献を詳しく説明または引用してください
ユーザー

@buffer、長い間戻ってきましたが、django_social_authプラグインを組み合わせて、AUTH_USER_MODELをソーシャル認証ユーザーに定義してみたと思います。次に、manage.py migrateを実行すると、アプリがめちゃくちゃになりました。代わりに、ソーシャル認証ユーザーモデルをOneToOne関係として使用した場合、ここで説明します。stackoverflow.com
q

3
多分に関係していChanging this setting after you have tables created is not supported by makemigrations and will result in you having to manually write a set of migrations to fix your schema出典:docs.djangoproject.com/en/dev/topics/auth/customizing/...
ユーザー


23

以下は、ユーザーを拡張する別のアプローチです。私はそれが2つのアプローチよりも明確で、簡単で、読みやすいと感じています。

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

上記のアプローチを使用する:

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

1
私は、モデルから直接外れるのではなく、Userオブジェクトの継承に基づいて、Scottのアプローチがはるかに好きです。このアプローチが賢明でない場合、誰かが言うことができますか?
BozoJoe

1
@BozoJoe -私はこの方法を使用しての結果であると思わダンプ・データをインポートするこの問題、に走った:stackoverflow.com/questions/8840068/...
ベンRegenspan

15

Djangoポスト保存信号を使用してユーザーが作成されるたびに新しいエントリを作成することで、ユーザープロファイルを単純に拡張できます

models.py

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

class UserProfile(models.Model):

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

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

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

post_save.connect(create_user_profile, sender=User)

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

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

models.py

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

class UserProfile(models.Model):

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

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

forms.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 = ('user_name',)


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 = "add-user.html"
    success_url = '/your-url-after-user-created'

    def form_valid(self, form):
        user = form['user'].save()
        profile = form['profile'].save(commit=False)
        profile.user_name = 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>

urls.py

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

こんにちは、この答えをありがとう。urls.py..anyヒントですべてをリンクする方法を理解するのにまだ苦労していますか?
2016年

@salすぐに確認できるURLの例を追加
Atul Yadav

ありがとう!! とても助かります。良い例
Sunny Chaudhari 2017年

@AtulYadav ..使用したDjangoのバージョンは何ですか?
リド2017

8

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

これは非常に便利だと思いました:リンク

抽出物:

django.contrib.auth.models import Userから

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

2
できました。なぜ-1なのかわかりません。この場合、反対票よりも編集の方が優れています。
Massimo Variolo 2016

3

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

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


1
はい、そうです。ただし、必要でない限りこれを回避する必要があることに注意してください。文書化された結果に満足できる場合を除いて、この質問の理由で独自の実装は完全に有効です。フィールドを単純に追加する場合は、通常のユーザーモデルとの関係をお勧めします。
gertvdijk 2013年

2

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

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'

これは私が行うことであり、常に機能します。



0

シンプルで効果的なアプローチはmodels.pyです

from django.contrib.auth.models import User
class CustomUser(User):
     profile_pic = models.ImageField(upload_to='...')
     other_field = models.CharField()
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.