django.contrib.auth.logout in Django

Question

I would like to use the logout function from Django but not sure how to use it properly.I have been referring to this Django User Authenication: https://docs.djangoproject.com/en/dev/topics/auth/ and it reads

from django.contrib.auth import logout

def logout_view(request):
    logout(request)
    # Redirect to a success page.

The confusing part for me is the # Redirect to a success page. How do i redirect it to another page. Should I use HttpResponseRedirect or add additional arguments to logout(request). I am not sure what to do.. Need some guidance.

janos · Answer 1 · 2013-09-03T06:10:40.327

Django has a shortcut method called redirect. You could use that to redirect like this:

from django.contrib.auth import logout
from django.shortcuts import redirect

def logout_view(request):
    logout(request)
    return redirect('home')

Where home is the name of a url pattern you defined in urls.py like this:

urlpatterns = patterns('',
    url(r'^$', 'blah.views.index', name='home'))
)

In the redirect call you could use a path as well, like / to redirect to the site root, but using named views is much cleaner.

PS: the code posted by @Hedde is from django.contrib.auth.views module, logout method. If that's what you want to use, you can import it like this:

from django.contrib.auth.views import logout

score 18 · Answer 2 · edited Sep 23 '14 at 17:30

18

You don't have to write a view for that, you can just do:

(r'^accounts/logout/$', 'django.contrib.auth.views.logout',{'next_page': '/accounts/login'})

More info: https://docs.djangoproject.com/en/dev/topics/auth/default/#django.contrib.auth.views.logout

edited Sep 23 '14 at 17:30

Maxime Lorant

34,607
19
87
97

answered Feb 19 '14 at 11:48

3

This does not work if you already included all auth urls with `url('^', include('django.contrib.auth.urls')),` – RunLoop Jun 10 '15 at 06:31
@RunLoop so what to do to redirect if I've included all auth urls? – Stefano Munarini Oct 20 '15 at 08:47
@StefanoMunarini just redirect from within your view e.g. `HttpResponseRedirect('/registration-success/')` – RunLoop Oct 21 '15 at 04:15

score 14 · Accepted Answer · answered Jun 28 '12 at 08:54

Look at the source of the logout method, it should give you a clear idea what's going on. You can add extra arguments to the logout method to handle redirecting, but you can also append after the method for custom behaviour

def logout(request, next_page=None,
           template_name='registration/logged_out.html',
           redirect_field_name=REDIRECT_FIELD_NAME,
           current_app=None, extra_context=None):
    """
    Logs out the user and displays 'You are logged out' message.
    """
    auth_logout(request)
    redirect_to = request.REQUEST.get(redirect_field_name, '')
    if redirect_to:
        netloc = urlparse.urlparse(redirect_to)[1]
        # Security check -- don't allow redirection to a different host.
        if not (netloc and netloc != request.get_host()):
            return HttpResponseRedirect(redirect_to)
    #etc...

did u import this: from django.contrib.auth import logout ? or something else? — lakshmen, Jun 28 '12 at 08:56
No it's just Django's source code which tells you there's 5 optional arguments you can append to your logout call — Hedde van der Heide, Jun 28 '12 at 08:56

score 1 · Answer 4 · edited Oct 14 '18 at 13:07

1

def logout(request):
    # Log out the user.
    logout(request)
    # Return to homepage.
    return HttpResponseRedirect(reverse('registeration:index'))

edited Oct 14 '18 at 13:07

Zulu

8,765
9
49
56

answered Oct 17 '17 at 11:55

Urvashi Meena

37
2
9

I had to rename django.contrib.auth.logout method – jartaud Jun 16 '21 at 07:00

Nikhil Lingam · Answer 5 · 2019-03-31T05:19:57.567

1

urlpatterns =[
path('accounts/logout/', views.LogoutView.as_view(template_name="post_list.html"), name='logout'),
]

write a template_name as above inside it worked for me.Hope it might be useful. Thankyou

edited Mar 31 '19 at 05:19

answered Mar 17 '19 at 06:38

Nikhil Lingam

121
2
12

django.contrib.auth.logout in Django

5 Answers5

Linked