django-rest-framework/rest_framework/generics.py

216 lines
6.7 KiB
Python
Raw Normal View History

"""
2012-10-30 03:30:52 +04:00
Generic views that provide commonly needed behaviour.
"""
2012-09-30 20:31:28 +04:00
from rest_framework import views, mixins
from rest_framework.settings import api_settings
from django.views.generic.detail import SingleObjectMixin
from django.views.generic.list import MultipleObjectMixin
### Base classes for the generic views ###
2012-10-25 16:50:39 +04:00
class GenericAPIView(views.APIView):
"""
Base class for all other generic views.
"""
2012-11-17 03:22:15 +04:00
model = None
serializer_class = None
model_serializer_class = api_settings.DEFAULT_MODEL_SERIALIZER_CLASS
2012-09-30 20:31:28 +04:00
def get_serializer_context(self):
2012-10-01 18:49:19 +04:00
"""
Extra context provided to the serializer class.
"""
2012-09-30 20:31:28 +04:00
return {
'request': self.request,
2012-10-05 17:22:02 +04:00
'format': self.format_kwarg,
2012-10-01 18:49:19 +04:00
'view': self
2012-09-30 20:31:28 +04:00
}
2012-10-01 18:49:19 +04:00
def get_serializer_class(self):
"""
Return the class to use for the serializer.
Defaults to using `self.serializer_class`, falls back to constructing a
model serializer class using `self.model_serializer_class`, with
`self.model` as the model.
2012-10-01 18:49:19 +04:00
"""
2012-09-28 17:28:50 +04:00
serializer_class = self.serializer_class
if serializer_class is None:
2012-09-30 20:31:28 +04:00
class DefaultSerializer(self.model_serializer_class):
2012-09-28 17:28:50 +04:00
class Meta:
model = self.model
serializer_class = DefaultSerializer
2012-10-01 18:49:19 +04:00
return serializer_class
2012-09-30 20:31:28 +04:00
2012-11-06 21:04:48 +04:00
def get_serializer(self, instance=None, data=None, files=None):
2012-11-17 03:22:15 +04:00
"""
Return the serializer instance that should be used for validating and
deserializing input, and for serializing output.
"""
2012-10-01 18:49:19 +04:00
serializer_class = self.get_serializer_class()
2012-09-30 20:31:28 +04:00
context = self.get_serializer_context()
return serializer_class(instance, data=data, files=files, context=context)
2012-10-25 16:50:39 +04:00
class MultipleObjectAPIView(MultipleObjectMixin, GenericAPIView):
"""
Base class for generic views onto a queryset.
"""
2012-10-01 18:49:19 +04:00
paginate_by = api_settings.PAGINATE_BY
paginate_by_param = api_settings.PAGINATE_BY_PARAM
2012-11-17 03:22:15 +04:00
pagination_serializer_class = api_settings.DEFAULT_PAGINATION_SERIALIZER_CLASS
filter_backend = api_settings.FILTER_BACKEND
def filter_queryset(self, queryset):
"""
Given a queryset, filter it with whichever filter backend is in use.
"""
if not self.filter_backend:
return queryset
backend = self.filter_backend()
return backend.filter_queryset(self.request, queryset, self)
def get_pagination_serializer(self, page=None):
2012-10-01 18:49:19 +04:00
"""
Return a serializer instance to use with paginated data.
2012-10-01 18:49:19 +04:00
"""
class SerializerClass(self.pagination_serializer_class):
class Meta:
object_serializer_class = self.get_serializer_class()
pagination_serializer_class = SerializerClass
2012-10-01 18:49:19 +04:00
context = self.get_serializer_context()
return pagination_serializer_class(instance=page, context=context)
def get_paginate_by(self, queryset):
"""
Return the size of pages to use with pagination.
"""
if self.paginate_by_param:
2012-11-17 03:22:15 +04:00
query_params = self.request.QUERY_PARAMS
try:
2012-11-17 03:22:15 +04:00
return int(query_params[self.paginate_by_param])
except (KeyError, ValueError):
pass
return self.paginate_by
2012-10-25 16:50:39 +04:00
class SingleObjectAPIView(SingleObjectMixin, GenericAPIView):
"""
Base class for generic views onto a model instance.
"""
2012-11-17 03:22:15 +04:00
2012-10-05 20:02:33 +04:00
pk_url_kwarg = 'pk' # Not provided in Django 1.3
slug_url_kwarg = 'slug' # Not provided in Django 1.3
2012-11-17 03:22:15 +04:00
slug_field = 'slug'
def get_object(self, queryset=None):
"""
Override default to add support for object-level permissions.
"""
obj = super(SingleObjectAPIView, self).get_object(queryset)
if not self.has_permission(self.request, obj):
self.permission_denied(self.request)
return obj
### Concrete view classes that provide method handlers ###
### by composing the mixin classes with a base view. ###
class CreateAPIView(mixins.CreateModelMixin,
2012-10-25 16:50:39 +04:00
GenericAPIView):
"""
Concrete view for creating a model instance.
"""
def post(self, request, *args, **kwargs):
return self.create(request, *args, **kwargs)
class ListAPIView(mixins.ListModelMixin,
2012-10-25 16:50:39 +04:00
MultipleObjectAPIView):
"""
Concrete view for listing a queryset.
"""
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
2012-10-03 12:26:15 +04:00
class RetrieveAPIView(mixins.RetrieveModelMixin,
2012-10-25 16:50:39 +04:00
SingleObjectAPIView):
"""
Concrete view for retrieving a model instance.
"""
def get(self, request, *args, **kwargs):
return self.retrieve(request, *args, **kwargs)
class DestroyAPIView(mixins.DestroyModelMixin,
2012-10-27 13:32:49 +04:00
SingleObjectAPIView):
"""
Concrete view for deleting a model instance.
"""
def delete(self, request, *args, **kwargs):
return self.destroy(request, *args, **kwargs)
class UpdateAPIView(mixins.UpdateModelMixin,
2012-10-25 16:50:39 +04:00
SingleObjectAPIView):
"""
Concrete view for updating a model instance.
"""
def put(self, request, *args, **kwargs):
return self.update(request, *args, **kwargs)
class ListCreateAPIView(mixins.ListModelMixin,
mixins.CreateModelMixin,
2012-10-25 16:50:39 +04:00
MultipleObjectAPIView):
"""
Concrete view for listing a queryset or creating a model instance.
"""
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
def post(self, request, *args, **kwargs):
return self.create(request, *args, **kwargs)
class RetrieveDestroyAPIView(mixins.RetrieveModelMixin,
mixins.DestroyModelMixin,
2012-10-25 16:50:39 +04:00
SingleObjectAPIView):
"""
Concrete view for retrieving or deleting a model instance.
"""
def get(self, request, *args, **kwargs):
return self.retrieve(request, *args, **kwargs)
def delete(self, request, *args, **kwargs):
return self.destroy(request, *args, **kwargs)
class RetrieveUpdateDestroyAPIView(mixins.RetrieveModelMixin,
mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
2012-10-25 16:50:39 +04:00
SingleObjectAPIView):
"""
Concrete view for retrieving, updating or deleting a model instance.
"""
def get(self, request, *args, **kwargs):
return self.retrieve(request, *args, **kwargs)
def put(self, request, *args, **kwargs):
return self.update(request, *args, **kwargs)
def delete(self, request, *args, **kwargs):
return self.destroy(request, *args, **kwargs)