Django Braces

1.17.0 · active · verified Wed Apr 15

Django Braces provides a collection of reusable, generic mixins designed to simplify the use of Django's class-based views. These mixins often replicate the functionality of Django's function-based view decorators, addressing common development challenges with class-based views. The library is considered stable and mature, focusing its support on Python versions still receiving fixes and Django LTS releases. The current version is 1.17.0.

Warnings

breaking Explicit support for Python versions before 3.7 and non-LTS versions of Django was dropped in `django-braces` v1.15.0.
Fix: Ensure your project runs on Python 3.7+ and a supported Django LTS version before upgrading to django-braces v1.15.0 or later.
deprecated The `CreateAndRedirectToEditView` mixin was marked for deprecation since v1.0.0 and subsequently removed in v1.11.0.
Fix: If upgrading from older versions, replace `CreateAndRedirectToEditView` with custom `get_success_url` logic or a combination of other mixins.
gotcha Prior to v1.9.0, certain access mixins (like `MultipleGroupRequiredMixin` and `GroupRequiredMixin`) could lead to redirect loops for users without appropriate permissions or group memberships.
Fix: Upgrade to `django-braces` v1.9.0 or newer to benefit from fixes addressing these redirect loop issues.
gotcha The `LoginRequiredMixin` was rewritten in v1.0 to align with other access mixins. Older implementations might not correctly utilize `login_url`, `redirect_field_name`, or `raise_exception` class attributes.
Fix: For versions 1.0.0 and later, configure `LoginRequiredMixin` using `login_url`, `redirect_field_name`, and `raise_exception` class attributes directly on your view.
gotcha The `PermissionRequiredMixin` will raise an `ImproperlyConfigured` exception if the `permission_required` attribute is not explicitly set on the view class.
Fix: Always set the `permission_required` class attribute as a string (e.g., `'app_label.add_model'`) when using `PermissionRequiredMixin`.
gotcha The `GroupRequiredMixin` assumes that you are using Django's default `Group` model and that your user model has a `groups` ManyToMany relationship. Deviations require overriding `check_membership`.
Fix: If your user model or group setup is custom, override the `check_membership` method within your view using `GroupRequiredMixin` to implement your specific group checking logic.

Install

pip install django-braces Install with pip

Imports

LoginRequiredMixin

from braces.views import LoginRequiredMixin

PermissionRequiredMixin

from braces.views import PermissionRequiredMixin

MultiplePermissionsRequiredMixin
wrong:
```
from braces.views import PermissionRequiredMixin (for multiple permissions)
```
correct:
```
from braces.views import MultiplePermissionsRequiredMixin
```
PermissionRequiredMixin only handles a single permission; use MultiplePermissionsRequiredMixin for multiple permissions.

GroupRequiredMixin

from braces.views import GroupRequiredMixin

CsrfExemptMixin

from braces.views import CsrfExemptMixin

JSONResponseMixin

from braces.views import JSONResponseMixin

Quickstart

This example demonstrates how to use the `LoginRequiredMixin` to restrict access to a Django class-based view. The mixin ensures that only authenticated users can access `SomeSecretView`, redirecting unauthenticated users to the specified `login_url`.

from django.views.generic import TemplateView
from braces.views import LoginRequiredMixin

class SomeSecretView(LoginRequiredMixin, TemplateView):
    template_name = "path/to/secret_template.html"
    login_url = "/login/"  # Optional: Redirect URL if not authenticated
    redirect_field_name = "next" # Optional: Parameter name for the next URL
    raise_exception = False # Optional: Raise PermissionDenied instead of redirecting

    def get(self, request, *args, **kwargs):
        return self.render_to_response({})

view raw JSON →