Chapitre Django AllAuth Extension du modèle utilisateur Django AllAuth avec des champs personnalisés

REMARQUE : Cet article a été initialement publié sur mon Substack, à https://andresalvareziglesias.substack.com/

Ceci est le dernier chapitre de cette série d'articles Django AllAuth. Dans ces cinq chapitres, nous avons découvert une petite merveille, un composant Django vraiment utile pour gérer tous nos besoins d'authentification. Dans ce chapitre, nous allons apprendre comment étendre le modèle utilisateur de base de Django pour ajouter des champs personnalisés.

Liste des chapitres

• Chapitre 1 - La solution tout-en-un pour Auth dans Django
• Chapitre 2 - Comment installer et configurer Django AllAuth
• Chapitre 3 - Connexion sociale avec Django AllAuth
• Chapitre 4 - Personnalisation de l'interface utilisateur de Django AllAuth
• Chapitre 5 - Extension du modèle utilisateur Django AllAuth avec des champs personnalisés ←Celui-ci !

Modèle utilisateur Django

AllAuth utilise le modèle utilisateur standard de Django, ainsi que quelques tables supplémentaires pour gérer la connexion sociale et les jetons de connexion. Dans Django 5, le modèle utilisateur se trouve dans le package django.contrib.auth, et comporte un tas de champs prédéfinis, comme vous pouvez le lire dans la doc officielle :

• https://docs.djangoproject.com/en/5.0/ref/contrib/auth/

Parfois, cela ne suffit pas pour notre projet. Django vous permet de créer des tables d'utilisateurs et des gestionnaires d'utilisateurs personnalisés, pour répondre aux besoins de chaque projet.

Nous allons créer une table utilisateur personnalisée et un UserManager personnalisé pour gérer nos processus de connexion et d'enregistrement.

Création d'une table utilisateur personnalisée

Ouvrez models.py dans notre exemple de projet et écrivez un code comme celui-ci :

class MyCustomUser(AbstractBaseUser):
   email = models.EmailField(unique=True)
   first_name = models.CharField(max_length=30, blank=True)
   last_name = models.CharField(max_length=30, blank=True)
   is_active = models.BooleanField(default=True)
   is_admin = models.BooleanField(default=False)
   timezone = models.CharField(max_length=30, default='UTC')
   is_custom = models.BooleanField(default=False)
   is_staff = models.BooleanField(default=False)
   created_at = models.DateTimeField(auto_now_add=True)
   updated_at = models.DateTimeField(auto_now=True)

   objects = MyCustomUserManager()
   USERNAME_FIELD = 'email'
   EMAIL_FIELD = 'email'

   def __str__(self):
       return self.email
   def has_perm(self, perm, obj=None):
       return True
   def has_module_perms(self, app_label):
       return True

   @property
   def is_utc(self):
       return self.timezone == 'UTC'

Nous pouvons définir un nouveau modèle User s'étendant du modèle AbstractBaseUser de Django. Dans ce nouveau modèle, nous pouvons ajouter tous les champs ou propriétés personnalisées dont nous avons besoin.

Ces lignes sont importantes :

   objects = MyCustomUserManager()
   USERNAME_FIELD = 'email'
   EMAIL_FIELD = 'email'

Avec ces lignes, nous lions le modèle utilisateur à notre UserManager personnalisé, et nous définissons également le champ agissant comme un "nom d'utilisateur" unique.

N'oubliez pas d'enregistrer le nouveau modèle dans admin.py pour le gérer depuis l'outil d'administration Django.

from django.contrib import admin
from .models import MyCustomUser

admin.site.register(MyCustomUser)

Création d'un gestionnaire d'utilisateurs personnalisé

Ouvrez à nouveau models.py dans notre exemple de projet (ou générez un autre fichier pour le UserManager personnalisé si vous le souhaitez) et écrivez un code comme celui-ci :

class MyCustomUserManager(BaseUserManager):

   def create_user(self, email, password=None):
       if not email:
           raise ValueError('Users must have an email address')

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

       user.set_password(password)

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

   def create_superuser(self, email, password):
       user = self.create_user(
           email=email,
           password=password,
       )

       user.is_admin = True
       user.is_staff = True

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

Dans cet exemple, nous étendons BaseUserManager pour créer notre UserManager personnalisé. Il crée nos nouveaux utilisateurs et remplit les champs personnalisés comme prévu.

Nous avons défini avant le UserManager pour notre modèle User personnalisé, afin que Django sache quelle classe utiliser lors de la création d'un nouvel utilisateur.

Utilisation du gestionnaire d'utilisateurs et du modèle personnalisés

Dans le fichier de paramètres de notre projet, nous pouvons définir le modèle utilisateur actuel de notre projet avec :

# Set custom user model as the active one
AUTH_USER_MODEL = 'demo.MyCustomUser'

# Configure AllAuth username related management, because we are 
# using the e-mail as username. See:
# https://docs.allauth.org/en/latest/account/advanced.html
ACCOUNT_AUTHENTICATION_METHOD = 'email'
ACCOUNT_EMAIL_REQUIRED = True
ACCOUNT_UNIQUE_EMAIL = True
ACCOUNT_USERNAME_REQUIRED = False
ACCOUNT_USER_MODEL_USERNAME_FIELD = None

Avec juste ce petit changement (et la migration de base de données requise, comme d'habitude), nous pouvons commencer à créer des utilisateurs avec des vues d'inscription AllAuth pour voir notre brillant UserManager personnalisé et son modèle en action. Rapide et facile.

Nous désactivons également la gestion liée au nom d'utilisateur AllAuth, car nous utilisons l'e-mail comme nom d'utilisateur dans cet exemple.

Et c'est la fin... ou pas ?

Nous avons atteint le dernier chapitre de cette série AllAuth. AllAuth est une merveilleuse bibliothèque pour gérer l'authentification dans nos applications et facilite particulièrement le travail avec les connexions sociales, grâce à sa longue liste d'intégrations prédéfinies.

C'est le dernier chapitre de la série, mais je reviendrai sur AllAuth dans les prochains articles. Merci d'avoir lu et bon codage !

À propos de la liste

Parmi les articles Python et Docker, j'écrirai également sur d'autres sujets connexes (toujours des sujets de technologie et de programmation, promis... en croisant les doigts), comme :

• Architecture logicielle
• Environnements de programmation
• Système d'exploitation Linux
• Etc.

Si vous avez trouvé une technologie, un langage de programmation ou autre intéressant, n'hésitez pas à me le faire savoir ! Je suis toujours ouvert à apprendre quelque chose de nouveau !

À propos de l'auteur

Je m'appelle Andrés, un développeur de logiciels full-stack basé à Palma, en quête personnelle d'amélioration de mes compétences en codage. Je suis également un écrivain fantastique auto-publié avec quatre romans publiés à mon actif. N'hésitez pas à me demander n'importe quoi !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!