aboutsummaryrefslogtreecommitdiffstats
path: root/rest_framework/generics.py
diff options
context:
space:
mode:
authorTom Christie2012-10-30 14:32:31 +0000
committerTom Christie2012-10-30 14:32:31 +0000
commit9b30dab4f772f67a626e176dc4fae0a3ef9c2c81 (patch)
treeca138abf4792f58ffa28684f784f201ee1eef6d7 /rest_framework/generics.py
parent7e5b1501b5cede61a9391fb1a751d2ebcdb37031 (diff)
parent4e7805cb24d73e7f706318b5e5a27e3f9ba39d14 (diff)
downloaddjango-rest-framework-9b30dab4f772f67a626e176dc4fae0a3ef9c2c81.tar.bz2
Merge branch 'restframework2' into rest-framework-2-merge2.0.0
Conflicts: .gitignore .travis.yml AUTHORS README.rst djangorestframework/mixins.py djangorestframework/renderers.py djangorestframework/resources.py djangorestframework/serializer.py djangorestframework/templates/djangorestframework/base.html djangorestframework/templates/djangorestframework/login.html djangorestframework/templatetags/add_query_param.py djangorestframework/tests/accept.py djangorestframework/tests/authentication.py djangorestframework/tests/content.py djangorestframework/tests/reverse.py djangorestframework/tests/serializer.py djangorestframework/views.py docs/examples.rst docs/examples/blogpost.rst docs/examples/modelviews.rst docs/examples/objectstore.rst docs/examples/permissions.rst docs/examples/pygments.rst docs/examples/views.rst docs/howto/alternativeframeworks.rst docs/howto/mixin.rst docs/howto/reverse.rst docs/howto/usingurllib2.rst docs/index.rst docs/topics/release-notes.md examples/sandbox/views.py rest_framework/__init__.py rest_framework/compat.py rest_framework/utils/breadcrumbs.py setup.py
Diffstat (limited to 'rest_framework/generics.py')
-rw-r--r--rest_framework/generics.py187
1 files changed, 187 insertions, 0 deletions
diff --git a/rest_framework/generics.py b/rest_framework/generics.py
new file mode 100644
index 00000000..27540a57
--- /dev/null
+++ b/rest_framework/generics.py
@@ -0,0 +1,187 @@
+"""
+Generic views that provide commonly needed behaviour.
+"""
+
+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 ###
+
+class GenericAPIView(views.APIView):
+ """
+ Base class for all other generic views.
+ """
+ serializer_class = None
+ model_serializer_class = api_settings.DEFAULT_MODEL_SERIALIZER_CLASS
+
+ def get_serializer_context(self):
+ """
+ Extra context provided to the serializer class.
+ """
+ return {
+ 'request': self.request,
+ 'format': self.format_kwarg,
+ 'view': self
+ }
+
+ def get_serializer_class(self):
+ """
+ Return the class to use for the serializer.
+ Use `self.serializer_class`, falling back to constructing a
+ model serializer class from `self.model_serializer_class`
+ """
+ serializer_class = self.serializer_class
+
+ if serializer_class is None:
+ class DefaultSerializer(self.model_serializer_class):
+ class Meta:
+ model = self.model
+ serializer_class = DefaultSerializer
+
+ return serializer_class
+
+ def get_serializer(self, data=None, files=None, instance=None):
+ # TODO: add support for files
+ # TODO: add support for seperate serializer/deserializer
+ serializer_class = self.get_serializer_class()
+ context = self.get_serializer_context()
+ return serializer_class(data, instance=instance, context=context)
+
+
+class MultipleObjectAPIView(MultipleObjectMixin, GenericAPIView):
+ """
+ Base class for generic views onto a queryset.
+ """
+
+ pagination_serializer_class = api_settings.DEFAULT_PAGINATION_SERIALIZER_CLASS
+ paginate_by = api_settings.PAGINATE_BY
+
+ def get_pagination_serializer_class(self):
+ """
+ Return the class to use for the pagination serializer.
+ """
+ class SerializerClass(self.pagination_serializer_class):
+ class Meta:
+ object_serializer_class = self.get_serializer_class()
+
+ return SerializerClass
+
+ def get_pagination_serializer(self, page=None):
+ pagination_serializer_class = self.get_pagination_serializer_class()
+ context = self.get_serializer_context()
+ return pagination_serializer_class(instance=page, context=context)
+
+
+class SingleObjectAPIView(SingleObjectMixin, GenericAPIView):
+ """
+ Base class for generic views onto a model instance.
+ """
+ pk_url_kwarg = 'pk' # Not provided in Django 1.3
+ slug_url_kwarg = 'slug' # Not provided in Django 1.3
+
+ def get_object(self):
+ """
+ Override default to add support for object-level permissions.
+ """
+ obj = super(SingleObjectAPIView, self).get_object()
+ 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,
+ GenericAPIView):
+
+ """
+ Concrete view for creating a model instance.
+ """
+ def post(self, request, *args, **kwargs):
+ return self.create(request, *args, **kwargs)
+
+
+class ListAPIView(mixins.ListModelMixin,
+ MultipleObjectAPIView):
+ """
+ Concrete view for listing a queryset.
+ """
+ def get(self, request, *args, **kwargs):
+ return self.list(request, *args, **kwargs)
+
+
+class RetrieveAPIView(mixins.RetrieveModelMixin,
+ SingleObjectAPIView):
+ """
+ Concrete view for retrieving a model instance.
+ """
+ def get(self, request, *args, **kwargs):
+ return self.retrieve(request, *args, **kwargs)
+
+
+class DestroyAPIView(mixins.DestroyModelMixin,
+ SingleObjectAPIView):
+
+ """
+ Concrete view for deleting a model instance.
+ """
+ def delete(self, request, *args, **kwargs):
+ return self.destroy(request, *args, **kwargs)
+
+
+class UpdateAPIView(mixins.UpdateModelMixin,
+ 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,
+ 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,
+ 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,
+ 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)