{"id":5917,"date":"2022-11-29T01:23:07","date_gmt":"2022-11-29T01:23:07","guid":{"rendered":"https:\/\/www.pythontutorial.net\/?page_id=5917"},"modified":"2023-08-17T09:33:36","modified_gmt":"2023-08-17T09:33:36","slug":"django-registration","status":"publish","type":"page","link":"https:\/\/www.pythontutorial.net\/django-tutorial\/django-registration\/","title":{"rendered":"Django Registration"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn how to create a Django registration form that allows users to sign up.<\/p>\n\n\n\n

This tutorial begins where the Django login\/logout tutorial<\/a> left off.<\/p>\n\n\n\n

Creating a Django registration form #<\/a><\/h2>\n\n\n\n

First, define a registration URL in the urls.py<\/code> of the users<\/code> app:<\/p>\n\n\n

from<\/span> django.urls import<\/span> path\n<\/span><\/span>from<\/span> . import<\/span> views\n<\/span><\/span>\n<\/span><\/span>urlpatterns = [\n<\/span><\/span>    path('login\/'<\/span>, views.sign_in, name='login'<\/span>),\n<\/span><\/span>    path('logout\/'<\/span>, views.sign_out, name='logout'<\/span>),\n<\/span><\/span>    path('register\/'<\/span>, views.sign_up, name='register'<\/span>),\n<\/span><\/mark>]\n<\/span><\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Second, define a RegisterForm<\/code> class in the forms.py<\/code> of the users.py<\/code> file:<\/p>\n\n\n
from<\/span> django import<\/span> forms\n<\/span><\/span>from<\/span> django.contrib.auth.models import<\/span> User\n<\/span><\/span>from<\/span> django.contrib.auth.forms import<\/span> UserCreationForm\n<\/span><\/span>\n<\/span><\/span>\n<\/span><\/span>class<\/span> LoginForm<\/span>(forms.Form)<\/span>:<\/span>\n<\/span><\/span>    username = forms.CharField(max_length=65<\/span>)\n<\/span><\/span>    password = forms.CharField(max_length=65<\/span>, widget=forms.PasswordInput)\n<\/span><\/span>    \n<\/span><\/span>\n<\/span><\/span>class<\/span> RegisterForm<\/span>(UserCreationForm)<\/span>:<\/span>\n<\/span><\/mark>    class<\/span> Meta<\/span>:<\/span>\n<\/span><\/mark>        model=User\n<\/span><\/mark>        fields = ['username'<\/span>,'email'<\/span>,'password1'<\/span>,'password2'<\/span>] \n<\/span><\/mark>   \n<\/span><\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The RegisterForm<\/code> uses the built-in User<\/code> model and includes four fields including username<\/code>, email<\/code>, password1<\/code>, and password2<\/code>, which the user needs to fill in for registration.<\/p>\n\n\n\n
Third, define the sign_up()<\/code> view function in the views.py<\/code> of the users<\/code> app:<\/p>\n\n\n
from<\/span> django.shortcuts import<\/span> render, redirect\n<\/span><\/span>from<\/span> django.contrib import<\/span> messages\n<\/span><\/span>from<\/span> django.contrib.auth import<\/span> login, authenticate, logout\n<\/span><\/span>from<\/span> .forms import<\/span> LoginForm, RegisterForm\n<\/span><\/mark>\n<\/span><\/span>def<\/span> sign_up<\/span>(request)<\/span>:<\/span>\n<\/span><\/mark>    if<\/span> request.method == 'GET'<\/span>:\n<\/span><\/mark>        form = RegisterForm()\n<\/span><\/mark>        return<\/span> render(request, 'users\/register.html'<\/span>, { 'form'<\/span>: form})   \n<\/span><\/mark><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The sign_up()<\/code> view function creates the RegisterForm<\/code> object and renders it in the register.html<\/code> template.<\/p>\n\n\n\n
Fourth, create a register.html<\/code> template in the templates\/users<\/code> directory of the users<\/code> application:<\/p>\n\n\n
{% extends 'base.html' %}\n\n{% block content %}\n\n<form<\/span> method<\/span>=\"POST\"<\/span> novalidate<\/span>><\/span>\n\t{% csrf_token %}\n\t<h2<\/span>><\/span>Sign Up<\/h2<\/span>><\/span>\n\t{{ form.as_p }}\t\t\n\t<input<\/span> type<\/span>=\"submit\"<\/span> value<\/span>=\"Register\"<\/span> \/><\/span>\n<\/form<\/span>><\/span>\n\n{% endblock content%}<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
The registerl.html<\/code> extends the base.html<\/code> template of the project. It renders the RegisterForm<\/code> (form). <\/p>\n\n\n\n
Note that the novalidate<\/code> property removes the HTML5 validation. Once completing the project, you can remove this property to enable HTML5 validation.<\/p>\n\n\n\n
Finally, open the registration URL:<\/p>\n\n\n
http://127.0.0.1:8000\/register\/<\/code><\/span>Code language:<\/span> plaintext<\/span> (<\/span>plaintext<\/span>)<\/span><\/small><\/pre>\n\n\n
…you’ll see the registration form as follows:<\/p>\n\n\n\n
\"djang<\/figure>\n\n\n\n
Customize the Django register form #<\/a><\/h2>\n\n\n\n
The registration form has four fields with a lot of information. This information comes from the default User<\/code> model. <\/p>\n\n\n\n
If you want to customize the information displayed on the form, you can modify the register.html<\/code> template as follows:<\/p>\n\n\n
{% extends 'base.html' %}\n\n{% block content %}\n<form<\/span> method<\/span>=\"POST\"<\/span> novalidate<\/span>><\/span>\n\t{% csrf_token %}\n\t<h2<\/span>><\/span>Sign Up<\/h2<\/span>><\/span>\n\t\t\n\t{% for field in form %}\n\t<p<\/span>><\/span>\n\t\t{% if field.errors %}\n\t\t<ul<\/span> class<\/span>=\"errorlist\"<\/span>><\/span>\n\t\t\t{% for error in field.errors %}\n\t\t\t<li<\/span>><\/span>{{ error }}<\/li<\/span>><\/span>\n\t\t\t{% endfor %}\n\t\t<\/ul<\/span>><\/span>\n\t\t{% endif %}\n\t \t{{ field.label_tag }} {{ field }}\n\t<\/p<\/span>><\/span>\n\t{% endfor %}\n\t<input<\/span> type<\/span>=\"submit\"<\/span> value<\/span>=\"Register\"<\/span> \/><\/span>\n<\/form<\/span>><\/span>\n{% endblock content%}<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
The template iterates over fields of the form and outputs each field individually. For each field, it displays the error list if the validation fails.<\/p>\n\n\n\n
The new form will look like this:<\/p>\n\n\n\n
\"djang<\/figure>\n\n\n\n
If you fill out the information and click register, you’ll get an error because we haven’t added the code that handles the HTTP  POST request.<\/p>\n\n\n\n
Handling Registration logic #<\/a><\/h2>\n\n\n\n
To handle the HTTP POST request, you modify the sign_up()<\/code> function in the views.py<\/code> file of the users<\/code> application:<\/p>\n\n\n
def<\/span> sign_up<\/span>(request)<\/span>:<\/span>\n<\/span><\/span>    if<\/span> request.method == 'GET'<\/span>:\n<\/span><\/span>        form = RegisterForm()\n<\/span><\/span>        return<\/span> render(request, 'users\/register.html'<\/span>, {'form'<\/span>: form})    \n<\/span><\/span>   \n<\/span><\/span>    if<\/span> request.method == 'POST'<\/span>:\n<\/span><\/mark>        form = RegisterForm(request.POST) \n<\/span><\/mark>        if<\/span> form.is_valid():\n<\/span><\/mark>            user = form.save(commit=False<\/span>)\n<\/span><\/mark>            user.username = user.username.lower()\n<\/span><\/mark>            user.save()\n<\/span><\/mark>            messages.success(request, 'You have singed up successfully.'<\/span>)\n<\/span><\/mark>            login(request, user)\n<\/span><\/mark>            return<\/span> redirect('posts'<\/span>)\n<\/span><\/mark>        else<\/span>:\n<\/span><\/mark>            return<\/span> render(request, 'users\/register.html'<\/span>, {'form'<\/span>: form})\n<\/span><\/mark><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
How it works.<\/p>\n\n\n\n
First, create a new instance of the RegisterForm<\/code>:<\/p>\n\n\n
form = RegisterForm(request.POST)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
If the form is valid, we save the form but do not immediately store it in the database. This is done by passing the argument commit=False<\/code> to the save()<\/code> method of the form object.<\/p>\n\n\n\n
The reason is that we want to make the user name lowercase before saving it in the database:<\/p>\n\n\n
user.username = user.username.lower()\nuser.save()<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
messages.success(request, 'You have singed up successfully.'<\/span>)\nlogin(request, user)\nreturn<\/span> redirect('posts'<\/span>)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
If the form is not valid, we rerender the form with the previously entered values by passing the form object to the render()<\/code> function:<\/p>\n\n\n
return<\/span> render(request, 'users\/register.html'<\/span>, {'form'<\/span>: form})<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The following example illustrates how to sign up a user with the username jane<\/code>:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
After saving the user, we create a flash message<\/a>, log the user in<\/a> and redirect the user to the post list page:<\/p>\n\n\n