Changeset 3779

Timestamp:

09/21/06 20:44:28 (2 years ago)

Author:

mtredinnick

Message:

Fixed #2629 -- Added a permission_required decorator to
django.contrib.auth.decorator. Thanks, dummy@habmalnefrage.de.

Files:

• django/trunk/django/contrib/auth/decorators.py (modified) (1 diff)
• django/trunk/docs/authentication.txt (modified) (2 diffs)

django/trunk/django/contrib/auth/decorators.py

@@ -27 +27 @@
-    """
-    )
+
+def permission_required(perm, login_url=LOGIN_URL):
+    """
+    Decorator for views that checks if a user has a particular permission
+    enabled, redirectiing to the log-in page if necessary.
+    """
+    return user_passes_test(lambda u: u.has_perm(perm), login_url=login_url)
+

django/trunk/docs/authentication.txt

@@ -457 +457 @@
-    my_view = user_passes_test(lambda u: u.has_perm('polls.can_vote'))(my_view)
-
+We are using this particular test as a relatively simple example, however be
+aware that if you just want to test if a permission is available to a user,
+you can use the ``permission_required()`` decorator described below.
+
-Here's the same thing, using Python 2.4's decorator syntax::
-
@@ -488 +492 @@
-    def my_view(request):
-        # ...
+
+The permission_required decorator
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Since checking whether a user has a particular permission available to them is a
+relatively common operation, Django provides a shortcut for that particular
+case: the ``permission_required()`` decorator. Using this decorator, the
+earlier example can be written as::
+
+    from django.contrib.auth.decorators import permission_required
+     
+    def my_view(request):
+        # ...
+     
+    my_view = permission_required('polls.can_vote')(my_view)
+
+Note that ``permission_required()`` also takes an optional ``login_url``
+parameter.
-
-Limiting access to generic views