Add `superuser_required` decorator

[DmytroLitvinov]

Code of Conduct

• I agree to follow Django's Code of Conduct

Feature Description

This is a minor enhancement to add superuser_required to django.contrib.auth.decorators. Since superuser (aka admin user) is core of Django I see it would be useful to have it as "battery included" in core of Django.

Problem

That would resolve a problem that we create from project to project, that decorator which for my point of view, suits great at Django core (since we have a as a native is_superuser field on which rely django.contrib.admin and other custom parts of project which we develop.

Request or proposal

proposal

Additional Details

No response

Implementation Suggestions

def superuser_required(
    function=None, redirect_field_name=REDIRECT_FIELD_NAME, login_url=None
):
    """
    Decorator for views that checks that the user is logged in and is a superuser, redirecting
    to the log-in page if necessary.
    """
    actual_decorator = user_passes_test(
        lambda u: u.is_authenticated and u.is_superuser,
        login_url=login_url,
        redirect_field_name=redirect_field_name,
    )
    if function:
        return actual_decorator(function)
    return actual_decorator

[github-actions]

Thank you DmytroLitvinov for sharing your idea! We have a lot of them so please be patient. You can see the current queue here.

Community instructions

For commenters, please use the emoji reactions on the issue to express support, and/or concern easily. Please use the comments to ask questions or contribute knowledge about the idea. It is unhelpful to post comments of "I'd love this" or "What's the state of this?"

Reaction Guide

• 👍 This is something I would use
• 👎 This is something that would cause problems for me or Django
• 😕 I’m indifferent to this
• 🎉 This is an easy win

[benbacardi]

This is easily achieved already with user_passes_test:

@user_passes_test(lambda u: u.is_superuser)

[nanorepublica]

This comment I made on another issue in regard to Django Snippets feels on point here.

[czue]

For those who are voting against this, I'm curious what the downside of adding it is? Almost every project I've worked on ends up with superuser-only views and having it built in would provide a nice, canonical way of supporting that use case. It doesn't seem like docs or maintenance would introduce much of a support burden?

[colleenDunlap]

@czue my guess is what @benbacardi said, but I wouldn't mind having a second more obvious decorator either

[ulgens]

Since superuser (aka admin user) is core of Django I see it would be useful to have it as "battery included" in core of Django.

Strong 👍🏻 Considering is_superuser and is_staff are fields of AbstractUser, I'd say that having staff_required and superuser_required makes sense, in terms of being "batteries included".