skip to navigation
skip to content

Not Logged In

djangorestframework-bulk 0.1

Django REST Framework bulk CRUD view mixins

Latest Version: 0.1.1

https://badge.fury.io/py/djangorestframework-bulk.png Bitdeli badge

Django REST Framework bulk CRUD view mixins.

Overview

Django REST Framework comes with many generic views however none of them allow to do bulk operations such as create, update and delete. To keep the core of Django REST Framework simple, its maintainer suggested to create a separate project to allow for bulk operations within the framework. That is the purpose of this project.

Requirements

  • Python (2.6, 2.7 and 3.3)
  • Django 1.3+
  • Django REST Framework >= 2.2.5 (when bulk features were added to serializers)

Installing

Using pip:

$ pip install djangorestframework-bulk

or from source code:

$ pip install -r git+http://github.com/miki725/django-rest-framework-bulk#egg=djangorestframework-bulk

Example

The bulk views (and mixins) are very similar to Django REST Framework's own generic views (and mixins):

from rest_framework_bulk import ListBulkCreateUpdateDestroyAPIView
class FooView(ListBulkCreateUpdateDestroyAPIView):
    model = FooModel

The above will allow to create the following queries

# list queryset
GET
# create single resource
POST
{"field":"value","field2":"value2"}     <- json object in request data
# create multiple resources
POST
[{"field":"value","field2":"value2"}]
# update multiple resources (requires all fields)
PUT
[{"field":"value","field2":"value2"}]   <- json list of objects in data
# partial update multiple resources
PATCH
[{"field":"value"}]                     <- json list of objects in data
# delete queryset (see notes)
DELETE

Notes

Most API urls have two URL levels for each resource:

  1. url(r'foo/', ...)
  2. url(r'foo/(?P<pk>\d+)/', ...)

The second url however is not applicable for bulk operations because the url directly maps to a single resource. Therefore all bulk generic views only apply to the first url.

There are multiple generic view classes in case only a certail bulk functionality is required. For example ListBulkCreateAPIView will only do bulk operations for creating resources. For a complete list of available generic view classes, please take a look at the source code at generics.py as it is mostly self-explanatory.

Most bulk operations are pretty safe in terms of how they operate, that is you excplicitly describe all requests. For example, if you need to update 3 specific resources, you have to explicitly identify those resources in the request's PUT or PATCH data. The only exception to this is bulk delete. Conside a DELETE request to the first url. That can potentially delete all resources without any special confirmation. To try to account for this, bulk delete mixin allows to implement a hook to determine if the bulk delete request should be allowed:

class FooView(BulkDestroyAPIView):
    def allow_bulk_destroy(self, qs, filtered):
        # custom logic here

        # default checks if the qs was filtered
        # qs comes from self.get_queryset()
        # filtered comes from self.filter_queryset(qs)
        return qs is not filtered

By default it checks if the queryset was filtered and if not will not allow the bulk delete to complete. The logic here is that if the request is filtered to only get certain resources, more attention was payed hence the action is less likely to be accidental. On how to filter requests, please refer to Django REST docs. Either way, please use bulk deletes with extreme causion since they can be dangerous.

Credits

Current maintainers:

License

The source code can be found at Github.

This library is licensed with MIT License:

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
File Type Py Version Uploaded on Size
djangorestframework-bulk-0.1.tar.gz (md5) Source 2014-01-18 6KB
  • Downloads (All Versions):
  • 17 downloads in the last day
  • 104 downloads in the last week
  • 390 downloads in the last month