Extension du modèle User avec des champs personnalisés dans Django

Question

Quelle est la meilleure façon d'étendre le modèle User (fourni avec l'application d'authentification de Django) avec des champs personnalisés ? J'aimerais aussi éventuellement utiliser l'adresse électronique comme nom d'utilisateur (à des fins d'authentification).

J'ai déjà vu un quelques moyens de le faire, mais je n'arrive pas à décider lequel est le meilleur.

Answer 1

La façon la moins pénible et d'ailleurs recommandée par Django de le faire est d'utiliser une propriété OneToOneField(User).

Cela dit, l'extension de django.contrib.auth.models.User fonctionne également mieux maintenant -- depuis le remaniement du code d'héritage de Django dans l'API des modèles.

Je ne voudrais surtout pas modifier la classe User dans l'arbre source de Django et/ou copier et modifier le module auth.

Answer 2

C'est comme ça que je fais.

#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'

Cela créera un profil d'utilisateur à chaque fois qu'un utilisateur sera enregistré, s'il est créé. Vous pouvez alors utiliser

  user.get_profile().whatever

Voici quelques informations supplémentaires tirées de la documentation

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

Mise à jour : Veuillez noter que AUTH_PROFILE_MODULE est déprécié depuis la v1.5 : https://docs.djangoproject.com/en/1.5/ref/settings/#auth-profile-module

Answer 3

Un certain temps s'est écoulé depuis 2008 et il est temps de trouver de nouvelles réponses. Depuis Django 1.5, vous serez en mesure de créer une classe d'utilisateur personnalisée. En fait, à l'heure où j'écris ces lignes, elle a déjà été intégrée dans master, vous pouvez donc l'essayer.

Il y a des informations à ce sujet dans docs ou, si vous voulez approfondir le sujet, en cet engagement .

Tout ce que vous avez à faire est d'ajouter AUTH_USER_MODEL aux paramètres avec le chemin vers la classe d'utilisateur personnalisée, qui étend soit AbstractBaseUser (version plus personnalisable) ou AbstractUser (plus ou moins ancienne classe d'utilisateur que vous pouvez étendre).

Pour les personnes qui ont la flemme de cliquer, voici un exemple de code (tiré de 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

Answer 4

Depuis Django 1.5, vous pouvez facilement étendre le modèle utilisateur et conserver une seule table dans la base de données.

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

Vous devez également la configurer comme classe d'utilisateur actuelle dans votre fichier de configuration.

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

Si vous souhaitez ajouter un grand nombre de préférences d'utilisateurs, l'option OneToOneField peut être un meilleur choix.

Une note pour les personnes développant des bibliothèques tierces : si vous devez accéder à la classe utilisateur, n'oubliez pas que les gens peuvent la modifier. Utilisez l'aide officielle pour obtenir la bonne classe

from django.contrib.auth import get_user_model

User = get_user_model()

Answer 5

Il existe une recommandation officielle sur le stockage d'informations supplémentaires sur les utilisateurs . Le Django Book aborde également ce problème dans la section Profils .