diff options
| author | Tom Christie | 2012-09-06 15:58:44 +0100 |
|---|---|---|
| committer | Tom Christie | 2012-09-06 15:58:44 +0100 |
| commit | b79833ecddcea788b4a8d8901bd25f0afe83bbf7 (patch) | |
| tree | bb751eabf8792bb71e3e71642f78b26664b4fed5 /djangorestframework/generics.py | |
| parent | c707034649fa9e24f0c6c3c0580dc06f90eac373 (diff) | |
| download | django-rest-framework-b79833ecddcea788b4a8d8901bd25f0afe83bbf7.tar.bz2 | |
Move generic views into seperate module
Diffstat (limited to 'djangorestframework/generics.py')
| -rw-r--r-- | djangorestframework/generics.py | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/djangorestframework/generics.py b/djangorestframework/generics.py new file mode 100644 index 00000000..87a2a4b8 --- /dev/null +++ b/djangorestframework/generics.py @@ -0,0 +1,112 @@ +""" +Generic views that provide commmonly needed behaviour. +""" + +from djangorestframework import views, mixins +from django.views.generic.detail import SingleObjectMixin +from django.views.generic.list import MultipleObjectMixin + + +### Base classes for the generic views ### + +class BaseView(views.APIView): + """ + Base class for all other generic views. + """ + serializer_class = None + + def get_serializer(self, data=None, files=None, instance=None): + # TODO: add support for files + # TODO: add support for seperate serializer/deserializer + context = { + 'request': self.request, + 'format': self.kwargs.get('format', None) + } + return self.serializer_class(data, instance=instance, context=context) + + +class MultipleObjectBaseView(MultipleObjectMixin, BaseView): + """ + Base class for generic views onto a queryset. + """ + pass + + +class SingleObjectBaseView(SingleObjectMixin, BaseView): + """ + Base class for generic views onto a model instance. + """ + + def get_object(self): + """ + Override default to add support for object-level permissions. + """ + super(self, SingleObjectBaseView).get_object() + self.check_permissions(self.request, self.object) + + +### Concrete view classes that provide method handlers ### +### by composing the mixin classes with a base view. ### + +class ListAPIView(mixins.ListModelMixin, + mixins.MetadataMixin, + MultipleObjectBaseView): + """ + Concrete view for listing a queryset. + """ + def get(self, request, *args, **kwargs): + return self.list(request, *args, **kwargs) + + def options(self, request, *args, **kwargs): + return self.metadata(request, *args, **kwargs) + + +class RootAPIView(mixins.ListModelMixin, + mixins.CreateModelMixin, + mixins.MetadataMixin, + MultipleObjectBaseView): + """ + 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) + + def options(self, request, *args, **kwargs): + return self.metadata(request, *args, **kwargs) + + +class DetailAPIView(mixins.RetrieveModelMixin, + mixins.MetadataMixin, + SingleObjectBaseView): + """ + Concrete view for retrieving a model instance. + """ + def get(self, request, *args, **kwargs): + return self.retrieve(request, *args, **kwargs) + + def options(self, request, *args, **kwargs): + return self.metadata(request, *args, **kwargs) + + +class InstanceAPIView(mixins.RetrieveModelMixin, + mixins.UpdateModelMixin, + mixins.DestroyModelMixin, + mixins.MetadataMixin, + SingleObjectBaseView): + """ + 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) + + def options(self, request, *args, **kwargs): + return self.metadata(request, *args, **kwargs) |
