Skip to main content

Flexible action level permissions for Django REST framework

Project description


Release CI Coverage
pypi build codecov

Flexible ability to add action permissions on view level for Django REST framework. Permissions can be as complex or simple as you want. It can be a plain string or a function.


  • Python (3.6+)
  • Django (1.11.x, 2.0+)
  • Django REST Framework (3.7+)


$ pip install drf-common-exceptions

You cound define common permissions class for whole project:


Or use it just for particular viewset in combination with others:

from rest_framework.permissions import IsAuthenticated
from rest_framework.viewsets import ModelViewSet

from drf_action_permissions import DjangoActionPermissions

class MyView(viewsets.ModelViewSet):
    permission_classes = (IsAuthenticated, DjangoActionPermissions)
    perms_map_action = {
        'retrieve': ['users.view_user'],

Usage examples

Permission as string template or plain string:

class PostViewSet(ModelViewSet):
    permission_classes = (IsAuthenticated, DjangoActionPermissions)
    perms_map_action = {
        'likes': ['%(app_label)s.view_%(model_name)s_list',

Permission as function with current object access:

def can_view_application(user, _view, obj):
    """Can view only archived applications."""
    if obj.is_archived:
        return user.has_perm('applications.view_archived_application')
    return user.has_perm('applications.view_application')

class ApplicationView(ModelViewSet):
    permission_classes = (IsAuthenticated, DjangoActionPermissions)
    perms_map_action_obj = {
        'retrieve': [can_view_application],


Install poetry and requirements:

$ curl -sSL | python
$ python3 -m venv path/to/venv
$ source path/to/venv/bin/activate
$ poetry install

Run main commands:

$ make test
$ make watch
$ make clean
$ make lint

Publish to pypi by default patch version:

$ make publish

or any level you want:

$ make publish minor

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

drf-action-permissions-0.1.1.tar.gz (4.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page