Ticket #11770: 11770-login-decorator.diff

django/contrib/auth/decorators.py

@@ -17 +17 @@
         return _CheckLogin(view_func, test_func, login_url, redirect_field_name)
     return decorate
 
-def login_required(function=None, redirect_field_name=REDIRECT_FIELD_NAME):
+def login_required(function=None, redirect_field_name=REDIRECT_FIELD_NAME, login_url=None):
     """
     Decorator for views that checks that the user is logged in, redirecting
     to the log-in page if necessary.
     """
     actual_decorator = user_passes_test(
         lambda u: u.is_authenticated(),
-        redirect_field_name=redirect_field_name
+        redirect_field_name=redirect_field_name,
+        login_url=login_url
     )
     if function:
         return actual_decorator(function)

docs/topics/auth.txt

@@ -664 +664 @@
         def my_view(request):
             # ...
 
-    :func:`~django.contrib.auth.decorators.login_required` also takes an
-    optional ``redirect_field_name`` parameter. Example::
+    :func:`~django.contrib.auth.decorators.login_required` also takes optional    
+    ``redirect_field_name`` or ``login_url`` parameters. Example::
 
         from django.contrib.auth.decorators import login_required
 
         def my_view(request):
             # ...
-        my_view = login_required(redirect_field_name='redirect_to')(my_view)
+        my_view = login_required(redirect_field_name='redirect_to', login_url='login_url')(my_view)
 
     Again, an equivalent example of the more compact decorator syntax
     introduced in Python 2.4::
@@ -684 +684 @@
 
     :func:`~django.contrib.auth.decorators.login_required` does the following:
 
-        * If the user isn't logged in, redirect to
+        * If the user isn't logged in, redirect to ``login_url`` if specified or
           :setting:`settings.LOGIN_URL <LOGIN_URL>` (``/accounts/login/`` by
-          default), passing the current absolute URL in the query string as
-          ``next`` or the value of ``redirect_field_name``. For example:
+          default), passing the current absolute path or the value of
+          ``redirect_field_name`` in the query string as ``next``. For example:
           ``/accounts/login/?next=/polls/3/``.
 
         * If the user is logged in, execute the view normally. The view code is
@@ -1020 +1020 @@
     automatically check that the :class:`~django.contrib.auth.models.User` is
     not anonymous.
 
-    :func:`~django.contrib.auth.decorators.user_passes_test()` takes an
-    optional ``login_url`` argument, which lets you specify the URL for your
-    login page (:setting:`settings.LOGIN_URL <LOGIN_URL>` by default).
+    :func:`~django.contrib.auth.decorators.user_passes_test()` takes optional
+    ``redirect_field_name`` or ``login_url`` arguments. ``redirect_field_name``
+    sets the ``next`` parameter in the query string (the absolute path by
+    default). ``login_url`` specifies the URL for your login page
+    (:setting:`settings.LOGIN_URL <LOGIN_URL>` by default).
 
     Example in Python 2.3 syntax::
 
@@ -1030 +1032 @@
 
         def my_view(request):
             # ...
-        my_view = user_passes_test(lambda u: u.has_perm('polls.can_vote'), login_url='/login/')(my_view)
+        my_view = user_passes_test(lambda u: u.has_perm('polls.can_vote'), redirect_field_name='redirect_to', login_url='/login/')(my_view)
 
     Example in Python 2.4 syntax::
 
         from django.contrib.auth.decorators import user_passes_test
 
-        @user_passes_test(lambda u: u.has_perm('polls.can_vote'), login_url='/login/')
+        @user_passes_test(lambda u: u.has_perm('polls.can_vote'), redirect_field_name='redirect_to', login_url='/login/')
         def my_view(request):
             # ...