django-rest-framework-role-filters
Project description
How to install
pip install djangorestframework-role-filters
Why i wrote this project?
I want work easily with roles without multiple ifs in code
How to use
Create role_filters.py with your roles definitions
from rest_framework_role_filters.role_filters import RoleFilter
from .serializers import PostSerializerForUser
class AdminRoleFilter(RoleFilter):
role_id = 'admin'
class UserRoleFilter(RoleFilter):
role_id = 'user'
def get_allowed_actions(self, request, view):
return ['create', 'list', 'retrieve', 'update', 'partial_update']
def get_queryset(self, request, view, queryset):
queryset = queryset.filter(user=request.user)
return queryset
def get_serializer_class(self, request, view):
return PostSerializerForUser
def get_serializer(self, request, view, serializer_class, *args, **kwargs):
fields = (
'body',
'created_at',
'id',
'serializer_name',
'title',
'updated_at',
'user',
)
return serializer_class(*args, fields=fields, **kwargs)
Create viewset and override get_role_id method
from rest_framework_role_filters.role_filters import RoleFilterGroup
from rest_framework_role_filters.viewsets import RoleFilterModelViewSet
from .models import Post
from .role_filters import AdminRoleFilter, UserRoleFilter
from .serializers import PostSerializer
class PostViewSet(RoleFilterModelViewSet):
role_filter_group = RoleFilterGroup(role_filters=[AdminRoleFilter(), UserRoleFilter()])
queryset = Post.objects.all()
serializer_class = PostSerializer
def get_role_id(self, request):
return request.user.role.role_id
def perform_create(self, serializer):
serializer.save(user=self.request.user)
If role_id is ‘admin’:
All actions is allowed
The default queryset is returned - Post.objects.all()
The default serializer_class is used - PostSerializer
The default viewset get_serializer method is used
If role_id is ‘user’:
Only actions ‘create’, ‘list’, ‘retrieve’, ‘update’, ‘partial_update’ is allowed
The queryset is filtered by user
The serializer_class PostSerializerForUser is used
The serializer initializing with fields kwargs
Check testapp example code implementation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for djangorestframework-role-filters-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 848ec24b5b29dc754b9f759fd0c34fdb2b58b70b819a47cb1b082a5f156a3f83 |
|
MD5 | df8a285717345470c0d9219cf555ee9a |
|
BLAKE2b-256 | 00a7a3396790fe353427e1bf30e16d13c73c02767f319e3286f5fd9a7b1dba7d |
Hashes for djangorestframework_role_filters-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61919b10236797f6ae7fb3ac1058f4b971687ee03655ce45e2c742cde62d6080 |
|
MD5 | b996cdd2fbe1841643b64a14e234d621 |
|
BLAKE2b-256 | 27e037a0c840388a6e82e33ebc354a6f1442c8a615dae3663b4ebdd90d289c13 |