From 3802442c89a722da7e48210d315856b5993fcdbe Mon Sep 17 00:00:00 2001
From: Ricky Rosario
Date: Thu, 1 Aug 2013 17:02:16 -0400
Subject: Add missing comma to generic view example.
---
docs/api-guide/generic-views.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 67853ed0..32a4feef 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -40,7 +40,7 @@ For more complex cases you might also want to override various methods on the vi
For very simple cases you might want to pass through any class attributes using the `.as_view()` method. For example, your URLconf might include something the following entry.
- url(r'^/users/', ListCreateAPIView.as_view(model=User) name='user-list')
+ url(r'^/users/', ListCreateAPIView.as_view(model=User), name='user-list')
---
--
cgit v1.2.3
From 1bf712341508b5d9aa07fb62f55b7e495278fabf Mon Sep 17 00:00:00 2001
From: Filipe Ximenes
Date: Tue, 20 Aug 2013 16:24:13 -0300
Subject: improving documentation about object level permissions #1049
---
docs/api-guide/generic-views.md | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 32a4feef..2a585f9c 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -108,7 +108,10 @@ For example:
filter = {}
for field in self.multiple_lookup_fields:
filter[field] = self.kwargs[field]
- return get_object_or_404(queryset, **filter)
+
+ obj = get_object_or_404(queryset, **filter)
+ self.check_object_permissions(self.request, obj)
+ return obj
#### `get_serializer_class(self)`
--
cgit v1.2.3
From 5e40e50f2b187fe2ff2e8ee63b4e39ece42f1521 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 21 Aug 2013 19:46:09 +0100
Subject: Include import paths throughout docs.
Closes #1051. Thanks to @pydanny for the report.
---
docs/api-guide/generic-views.md | 5 +++++
1 file changed, 5 insertions(+)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 32a4feef..7f754df8 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -17,6 +17,11 @@ If the generic views don't suit the needs of your API, you can drop down to usin
Typically when using the generic views, you'll override the view, and set several class attributes.
+ from django.contrib.auth.models import User
+ from myapp.serializers import UserSerializer
+ from rest_framework import generics
+ from rest_framework.permissions import IsAdminUser
+
class UserList(generics.ListCreateAPIView):
queryset = User.objects.all()
serializer_class = UserSerializer
--
cgit v1.2.3
From cf6ae397db1353370fef05df99a8d321806a6f58 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 21 Aug 2013 19:57:30 +0100
Subject: Docs tweaking around `check_object_permissions`
---
docs/api-guide/generic-views.md | 2 ++
1 file changed, 2 insertions(+)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 281a0481..931cae54 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -118,6 +118,8 @@ For example:
self.check_object_permissions(self.request, obj)
return obj
+Note that if your API doesn't include any object level permissions, you may optionally exclude the ``self.check_object_permissions, and simply return the object from the `get_object_or_404` lookup.
+
#### `get_serializer_class(self)`
Returns the class that should be used for the serializer. Defaults to returning the `serializer_class` attribute, or dynamically generating a serializer class if the `model` shortcut is being used.
--
cgit v1.2.3
From da9c17067c3150897da4cab149f12dee08768346 Mon Sep 17 00:00:00 2001
From: Brett Koonce
Date: Thu, 29 Aug 2013 09:23:34 -0500
Subject: minor sp
---
docs/api-guide/generic-views.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 931cae54..7185b6b6 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -73,7 +73,7 @@ The following attributes control the basic view behavior.
**Pagination**:
-The following attibutes are used to control pagination when used with list views.
+The following attributes are used to control pagination when used with list views.
* `paginate_by` - The size of pages to use with paginated data. If set to `None` then pagination is turned off. If unset this uses the same value as the `PAGINATE_BY` setting, which defaults to `None`.
* `paginate_by_param` - The name of a query parameter, which can be used by the client to override the default page size to use for pagination. If unset this uses the same value as the `PAGINATE_BY_PARAM` setting, which defaults to `None`.
@@ -135,7 +135,7 @@ For example:
#### `get_paginate_by(self)`
-Returns the page size to use with pagination. By default this uses the `paginate_by` attribute, and may be overridden by the cient if the `paginate_by_param` attribute is set.
+Returns the page size to use with pagination. By default this uses the `paginate_by` attribute, and may be overridden by the client if the `paginate_by_param` attribute is set.
You may want to override this method to provide more complex behavior such as modifying page sizes based on the media type of the response.
--
cgit v1.2.3
From 895beb89c60cea534f85b8a7749615755c4d43b5 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Thu, 12 Sep 2013 21:41:21 +0100
Subject: Note on '.model' as default only, with 'serializer_class', and
'queryset' attributes prefered. Closes #1100
---
docs/api-guide/generic-views.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 7185b6b6..dc0076df 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -69,7 +69,7 @@ The following attributes control the basic view behavior.
**Shortcuts**:
-* `model` - This shortcut may be used instead of setting either (or both) of the `queryset`/`serializer_class` attributes, although using the explicit style is generally preferred. If used instead of `serializer_class`, then then `DEFAULT_MODEL_SERIALIZER_CLASS` setting will determine the base serializer class.
+* `model` - This shortcut may be used instead of setting either (or both) of the `queryset`/`serializer_class` attributes, although using the explicit style is generally preferred. If used instead of `serializer_class`, then then `DEFAULT_MODEL_SERIALIZER_CLASS` setting will determine the base serializer class. Note that `model` is only ever used for generating a default queryset or serializer class - the `queryset` and `serializer_class` attributes are always preferred if provided.
**Pagination**:
--
cgit v1.2.3
From 76672787cdba6a4ab8173b51fa099c910556889b Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Mon, 21 Oct 2013 09:47:07 +0100
Subject: Added . Closes #1188.
---
docs/api-guide/generic-views.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index dc0076df..24fc0bc7 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -65,7 +65,8 @@ The following attributes control the basic view behavior.
* `queryset` - The queryset that should be used for returning objects from this view. Typically, you must either set this attribute, or override the `get_queryset()` method.
* `serializer_class` - The serializer class that should be used for validating and deserializing input, and for serializing output. Typically, you must either set this attribute, or override the `get_serializer_class()` method.
-* `lookup_field` - The field that should be used to lookup individual model instances. Defaults to `'pk'`. The URL conf should include a keyword argument corresponding to this value. More complex lookup styles can be supported by overriding the `get_object()` method. Note that when using hyperlinked APIs you'll need to ensure that *both* the API views *and* the serializer classes use lookup fields that correctly correspond with the URL conf.
+* `lookup_field` - The model field that should be used to for performing object lookup of individual model instances. Defaults to `'pk'`. Note that when using hyperlinked APIs you'll need to ensure that *both* the API views *and* the serializer classes set the lookup fields if you need to use a custom value.
+* `lookup_url_kwarg` - The URL keyword argument that should be used for object lookup. The URL conf should include a keyword argument corresponding to this value. If unset this defaults to using the same value as `lookup_field`.
**Shortcuts**:
--
cgit v1.2.3
From c92af2b1dd25acebe440f667ede3bad4906b9b28 Mon Sep 17 00:00:00 2001
From: Yamila
Date: Thu, 24 Oct 2013 15:56:53 +0200
Subject: Typo on generic-views.md
---
docs/api-guide/generic-views.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 24fc0bc7..9681c8c7 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -125,7 +125,7 @@ Note that if your API doesn't include any object level permissions, you may opti
Returns the class that should be used for the serializer. Defaults to returning the `serializer_class` attribute, or dynamically generating a serializer class if the `model` shortcut is being used.
-May be override to provide dynamic behavior such as using different serializers for read and write operations, or providing different serializers to different types of uesr.
+May be override to provide dynamic behavior such as using different serializers for read and write operations, or providing different serializers to different types of users.
For example:
--
cgit v1.2.3
From 82e9ddcf7a5cb5fda81e84326bb6f8181ccdffab Mon Sep 17 00:00:00 2001
From: Yamila Moreno
Date: Thu, 24 Oct 2013 15:39:02 +0200
Subject: Added get_filter_backends method
---
docs/api-guide/generic-views.md | 20 ++++++++++++++++++--
1 file changed, 18 insertions(+), 2 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 24fc0bc7..8fedcdaa 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -121,6 +121,22 @@ For example:
Note that if your API doesn't include any object level permissions, you may optionally exclude the ``self.check_object_permissions, and simply return the object from the `get_object_or_404` lookup.
+#### `get_filter_backends(self)`
+
+Returns the classes that should be used to filter the queryset. Defaults to returning the `filter_backends` attribute.
+
+May be override to provide more complex behavior with filters, as using different (or even exlusive) lists of filter_backends depending on different criteria.
+
+For example:
+
+ def get_filter_backends(self):
+ if "geo_route" in self.request.QUERY_PARAMS:
+ return (GeoRouteFilter, CategoryFilter)
+ elif "geo_point" in self.request.QUERY_PARAMS:
+ return (GeoPointFilter, CategoryFilter)
+
+ return (CategoryFilter,)
+
#### `get_serializer_class(self)`
Returns the class that should be used for the serializer. Defaults to returning the `serializer_class` attribute, or dynamically generating a serializer class if the `model` shortcut is being used.
@@ -328,7 +344,7 @@ You can then simply apply this mixin to a view or viewset anytime you need to ap
serializer_class = UserSerializer
lookup_fields = ('account', 'username')
-Using custom mixins is a good option if you have custom behavior that needs to be used
+Using custom mixins is a good option if you have custom behavior that needs to be used
## Creating custom base classes
@@ -337,7 +353,7 @@ If you are using a mixin across multiple views, you can take this a step further
class BaseRetrieveView(MultipleFieldLookupMixin,
generics.RetrieveAPIView):
pass
-
+
class BaseRetrieveUpdateDestroyView(MultipleFieldLookupMixin,
generics.RetrieveUpdateDestroyAPIView):
pass
--
cgit v1.2.3
From 699ec7236b326c97a98c6058280b822c701393fe Mon Sep 17 00:00:00 2001
From: Pablo Recio
Date: Tue, 3 Dec 2013 00:07:41 +0000
Subject: Adds pre_delete and post_delete hooks on
---
docs/api-guide/generic-views.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index b9242724..83c3e45f 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -163,12 +163,14 @@ For example:
return 20
return 100
-**Save hooks**:
+**Save / deletion hooks**:
The following methods are provided as placeholder interfaces. They contain empty implementations and are not called directly by `GenericAPIView`, but they are overridden and used by some of the mixin classes.
* `pre_save(self, obj)` - A hook that is called before saving an object.
* `post_save(self, obj, created=False)` - A hook that is called after saving an object.
+* `pre_delete(self, obj)` - A hook that is called before deleting an object.
+* `post_delete(self, obj)` - A hook that is called after deleting an object.
The `pre_save` method in particular is a useful hook for setting attributes that are implicit in the request, but are not part of the request data. For instance, you might set an attribute on the object based on the request user, or based on a URL keyword argument.
--
cgit v1.2.3
From 37cd49cac98dfb5b79c4e4df0f42e782280172ce Mon Sep 17 00:00:00 2001
From: Miroslav Shubernetskiy
Date: Sat, 18 Jan 2014 22:31:36 -0500
Subject: Added docs for bulk views from django-rest-framework-bulk.
---
docs/api-guide/generic-views.md | 49 +++++++++++++++++++++++++++++++++++++++++
1 file changed, 49 insertions(+)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 83c3e45f..11b55063 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -362,6 +362,54 @@ If you are using a mixin across multiple views, you can take this a step further
Using custom base classes is a good option if you have custom behavior that consistently needs to be repeated across a large number of views throughout your project.
+# Third party packages
+
+The following third party packages provide additional generic view implementations.
+
+## Django REST Framework bulk
+
+The [django-rest-framework-bulk package][django-rest-framework-bulk] implements generic view mixins as well as some common concrete generic views to allow to apply bulk operations via API requests.
+
+### Mixins
+
+As with Django Rest Framework standard mixins, each mixin defines a specific behavior which allows to composite multiple mixins (either with other bulk mixins or standard mixins) for more functionality.
+
+#### BulkCreateModelMixin
+
+Provides a `.create(request, *args, **kwargs)` method, that implements creating either a single or multiple objects depending on the `request.DATA` data-type (list or object).
+
+If any object(s) is/are created, as with the standard `CreateModelMixin`, `201 Created` response is returned with the serialization of created object(s). If any errors occur while validating the provided data, `400 Bad Request` is returned with error details for each attempted creation object.
+
+#### BulkUpdateModelMixin
+
+Provides a `.bulk_update(request, *args, **kwargs)` method, that implements updating multiple objects at the same time. Since each object needs to be identified, each object within `request.DATA` must provide its identity as per serializer's `.get_identity()`.
+
+Also provides a `.partial_bulk_update(request, *args, **kwargs)` method, which is similar to the `bulk_update`, except that all fields for all resources will be optional.
+
+If all objects are updated, `200 OK` response is returned with the serialized representation of all updated objects. If any validation errors occur, `400 Bad Request` is returned.
+
+#### BulkDestroyModelMixin
+
+Provides a `.bulk_destroy(request, *args, **kwargs)` method, that implements deletion of all objects within a queryset. Since that can potentially be very dangerous, this mixin also provides an `.allow_bulk_destroy(queryset, filtered)` hook to determine if the bulk delete should be allowed. By default it allows the request if the queryset was filtered.
+
+If the objects are deleted this returns `204 No Content` response or `400 Bad Request` if the request is not allowed as per `allow_bulk_destroy`.
+
+### Concrete View Classes
+
+In addition to the bulk mixins, this package also implements some of the most common bulk concrete view classes. Those include:
+
+* `BulkCreateAPIView`
+* `BulkUpdateAPIView`
+* `BulkDestroyAPIView`
+* `ListBulkCreateAPIView`
+* `ListCreateBulkUpdateAPIView`
+* `ListCreateBulkUpdateDestroyAPIView`
+* `ListBulkCreateUpdateAPIView`
+* `ListBulkCreateUpdateDestroyAPIView`
+
+To create custom concrete view classes, you can also composite the mixins manually as explained in **Creating custom base classes** of Django Rest Framework documentation.
+
+
[cite]: https://docs.djangoproject.com/en/dev/ref/class-based-views/#base-vs-generic-views
[GenericAPIView]: #genericapiview
@@ -370,3 +418,4 @@ Using custom base classes is a good option if you have custom behavior that cons
[RetrieveModelMixin]: #retrievemodelmixin
[UpdateModelMixin]: #updatemodelmixin
[DestroyModelMixin]: #destroymodelmixin
+[django-rest-framework-bulk]: https://github.com/miki725/django-rest-framework-bulk
--
cgit v1.2.3
From e3c5a134510c8e364bd278dc5033ccb5515927d7 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Sun, 19 Jan 2014 21:09:49 +0000
Subject: Drop django-rest-framework-bulk API descriptions
---
docs/api-guide/generic-views.md | 40 ----------------------------------------
1 file changed, 40 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 11b55063..e23b2c74 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -370,48 +370,8 @@ The following third party packages provide additional generic view implementatio
The [django-rest-framework-bulk package][django-rest-framework-bulk] implements generic view mixins as well as some common concrete generic views to allow to apply bulk operations via API requests.
-### Mixins
-
-As with Django Rest Framework standard mixins, each mixin defines a specific behavior which allows to composite multiple mixins (either with other bulk mixins or standard mixins) for more functionality.
-
-#### BulkCreateModelMixin
-
-Provides a `.create(request, *args, **kwargs)` method, that implements creating either a single or multiple objects depending on the `request.DATA` data-type (list or object).
-
-If any object(s) is/are created, as with the standard `CreateModelMixin`, `201 Created` response is returned with the serialization of created object(s). If any errors occur while validating the provided data, `400 Bad Request` is returned with error details for each attempted creation object.
-
-#### BulkUpdateModelMixin
-
-Provides a `.bulk_update(request, *args, **kwargs)` method, that implements updating multiple objects at the same time. Since each object needs to be identified, each object within `request.DATA` must provide its identity as per serializer's `.get_identity()`.
-
-Also provides a `.partial_bulk_update(request, *args, **kwargs)` method, which is similar to the `bulk_update`, except that all fields for all resources will be optional.
-
-If all objects are updated, `200 OK` response is returned with the serialized representation of all updated objects. If any validation errors occur, `400 Bad Request` is returned.
-
-#### BulkDestroyModelMixin
-
-Provides a `.bulk_destroy(request, *args, **kwargs)` method, that implements deletion of all objects within a queryset. Since that can potentially be very dangerous, this mixin also provides an `.allow_bulk_destroy(queryset, filtered)` hook to determine if the bulk delete should be allowed. By default it allows the request if the queryset was filtered.
-
-If the objects are deleted this returns `204 No Content` response or `400 Bad Request` if the request is not allowed as per `allow_bulk_destroy`.
-
-### Concrete View Classes
-
-In addition to the bulk mixins, this package also implements some of the most common bulk concrete view classes. Those include:
-
-* `BulkCreateAPIView`
-* `BulkUpdateAPIView`
-* `BulkDestroyAPIView`
-* `ListBulkCreateAPIView`
-* `ListCreateBulkUpdateAPIView`
-* `ListCreateBulkUpdateDestroyAPIView`
-* `ListBulkCreateUpdateAPIView`
-* `ListBulkCreateUpdateDestroyAPIView`
-
-To create custom concrete view classes, you can also composite the mixins manually as explained in **Creating custom base classes** of Django Rest Framework documentation.
-
[cite]: https://docs.djangoproject.com/en/dev/ref/class-based-views/#base-vs-generic-views
-
[GenericAPIView]: #genericapiview
[ListModelMixin]: #listmodelmixin
[CreateModelMixin]: #createmodelmixin
--
cgit v1.2.3
From ba8a0bac538adc8d6897ece14648e03ce7441b24 Mon Sep 17 00:00:00 2001
From: RicterZ
Date: Tue, 4 Feb 2014 23:41:13 +0800
Subject: Fixed a bug backticks
fix
you may optionally exclude the ``self.check_object_permissions, and simply return the object from the `get_object_or_404` lookup.
to
you may optionally exclude the `self.check_object_permissions`, and simply return the object from the `get_object_or_404` lookup.---
docs/api-guide/generic-views.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index e23b2c74..fb927ea8 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -119,7 +119,7 @@ For example:
self.check_object_permissions(self.request, obj)
return obj
-Note that if your API doesn't include any object level permissions, you may optionally exclude the ``self.check_object_permissions, and simply return the object from the `get_object_or_404` lookup.
+Note that if your API doesn't include any object level permissions, you may optionally exclude the `self.check_object_permissions`, and simply return the object from the `get_object_or_404` lookup.
#### `get_filter_backends(self)`
--
cgit v1.2.3
From d8cb85ef8fb0a0804d9b2c09d909ad99f69301c8 Mon Sep 17 00:00:00 2001
From: Laurent Bristiel
Date: Mon, 28 Apr 2014 22:00:36 +0200
Subject: typo
---
docs/api-guide/generic-views.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index fb927ea8..7d06f246 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -70,7 +70,7 @@ The following attributes control the basic view behavior.
**Shortcuts**:
-* `model` - This shortcut may be used instead of setting either (or both) of the `queryset`/`serializer_class` attributes, although using the explicit style is generally preferred. If used instead of `serializer_class`, then then `DEFAULT_MODEL_SERIALIZER_CLASS` setting will determine the base serializer class. Note that `model` is only ever used for generating a default queryset or serializer class - the `queryset` and `serializer_class` attributes are always preferred if provided.
+* `model` - This shortcut may be used instead of setting either (or both) of the `queryset`/`serializer_class` attributes, although using the explicit style is generally preferred. If used instead of `serializer_class`, then `DEFAULT_MODEL_SERIALIZER_CLASS` setting will determine the base serializer class. Note that `model` is only ever used for generating a default queryset or serializer class - the `queryset` and `serializer_class` attributes are always preferred if provided.
**Pagination**:
--
cgit v1.2.3
From eab5933070d5df9078a6b88e85ee933cbfa28955 Mon Sep 17 00:00:00 2001
From: khamaileon
Date: Mon, 26 May 2014 18:43:50 +0200
Subject: Add the allow_add_remove parameter to the get_serializer method
---
docs/api-guide/generic-views.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 7d06f246..bb748981 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -187,7 +187,7 @@ Remember that the `pre_save()` method is not called by `GenericAPIView` itself,
You won't typically need to override the following methods, although you might need to call into them if you're writing custom views using `GenericAPIView`.
* `get_serializer_context(self)` - Returns a dictionary containing any extra context that should be supplied to the serializer. Defaults to including `'request'`, `'view'` and `'format'` keys.
-* `get_serializer(self, instance=None, data=None, files=None, many=False, partial=False)` - Returns a serializer instance.
+* `get_serializer(self, instance=None, data=None, files=None, many=False, partial=False, allow_add_remove=False)` - Returns a serializer instance.
* `get_pagination_serializer(self, page)` - Returns a serializer instance to use with paginated data.
* `paginate_queryset(self, queryset)` - Paginate a queryset if required, either returning a page object, or `None` if pagination is not configured for this view.
* `filter_queryset(self, queryset)` - Given a queryset, filter it with whichever filter backends are in use, returning a new queryset.
--
cgit v1.2.3
From e40ffd60d44d736d7e27ff454cba1905f0becc26 Mon Sep 17 00:00:00 2001
From: Kyle
Date: Mon, 28 Jul 2014 10:11:40 -0700
Subject: Issue #1707 - Add documentation about the caching of
`GenericAPIView.queryset` to the `queryset` property, `get_queryset()`, and
do generic-views.md; remove changes to the viewsets.md documentation from my
last commit.
---
docs/api-guide/generic-views.md | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 7d06f246..b76c18cf 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -43,6 +43,12 @@ For more complex cases you might also want to override various methods on the vi
return 20
return 100
+ def list(self, request):
+ # Note the use of `get_queryset()` instead of `self.queryset`
+ queryset = self.get_queryset()
+ serializer = UserSerializer(queryset, many=True)
+ return Response(serializer.data)
+
For very simple cases you might want to pass through any class attributes using the `.as_view()` method. For example, your URLconf might include something the following entry.
url(r'^/users/', ListCreateAPIView.as_view(model=User), name='user-list')
@@ -63,7 +69,7 @@ Each of the concrete generic views provided is built by combining `GenericAPIVie
The following attributes control the basic view behavior.
-* `queryset` - The queryset that should be used for returning objects from this view. Typically, you must either set this attribute, or override the `get_queryset()` method.
+* `queryset` - The queryset that should be used for returning objects from this view. Typically, you must either set this attribute, or override the `get_queryset()` method. If you are overriding a view method, it is important that you call `get_queryset()` instead of accessing this property directly, as `queryset` will get evaluated once, and those results will be cached for all subsequent requests.
* `serializer_class` - The serializer class that should be used for validating and deserializing input, and for serializing output. Typically, you must either set this attribute, or override the `get_serializer_class()` method.
* `lookup_field` - The model field that should be used to for performing object lookup of individual model instances. Defaults to `'pk'`. Note that when using hyperlinked APIs you'll need to ensure that *both* the API views *and* the serializer classes set the lookup fields if you need to use a custom value.
* `lookup_url_kwarg` - The URL keyword argument that should be used for object lookup. The URL conf should include a keyword argument corresponding to this value. If unset this defaults to using the same value as `lookup_field`.
--
cgit v1.2.3
From fc8eb76c2259ea64a19876f040db4d93e834d39d Mon Sep 17 00:00:00 2001
From: Kyle
Date: Mon, 28 Jul 2014 10:19:42 -0700
Subject: Issue #1707 - Add info about queryset property caching to
get_queryset() docs.
Add documentation to the get_queryset() method of generic-views.md regarding
the caching of the queryset property.
---
docs/api-guide/generic-views.md | 2 ++
1 file changed, 2 insertions(+)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index b76c18cf..43c5782f 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -99,6 +99,8 @@ The following attributes are used to control pagination when used with list view
Returns the queryset that should be used for list views, and that should be used as the base for lookups in detail views. Defaults to returning the queryset specified by the `queryset` attribute, or the default queryset for the model if the `model` shortcut is being used.
+This method should always be used rather than accessing `self.queryset` directly, as `self.queryset` gets evaluated only once, and those results are cached for all subsequent requests.
+
May be overridden to provide dynamic behavior such as returning a queryset that is specific to the user making the request.
For example:
--
cgit v1.2.3
From 8b2052172cf7138203e683731c30bd279c6e722a Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Thu, 21 Aug 2014 12:25:20 +0100
Subject: Add .model deprecation to release notes
---
docs/api-guide/generic-views.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index e9efe709..cab382fb 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -74,10 +74,6 @@ The following attributes control the basic view behavior.
* `lookup_field` - The model field that should be used to for performing object lookup of individual model instances. Defaults to `'pk'`. Note that when using hyperlinked APIs you'll need to ensure that *both* the API views *and* the serializer classes set the lookup fields if you need to use a custom value.
* `lookup_url_kwarg` - The URL keyword argument that should be used for object lookup. The URL conf should include a keyword argument corresponding to this value. If unset this defaults to using the same value as `lookup_field`.
-**Shortcuts**:
-
-* `model` - This shortcut may be used instead of setting either (or both) of the `queryset`/`serializer_class` attributes, although using the explicit style is generally preferred. If used instead of `serializer_class`, then `DEFAULT_MODEL_SERIALIZER_CLASS` setting will determine the base serializer class. Note that `model` is only ever used for generating a default queryset or serializer class - the `queryset` and `serializer_class` attributes are always preferred if provided.
-
**Pagination**:
The following attributes are used to control pagination when used with list views.
@@ -91,6 +87,10 @@ The following attributes are used to control pagination when used with list view
* `filter_backends` - A list of filter backend classes that should be used for filtering the queryset. Defaults to the same value as the `DEFAULT_FILTER_BACKENDS` setting.
+**Deprecated attributes**:
+
+* `model` - This shortcut may be used instead of setting either (or both) of the `queryset`/`serializer_class` attributes. The explicit style is preferred over the `.model` shortcut, and usage of this attribute is now deprecated.
+
### Methods
**Base methods**:
--
cgit v1.2.3
From 19076510f4039aa6886854679e21352fffb5354f Mon Sep 17 00:00:00 2001
From: Nathan Hubbell
Date: Tue, 26 Aug 2014 17:31:08 -0700
Subject: Update generic-views.md
---
docs/api-guide/generic-views.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index e9efe709..48b77a6e 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -49,7 +49,7 @@ For more complex cases you might also want to override various methods on the vi
serializer = UserSerializer(queryset, many=True)
return Response(serializer.data)
-For very simple cases you might want to pass through any class attributes using the `.as_view()` method. For example, your URLconf might include something the following entry.
+For very simple cases you might want to pass through any class attributes using the `.as_view()` method. For example, your URLconf might include something like the following entry:
url(r'^/users/', ListCreateAPIView.as_view(model=User), name='user-list')
--
cgit v1.2.3
From be21cafd2bbca36bcf9e55b1565ba57c9e3f76d6 Mon Sep 17 00:00:00 2001
From: Nathan Hubbell
Date: Wed, 27 Aug 2014 17:57:40 -0700
Subject: Update generic-views.md
Small grammar changes.---
docs/api-guide/generic-views.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 48b77a6e..2ceb2d57 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -101,7 +101,7 @@ Returns the queryset that should be used for list views, and that should be used
This method should always be used rather than accessing `self.queryset` directly, as `self.queryset` gets evaluated only once, and those results are cached for all subsequent requests.
-May be overridden to provide dynamic behavior such as returning a queryset that is specific to the user making the request.
+May be overridden to provide dynamic behavior, such as returning a queryset, that is specific to the user making the request.
For example:
@@ -113,7 +113,7 @@ For example:
Returns an object instance that should be used for detail views. Defaults to using the `lookup_field` parameter to filter the base queryset.
-May be overridden to provide more complex behavior such as object lookups based on more than one URL kwarg.
+May be overridden to provide more complex behavior, such as object lookups based on more than one URL kwarg.
For example:
@@ -133,7 +133,7 @@ Note that if your API doesn't include any object level permissions, you may opti
Returns the classes that should be used to filter the queryset. Defaults to returning the `filter_backends` attribute.
-May be override to provide more complex behavior with filters, as using different (or even exlusive) lists of filter_backends depending on different criteria.
+May be overridden to provide more complex behavior with filters, such as using different (or even exlusive) lists of filter_backends depending on different criteria.
For example:
@@ -149,7 +149,7 @@ For example:
Returns the class that should be used for the serializer. Defaults to returning the `serializer_class` attribute, or dynamically generating a serializer class if the `model` shortcut is being used.
-May be override to provide dynamic behavior such as using different serializers for read and write operations, or providing different serializers to different types of users.
+May be overridden to provide dynamic behavior, such as using different serializers for read and write operations, or providing different serializers to different types of users.
For example:
@@ -162,7 +162,7 @@ For example:
Returns the page size to use with pagination. By default this uses the `paginate_by` attribute, and may be overridden by the client if the `paginate_by_param` attribute is set.
-You may want to override this method to provide more complex behavior such as modifying page sizes based on the media type of the response.
+You may want to override this method to provide more complex behavior, such as modifying page sizes based on the media type of the response.
For example:
@@ -204,7 +204,7 @@ You won't typically need to override the following methods, although you might n
# Mixins
-The mixin classes provide the actions that are used to provide the basic view behavior. Note that the mixin classes provide action methods rather than defining the handler methods such as `.get()` and `.post()` directly. This allows for more flexible composition of behavior.
+The mixin classes provide the actions that are used to provide the basic view behavior. Note that the mixin classes provide action methods rather than defining the handler methods, such as `.get()` and `.post()`, directly. This allows for more flexible composition of behavior.
## ListModelMixin
--
cgit v1.2.3
From d8eb9e6d45c227582559ec4318b1f92562c718da Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Fri, 29 Aug 2014 10:48:16 +0100
Subject: Docs whitespace fix.
---
docs/api-guide/generic-views.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index b1c4e65a..d30b7f9b 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -19,8 +19,8 @@ Typically when using the generic views, you'll override the view, and set severa
from django.contrib.auth.models import User
from myapp.serializers import UserSerializer
- from rest_framework import generics
- from rest_framework.permissions import IsAdminUser
+ from rest_framework import generics
+ from rest_framework.permissions import IsAdminUser
class UserList(generics.ListCreateAPIView):
queryset = User.objects.all()
--
cgit v1.2.3
From 0f8fdf4e72b67ff46474c13c8b532bf319a58099 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Fri, 29 Aug 2014 10:57:24 +0100
Subject: Remove `allow_empty`.
Closes #1774.
---
docs/api-guide/generic-views.md | 2 --
1 file changed, 2 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index d30b7f9b..49be0cae 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -212,8 +212,6 @@ Provides a `.list(request, *args, **kwargs)` method, that implements listing a q
If the queryset is populated, this returns a `200 OK` response, with a serialized representation of the queryset as the body of the response. The response data may optionally be paginated.
-If the queryset is empty this returns a `200 OK` response, unless the `.allow_empty` attribute on the view is set to `False`, in which case it will return a `404 Not Found`.
-
## CreateModelMixin
Provides a `.create(request, *args, **kwargs)` method, that implements creating and saving a new model instance.
--
cgit v1.2.3
From d27b8cc09b83bac10346effa1021493d2835b794 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Mon, 3 Nov 2014 12:00:19 +0000
Subject: PUT as create docs, and move mixin out to external gist
---
docs/api-guide/generic-views.md | 14 ++++++++++++++
1 file changed, 14 insertions(+)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 49be0cae..d2836fa6 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -368,6 +368,20 @@ If you are using a mixin across multiple views, you can take this a step further
Using custom base classes is a good option if you have custom behavior that consistently needs to be repeated across a large number of views throughout your project.
+---
+
+# PUT as create
+
+Prior to version 3.0 the REST framework mixins treated `PUT` as either an update or a create operation, depending on if the object already existed or not.
+
+Allowing `PUT` as create operations is problematic, as it necessarily exposes information about the existence or non-existance of objects. It's also not obvious that transparently allowing re-creating of previously deleted instances is necessarily a better default behavior than simply returning `404` responses.
+
+Both styles "`PUT` as 404" and "`PUT` as create" can be valid in different circumstances, but from version 3.0 onwards we now use 404 behavior as the default, due to it being simpler and more obvious.
+
+If you need to generic PUT-as-create behavior you may want to include something like [this `AllowPUTAsCreateMixin` class](https://gist.github.com/tomchristie/a2ace4577eff2c603b1b) as a mixin to your views.
+
+---
+
# Third party packages
The following third party packages provide additional generic view implementations.
--
cgit v1.2.3
From b44def465054345b6099aae7bdd34b623fdc124c Mon Sep 17 00:00:00 2001
From: Brett Koonce
Date: Thu, 6 Nov 2014 23:19:26 -0800
Subject: minor spelling tweaks
---
docs/api-guide/generic-views.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index d2836fa6..49a5e58f 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -374,7 +374,7 @@ Using custom base classes is a good option if you have custom behavior that cons
Prior to version 3.0 the REST framework mixins treated `PUT` as either an update or a create operation, depending on if the object already existed or not.
-Allowing `PUT` as create operations is problematic, as it necessarily exposes information about the existence or non-existance of objects. It's also not obvious that transparently allowing re-creating of previously deleted instances is necessarily a better default behavior than simply returning `404` responses.
+Allowing `PUT` as create operations is problematic, as it necessarily exposes information about the existence or non-existence of objects. It's also not obvious that transparently allowing re-creating of previously deleted instances is necessarily a better default behavior than simply returning `404` responses.
Both styles "`PUT` as 404" and "`PUT` as create" can be valid in different circumstances, but from version 3.0 onwards we now use 404 behavior as the default, due to it being simpler and more obvious.
--
cgit v1.2.3
From a3c0c8fb90f084d494cdf46551c8a6228ca5ffd0 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Tue, 25 Nov 2014 12:04:35 +0000
Subject: Add missing period.
---
docs/api-guide/generic-views.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 49a5e58f..16ae8c55 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -352,7 +352,7 @@ You can then simply apply this mixin to a view or viewset anytime you need to ap
serializer_class = UserSerializer
lookup_fields = ('account', 'username')
-Using custom mixins is a good option if you have custom behavior that needs to be used
+Using custom mixins is a good option if you have custom behavior that needs to be used.
## Creating custom base classes
--
cgit v1.2.3
From 16d442dda3ee9d4ff40d067d76706959aac4c6a3 Mon Sep 17 00:00:00 2001
From: José Padilla
Date: Fri, 31 Oct 2014 09:04:39 -0400
Subject: Use MkDocs meta.source to render source code links
---
docs/api-guide/generic-views.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 49a5e58f..648ece82 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -1,5 +1,5 @@
-
-
+source: mixins.py
+ generics.py
# Generic views
--
cgit v1.2.3
From c01c631ef2c5a0f303460c505810c4987371dbcc Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 26 Nov 2014 09:04:48 +0000
Subject: perform_create, perform_update, perform_destroy hooks
---
docs/api-guide/generic-views.md | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 489b628f..dc51189c 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -7,7 +7,7 @@ source: mixins.py
>
> — [Django Documentation][cite]
-One of the key benefits of class based views is the way they allow you to compose bits of reusable behaviour. REST framework takes advantage of this by providing a number of pre-built views that provide for commonly used patterns.
+One of the key benefits of class based views is the way they allow you to compose bits of reusable behavior. REST framework takes advantage of this by providing a number of pre-built views that provide for commonly used patterns.
The generic views provided by REST framework allow you to quickly build API views that map closely to your database models.
@@ -171,24 +171,24 @@ For example:
return 20
return 100
-**Save / deletion hooks**:
+**Save and deletion hooks**:
-The following methods are provided as placeholder interfaces. They contain empty implementations and are not called directly by `GenericAPIView`, but they are overridden and used by some of the mixin classes.
+The following methods are provided by the mixin classes, and provide easy overriding of the object save or deletion behavior.
-* `pre_save(self, obj)` - A hook that is called before saving an object.
-* `post_save(self, obj, created=False)` - A hook that is called after saving an object.
-* `pre_delete(self, obj)` - A hook that is called before deleting an object.
-* `post_delete(self, obj)` - A hook that is called after deleting an object.
+* `perform_create(self, serializer)` - Called by `CreateModelMixin` when saving a new object instance.
+* `perform_update(self, serializer)` - Called by `UpdateModelMixin` when saving an existing object instance.
+* `perform_destroy(self, instance)` - Called by `DestroyModelMixin` when deleting an object instance.
-The `pre_save` method in particular is a useful hook for setting attributes that are implicit in the request, but are not part of the request data. For instance, you might set an attribute on the object based on the request user, or based on a URL keyword argument.
+These hooks are particularly useful for setting attributes that are implicit in the request, but are not part of the request data. For instance, you might set an attribute on the object based on the request user, or based on a URL keyword argument.
- def pre_save(self, obj):
- """
- Set the object's owner, based on the incoming request.
- """
- obj.owner = self.request.user
+ def perform_create(self, serializer):
+ serializer.save(user=self.request.user)
+
+These override points are also particularly useful for adding behavior that occurs before or after saving an object, such as emailing a confirmation, or logging the update.
-Remember that the `pre_save()` method is not called by `GenericAPIView` itself, but it is called by `create()` and `update()` methods on the `CreateModelMixin` and `UpdateModelMixin` classes.
+ def perform_update(self, serializer):
+ instance = serializer.save()
+ send_email_confirmation(user=self.request.user, modified=instance)
**Other methods**:
--
cgit v1.2.3
From 0f5338ada90ca2c6e53b9e095bec6a3b853d107b Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 26 Nov 2014 09:06:15 +0000
Subject: Call out removal of pre_save/post_save more strongly
---
docs/api-guide/generic-views.md | 2 ++
1 file changed, 2 insertions(+)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index dc51189c..8c1b7dc9 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -190,6 +190,8 @@ These override points are also particularly useful for adding behavior that occu
instance = serializer.save()
send_email_confirmation(user=self.request.user, modified=instance)
+**Note**: These methods replace the old-style version 2.x `pre_save`, `post_save`, `pre_delete` and `post_delete` methods, which are no longer available.
+
**Other methods**:
You won't typically need to override the following methods, although you might need to call into them if you're writing custom views using `GenericAPIView`.
--
cgit v1.2.3
From 8e549a76ea0ff6b44e1dcf08ba733a5fbfc004ed Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Fri, 28 Nov 2014 14:26:03 +0000
Subject: Add 2.x notes and links
---
docs/api-guide/generic-views.md | 6 ++++++
1 file changed, 6 insertions(+)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 8c1b7dc9..f5bbdfdd 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -1,6 +1,12 @@
source: mixins.py
generics.py
+---
+
+**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
+
+---
+
# Generic views
> Django’s generic views... were developed as a shortcut for common usage patterns... They take certain common idioms and patterns found in view development and abstract them so that you can quickly write common views of data without having to repeat yourself.
--
cgit v1.2.3
From a636320ff3b381a6d7d8685f1b4fba8bdd6c8b94 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Sun, 28 Dec 2014 11:02:19 +0000
Subject: Add import notes in docs. Closes #2357
---
docs/api-guide/generic-views.md | 4 ++++
1 file changed, 4 insertions(+)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index f5bbdfdd..6374e305 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -214,6 +214,8 @@ You won't typically need to override the following methods, although you might n
The mixin classes provide the actions that are used to provide the basic view behavior. Note that the mixin classes provide action methods rather than defining the handler methods, such as `.get()` and `.post()`, directly. This allows for more flexible composition of behavior.
+The mixin classes can be imported from `rest_framework.mixins`.
+
## ListModelMixin
Provides a `.list(request, *args, **kwargs)` method, that implements listing a queryset.
@@ -258,6 +260,8 @@ If an object is deleted this returns a `204 No Content` response, otherwise it w
The following classes are the concrete generic views. If you're using generic views this is normally the level you'll be working at unless you need heavily customized behavior.
+The view classes can be imported from `rest_framework.generics`.
+
## CreateAPIView
Used for **create-only** endpoints.
--
cgit v1.2.3
From e720927b78a31999f03bfa248329d623ce2c045c Mon Sep 17 00:00:00 2001
From: Tymur Maryokhin
Date: Thu, 29 Jan 2015 17:28:18 +0100
Subject: Removed deprecated '.model' docs
---
docs/api-guide/generic-views.md | 8 ++------
1 file changed, 2 insertions(+), 6 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 6374e305..61c8e8d8 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -93,17 +93,13 @@ The following attributes are used to control pagination when used with list view
* `filter_backends` - A list of filter backend classes that should be used for filtering the queryset. Defaults to the same value as the `DEFAULT_FILTER_BACKENDS` setting.
-**Deprecated attributes**:
-
-* `model` - This shortcut may be used instead of setting either (or both) of the `queryset`/`serializer_class` attributes. The explicit style is preferred over the `.model` shortcut, and usage of this attribute is now deprecated.
-
### Methods
**Base methods**:
#### `get_queryset(self)`
-Returns the queryset that should be used for list views, and that should be used as the base for lookups in detail views. Defaults to returning the queryset specified by the `queryset` attribute, or the default queryset for the model if the `model` shortcut is being used.
+Returns the queryset that should be used for list views, and that should be used as the base for lookups in detail views. Defaults to returning the queryset specified by the `queryset` attribute.
This method should always be used rather than accessing `self.queryset` directly, as `self.queryset` gets evaluated only once, and those results are cached for all subsequent requests.
@@ -153,7 +149,7 @@ For example:
#### `get_serializer_class(self)`
-Returns the class that should be used for the serializer. Defaults to returning the `serializer_class` attribute, or dynamically generating a serializer class if the `model` shortcut is being used.
+Returns the class that should be used for the serializer. Defaults to returning the `serializer_class` attribute.
May be overridden to provide dynamic behavior, such as using different serializers for read and write operations, or providing different serializers to different types of users.
--
cgit v1.2.3
From 18cc0230bff436da2f26b2b25034cece32c9f5d0 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 4 Mar 2015 15:51:00 +0000
Subject: Clean up pagination attributes
---
docs/api-guide/generic-views.md | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 61c8e8d8..39e09aaa 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -84,10 +84,9 @@ The following attributes control the basic view behavior.
The following attributes are used to control pagination when used with list views.
-* `paginate_by` - The size of pages to use with paginated data. If set to `None` then pagination is turned off. If unset this uses the same value as the `PAGINATE_BY` setting, which defaults to `None`.
-* `paginate_by_param` - The name of a query parameter, which can be used by the client to override the default page size to use for pagination. If unset this uses the same value as the `PAGINATE_BY_PARAM` setting, which defaults to `None`.
-* `pagination_serializer_class` - The pagination serializer class to use when determining the style of paginated responses. Defaults to the same value as the `DEFAULT_PAGINATION_SERIALIZER_CLASS` setting.
-* `page_kwarg` - The name of a URL kwarg or URL query parameter which can be used by the client to control which page is requested. Defaults to `'page'`.
+* `pagination_class` - The pagination class that should be used when paginating list results. Defaults to the same value as the `DEFAULT_PAGINATION_CLASS` setting, which is `'rest_framework.pagination.PageNumberPagination'`.
+
+Note that usage of the `paginate_by`, `paginate_by_param` and `page_kwarg` attributes are now pending deprecation. The `pagination_serializer_class` attribute and `DEFAULT_PAGINATION_SERIALIZER_CLASS` setting have been removed completely. Pagination settings should instead be controlled by overriding a pagination class and setting any configuration attributes there. See the pagination documentation for more details.
**Filtering**:
--
cgit v1.2.3
From 2ddb6bfa70036bc1182a768807362b4e46a1b67b Mon Sep 17 00:00:00 2001
From: José Padilla
Date: Sat, 7 Mar 2015 10:19:25 -0400
Subject: Fix permissions on markdown files
---
docs/api-guide/generic-views.md | 0
1 file changed, 0 insertions(+), 0 deletions(-)
mode change 100755 => 100644 docs/api-guide/generic-views.md
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
old mode 100755
new mode 100644
--
cgit v1.2.3
From d12de927adaac6018f3e8c232307b76372fe3527 Mon Sep 17 00:00:00 2001
From: José Padilla
Date: Sat, 7 Mar 2015 10:49:56 -0400
Subject: Remove docs for 3.0 banners
---
docs/api-guide/generic-views.md | 6 ------
1 file changed, 6 deletions(-)
(limited to 'docs/api-guide/generic-views.md')
diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 39e09aaa..7df3d6ff 100644
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -1,12 +1,6 @@
source: mixins.py
generics.py
----
-
-**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
-
----
-
# Generic views
> Django’s generic views... were developed as a shortcut for common usage patterns... They take certain common idioms and patterns found in view development and abstract them so that you can quickly write common views of data without having to repeat yourself.
--
cgit v1.2.3