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, obj=None):
# This example returns same list both for "global permissions" check,
# and for "object" permissions, but different list may be returned
# if `obj` argument is not None, and this list will be used to check
# if action is allowed during call to `ViewSet.check_object_permissions`
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.viewsets import RoleFilterModelViewSet
from .models import Post
from .role_filters import AdminRoleFilter, UserRoleFilter
from .serializers import PostSerializer
class PostViewSet(RoleFilterModelViewSet):
queryset = Post.objects.all()
serializer_class = PostSerializer
role_filter_classes = [AdminRoleFilter, UserRoleFilter]
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 are 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’ are allowed
The queryset is filtered by user
The
serializer_class=PostSerializerForUser
is usedThe serializer initializing with
fields
kwargs (e.g. for modified serializer as described in DRF: Dynamically modifying fields)
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-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2257a1036dc2db9fc29c352e869313d50db52078bfc1b2805a745c538229eb2 |
|
MD5 | 9633ebc403814877f56cc9d3004ea5e7 |
|
BLAKE2b-256 | 2bd86bc177f4880ffb5c0bad506dc736858c737c4f548d8103ca5b1546315723 |
Hashes for djangorestframework_role_filters-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36c9a7f54ade0f43e9e30d7f6fe55a3ad171da447af479210dd90622844cc1a6 |
|
MD5 | 16a14bd91e45fee7ff97e5790a0c2a8d |
|
BLAKE2b-256 | 2a1cc9e1823dfea26731207fb26b5e08d57d5da02bebd7e9830eb23ee8b5f46d |