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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1981dba2c2c05e5628b872601ab159a20254a5af6b525b58b7d61a5a3df63c2e |
|
MD5 | 338a116a570f9ecbfe05732e8cc8d1a0 |
|
BLAKE2b-256 | 1ea55b4e3b1c76fb33be6a16f63cfd95a166da521dafc7955099b75656d7c2e3 |
Hashes for djangorestframework_role_filters-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1661a8c33b9f23b689a9b1957280a81ea7bc6b41b8565e36828e7a5bfe5d15fc |
|
MD5 | 399c62d752e4ee7773bb99bdd5dd85f7 |
|
BLAKE2b-256 | c80861071e6632dc423d977b00a970989a98f5b53e758015d4dfe56587360306 |