Utilisateurs personnalisés et enregistrement avec validation par email en utilisant Django et django-registration

En utilisant Django j’ai eu à mettre en place des utilisateurs personnalisés et un système d’authentification nécessitant la validation par courriel. Ce petit tutoriel vous expliquera comment faire cela avec Django 1.10 et le module django-registration.

Configuration de l’email

Dans un premier temps il faut configurer le courriel pour Django. La configuration présentée est valide uniquement pour un environnement de développement. En production il faudra utiliser le backend smtp. Pour tester le courriel en cours de développement ajouter ceci dans le fichier settings.py de votre projet :

# Email
EMAIL_BACKEND = 'django.core.mail.backends.filebased.EmailBackend'
EMAIL_FILE_PATH = '/tmp/djangomail/'
EMAIL_SUBJECT_PREFIX = "[DjangoTest] "
EMAIL_TIMEOUT = 3
EMAIL_HOST_USER = "fakeuser@fakeemail.com"

Création d’un modèle utilisateur personnalisé

D’abord, il faut créer une application (nommé “customuser” ici), cette création peut s’effectuer via la commande “python manage.py startapp customuser”. Ensuite, il est nécessaire de créer le modèle de l’utilisateur dans le fichier models.py.

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


class User(AbstractUser):
    """
    On fait hériter notre classe User de AbstractUser pour avoir les groupes, les permissions, le nom, l'email, etc. 
    Si vous n'avez pas besoin de ces fonctionnalités vous pouvez hériter de BaseAbstractUser
    """
    # modification du champ username
    username = models.CharField(max_length=255, unique=True, verbose_name=_("Username")) 
    # modification du champ email
    email = models.EmailField(unique=True, verbose_name=_("Email Address"))
    # ajout du champ animal préféré à l'utilisateur
    favorite_animal = models.CharField(max_length=255, verbose_name=_("Favorite Animal")) 

Configurer Django pour utiliser notre modèle utilisateur

Pour cela il faut encore modifier le fichier settings.py du projet.

# définit le modèle utilisateur à utiliser pour le système d'authentification
AUTH_USER_MODEL = 'customuser.User'

# Ajout de notre application contenant notre modèle utilisateur aux applications
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'customuser',
]

Ajout de templates

Pour la suite, afin de pouvoir tester notre site web nous allons avoir besoin de templates. Il existe des templates fonctionnelles, mais pas très jolies, à télécharger. Extrayez l’archive dans un dossier “templates” que vous avez créée à la racine de votre projet. Vous pourrez les personnaliser après le tutoriel.

Ajout des URLs pour le module django-registration

Dans le fichier urls.py du projet il faut rajouter des URLs pour rendre le projet fonctionnel.

from django.conf.urls import url, include
from django.contrib import admin

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    # ajout des urls que nous créerons dans l'application customuser
    url(r'^accounts/', include('customuser.urls')),
    # ajout des urls de django-registration (celles utilisant les templates installées)
    url(r'^accounts/', include('registration.backends.hmac.urls')),
]

Création du formulaire d’inscription personnalisé

La configuration des URLs faite précédemment nous permet de remplacer les divers formulaires par défaut de django-registration. Par exemple, nous pouvons créer notre propre formulaire d’enregistrement dans le fichier forms.py de notre application.

from registration.forms import RegistrationForm
from customuser.models import User

class CustomUserForm(RegistrationForm):
    """
    Formulaire d'enregistrement personnalisé. 
    """
    class Meta:
        # utilisation de notre modèle
        model = User
        # ajout des champs username, favorite_animal et email. 
        # Le champ password est ajouté automatiquement par la classe parente 
        fields = ["username", "favorite_animal", "email"]

Pour que le formulaire soit fonctionnel il faut modifier le fichier urls.py de notre application.

from django.conf.urls import url
from registration.backends.hmac.views import RegistrationView
from customuser.forms import CustomUserForm

urlpatterns = [
    # la vue d'enregistrement de l'utilisateur doit utiliser notre formulaire personnalisé
    url(r'^register/$', RegistrationView.as_view(form_class=CustomUserForm), name='registration_register'),
]

Rendre l’interface d’administration plus jolie (optionnel)

Si vous souhaitez voir plus clairement vos utilisateurs via l’interface administration vous pouvez modifier le fichier admin.py de votre application.

from django.contrib import admin
from customuser.models import User


class UserAdmin(admin.ModelAdmin):
    """
    choix des champs et de leurs divers fonctions
    """
    list_display = ['username', 'email']
    list_filter = ['username', 'email']
    ordering = ['username', 'email']
    search_fields = ['username', 'email']

# application de nos choix pour le modèle utilisateur
admin.site.register(User, UserAdmin)

Utilisateurs personnalisés et enregistrement avec validation par email en utilisant Django et django-registration par La Réponse est 42 est sous Licence Creative Commons Internationale Attribution-Partage à l'identique 4.0.