{"id":6126,"date":"2022-12-04T08:58:28","date_gmt":"2022-12-04T08:58:28","guid":{"rendered":"https:\/\/www.pythontutorial.net\/?page_id=6126"},"modified":"2023-08-17T09:53:17","modified_gmt":"2023-08-17T09:53:17","slug":"django-password-reset","status":"publish","type":"page","link":"https:\/\/www.pythontutorial.net\/django-tutorial\/django-password-reset\/","title":{"rendered":"Django Password Reset"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn how to implement the Django Password Reset feature that allows users to reset their passwords using email addresses.<\/p>\n\n\n\n

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

Introduction to the password reset in Django #<\/a><\/h2>\n\n\n\n

The following diagram illustrates the flow that allows a user to reset the password using an email address:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

First, the user clicks the Reset Password link on the login form: <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Django displays a form that allows the user to enter an email address for receiving the password reset link:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Django uses the PasswordResetView<\/code> view to render this form.<\/p>\n\n\n\n

Second, the user enters an email address and clicks the Send button:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Django sends an email to the input email address and displays a message that instructs the user to check the inbox.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Django uses the PasswordResetDoneView<\/code> class to render this form.<\/p>\n\n\n\n

Third, the user opens the inbox and clicks the password reset link:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Finally, the user enters the new password and clicks the Reset Password button:<\/p>\n\n\n\n

\"\"

<\/figcaption><\/figure>\n\n\n\n

Django displays a confirmation message:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Django uses the PasswordResetCompleteView<\/code> to handle this page.<\/p>\n\n\n\n

Implementing password reset for the Todo app #<\/a><\/h2>\n\n\n\n

Modify the views.py<\/code> of the users<\/code> application to map the password reset URL with the corresponding class-based views:<\/p>\n\n\n

from<\/span> django.urls import<\/span> path\nfrom<\/span> .views import<\/span> MyLoginView, RegisterView\n\nfrom<\/span> django.contrib.auth.views import<\/span> (\n    LogoutView, \n    PasswordResetView, \n    PasswordResetDoneView, \n    PasswordResetConfirmView,\n    PasswordResetCompleteView\n)\n\nurlpatterns = [\n    path('login\/'<\/span>, MyLoginView.as_view(redirect_authenticated_user=True<\/span>),name='login'<\/span>),\n    path('logout\/'<\/span>, LogoutView.as_view(next_page='login'<\/span>),name='logout'<\/span>),\n    path('register\/'<\/span>, RegisterView.as_view(),name='register'<\/span>),\n    path('password-reset\/'<\/span>, PasswordResetView.as_view(template_name='users\/password_reset.html'<\/span>),name='password-reset'<\/span>),\n    path('password-reset\/done\/'<\/span>, PasswordResetDoneView.as_view(template_name='users\/password_reset_done.html'<\/span>),name='password_reset_done'<\/span>),\n    path('password-reset-confirm\/<uidb64>\/<token>\/'<\/span>, PasswordResetConfirmView.as_view(template_name='users\/password_reset_confirm.html'<\/span>),name='password_reset_confirm'<\/span>),\n    path('password-reset-complete\/'<\/span>,PasswordResetCompleteView.as_view(template_name='users\/password_reset_complete.html'<\/span>),name='password_reset_complete'<\/span>),\n]<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
PasswordResetView #<\/a><\/h3>\n\n\n\n
First, map the password reset URL 'password-reset\/'<\/code> with the result of the as_view()<\/code> method of the PasswordResetView<\/code><\/code> class. The PasswordResetView<\/code><\/code> class-based view uses the users\/password_reset.html<\/code> template to render the form.<\/p>\n\n\n\n
Second, create the password_reset.html<\/code> template in the templates\/users<\/code> directory:<\/p>\n\n\n
{%extends 'base.html'<\/span>%}\n\n{%block content%}\n<div class<\/span>=\"center<\/span>\">\n\t<form<\/span> method<\/span>=\"post<\/span>\" class<\/span>=\"card<\/span>\">\n\t\t{% csrf_token<\/span> %}\n\t    <h2<\/span> class<\/span>=\"text<\/span>-center<\/span>\">Reset<\/span> Password<\/span><\/h2<\/span>>\n\t\t{% for<\/span> field<\/span> in<\/span> form<\/span> %}\n\t    \t\t{{ field<\/span>.label_tag<\/span> }} \n\t        \t{{ field<\/span> }}\n\t        \t{% if<\/span> field<\/span>.errors<\/span> %}\n\t        \t\t<small<\/span>>{{ field<\/span>.errors<\/span>|striptags<\/span>  }}<\/small<\/span>> \n\t        \t{% endif<\/span> %}\n\t\t{% endfor<\/span> %}\n\t\t<div<\/span> class<\/span>=\"form<\/span>-buttons<\/span>\">\n\t\t\t<input<\/span> type<\/span>=\"submit<\/span>\" value<\/span>=\"Send<\/span>\" class<\/span>=\"btn<\/span> btn<\/span>-primary<\/span>\">\n\t\t\t<a<\/span> href<\/span>=\"{%url<\/span> 'login<\/span>' %}\"  class<\/span>=\"btn<\/span> btn<\/span>-outline<\/span>\">Cancel<\/span><\/a<\/span>>\n\t\t<\/div<\/span>>\n\t<\/form<\/span>>\n\t<\/div<\/span>>\n{%endblock<\/span> content<\/span>%}<\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
PasswordResetDoneView #<\/a><\/h3>\n\n\n\n
First, map the password-reset\/done\/<\/code> with the result of the as_view()<\/code> method of the PasswordResetDoneView<\/code><\/code> class. The PasswordResetDoneView<\/code><\/code> class uses the password_reset_done.html<\/code> template to render the page:<\/p>\n\n\n
path('password-reset\/done\/'<\/span>, PasswordResetDoneView.as_view(template_name='users\/password_reset_done.html'<\/span>),name='password_reset_done'<\/span>),<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Second, create the reset_password_done.html<\/code> template in the templates\/users<\/code> directory:<\/p>\n\n\n
{%extends 'base.html'<\/span>%}\n\n{%block content%}\n\n<div class<\/span>=\"center<\/span> card<\/span>\">\n\t<h2<\/span>>Reset<\/span> Password<\/span><\/h2<\/span>>\n\t<p<\/span>>Please<\/span> check<\/span> your<\/span> inbox<\/span> and<\/span> follow<\/span> the<\/span> instruction<\/span> to<\/span> reset<\/span> your<\/span> password<\/span>.<\/p<\/span>>\n<\/div<\/span>>\n\n{%endblock<\/span> content<\/span>%}<\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
PasswordResetConfirmView #<\/a><\/h3>\n\n\n\n
First, map the password-reset-confirm\/<uidb64>\/<token>\/<\/code> URL with the result of the as_view()<\/code> of the PasswordResetConfirmView<\/code> class:<\/p>\n\n\n
path('password-reset-confirm\/<uidb64>\/<token>\/'<\/span>, PasswordResetConfirmView.as_view(template_name='users\/password_reset_confirm.html'<\/span>),name='password_reset_confirm'<\/span>),<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The PasswordResetConfirmView<\/code> class uses the password_reset_confirm.html<\/code> template to render the page. A reset password URL looks like this:<\/p>\n\n\n
http:\/\/127.0<\/span>.0<\/span>.1<\/span>:8000<\/span>\/password-reset-confirm\/OA\/bfwk0g-d87966e0a694f519bc6f29daa4616b07\/<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Second, create the password_reset_confirm.html<\/code> template in the templates\/users<\/code> directory:<\/p>\n\n\n
{%extends 'base.html'<\/span>%}\n\n{%block content%}\n\n<div class<\/span>=\"center<\/span>\">\n\t<form<\/span> method<\/span>=\"post<\/span>\" class<\/span>=\"card<\/span>\">\n\t  {% csrf_token<\/span> %}\n\t  <h2<\/span>>Password<\/span> Reset<\/span> Confirm<\/span><\/h2<\/span>>\n\t  \n\t  {% for<\/span> field<\/span> in<\/span> form<\/span> %}\n\t    \t\t{{ field<\/span>.label_tag<\/span> }} \n\t        \t{{ field<\/span> }}\n\t        \t{% if<\/span> field<\/span>.errors<\/span> %}\n\t        \t\t<small<\/span>>{{ field<\/span>.errors<\/span>|striptags<\/span>  }}<\/small<\/span>> \n\t        \t{% endif<\/span> %}\n\t\t{% endfor<\/span> %}\n\t  \n\t  \n\t  <div<\/span>>\n\t    <button<\/span> type<\/span>=\"submit<\/span>\" class<\/span>=\"btn<\/span> btn<\/span>-primary<\/span>\">Reset<\/span> Password<\/span><\/button<\/span>>\n\t  <\/div<\/span>>\n\t<\/form<\/span>>\n<\/div<\/span>>\n\n\n{%endblock<\/span> content<\/span>%}<\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
PasswordResetCompleteView #<\/a><\/h3>\n\n\n\n
First, map the password reset complete URL with the as_view()<\/code> method of the PasswordResetCompleteView<\/code> class.<\/p>\n\n\n
{%extends 'base.html'<\/span>%}\n\n{%block content%}\n\n<div class<\/span>=\"card<\/span> center<\/span>\">\n\t<p<\/span>>Your<\/span> password<\/span> has<\/span> been<\/span> changed<\/span> successfully<\/span>. Please<\/span> <a<\/span> href<\/span>=\"{% url<\/span> 'login<\/span>' %}\">Login<\/span><\/a<\/span>><\/p<\/span>>\n<\/div<\/span>>\n \t\n{%endblock<\/span> content<\/span>%}<\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Second, create the password_reset_complete.html<\/code> template in the templates\/users<\/code> directory<\/p>\n\n\n
{%extends 'base.html'<\/span>%}\n\n{%block content%}\n  <div class<\/span>=\"center<\/span>\">\n\t  <form<\/span> method<\/span>=\"post<\/span>\" class<\/span>=\"card<\/span>\" novalidate<\/span>>\n\t  \t{% csrf_token<\/span> %}\n\t    <h2<\/span> class<\/span>=\"text<\/span>-center<\/span>\">Log<\/span> in<\/span> to<\/span> your<\/span> account<\/span><\/h2<\/span>>\n\t\t{% for<\/span> field<\/span> in<\/span> form<\/span> %}\n\t    \t\t{{ field<\/span>.label_tag<\/span> }} \n\t        \t{{ field<\/span> }}\n\t        \t{% if<\/span> field<\/span>.errors<\/span> %}\n\t        \t\t<small<\/span>>{{ field<\/span>.errors<\/span>|striptags<\/span>  }}<\/small<\/span>> \n\t        \t{% endif<\/span> %}\n\t\t{% endfor<\/span> %}\n\t\t\n\t\t<input<\/span> type<\/span>=\"submit<\/span>\" value<\/span>=\"Login<\/span>\" class<\/span>=\"btn<\/span> btn<\/span>-primary<\/span> full<\/span>-width<\/span>\">\n\t\t<hr<\/span>>\n\t\t<p<\/span> class<\/span>=\"text<\/span>-center<\/span>\">Forgot<\/span> your<\/span> password<\/span> <a<\/span> href<\/span>=\"{%url<\/span> 'password<\/span>-reset<\/span>'%}\">Reset<\/span> Password<\/span><\/a<\/span>><\/p<\/span>>\n\t\t<p<\/span> class<\/span>=\"text<\/span>-center<\/span>\">Don<\/span>'t<\/span> have<\/span> a<\/span> account<\/span>? <a<\/span> href<\/span>=\"{%url<\/span> 'register<\/span>'%}\">Join<\/span> Now<\/span><\/a<\/span>><\/p<\/span>>\n\t<\/form<\/span>>\n<\/div<\/span>>\n\n{%endblock<\/span> content<\/span>%}<\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Configuring SMTP for sending emails from the Django app #<\/a><\/h2>\n\n\n\n
To send emails in Django, you need to have a local Simple Mail Transfer Protocol (SMTP<\/code><\/code>) server or an external SMTP<\/code><\/code> Server from an email service provider.  <\/p>\n\n\n\n
Once having an SMTP<\/code> server, you can add its information to the settings.py<\/code> of the Django project with the following information:<\/p>\n\n\n\n