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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b38fedcbca153fc2519ac6188381a7fe70177a0ac061ef69370342d479c7734 |
|
MD5 | 2852ba37005d83bf0d53c6ac3cd3b621 |
|
BLAKE2b-256 | 4560978d8f1b2a54d97413c600c8de25bcaeadb592286448d6354b7a03b03eea |
Hashes for djangorestframework_role_filters-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae88b33f8337906b892b042199da943c6c9b4be136546e561c194e81b5a36d9c |
|
MD5 | 749790e38e813e0d2abdf55eaa3999ad |
|
BLAKE2b-256 | 70dd41e2b839f61db18985550305000c2f544e146a1ef257316338ad969c9c53 |