Initial commit

Author: dbrgn

.gitignore

@@ -0,0 +1,8 @@
+.cache/
+.coverage
+*.swp
+*.pyc
+__pycache__
+dist/
+*.egg-info/
+build/

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014--2016 Danilo Bargen and contributors
+
+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.

README.rst

@@ -0,0 +1,51 @@
+Dynamic Serializer Fields for Django REST Framework
+===================================================
+
+This package provides a mixin that allows the user to select only a sbuset of
+fields per resource.
+
+Example
+-------
+
+Serializer::
+
+    class IdentitySerializer(serializers.HyperlinkedModelSerializer):
+        class Meta:
+            model = models.Identity
+            fields = ('id', 'url', 'type', 'data')
+
+A regular request returns all fields:
+
+``GET /identities``
+
+::
+
+    [
+      {
+        "id": 1,
+        "url": "http://localhost:8000/api/identities/1/",
+        "type": 5,
+        "data": "John Doe"
+      },
+      ...
+    ]
+
+A query with the `fields` parameter on the other hand returns only a subset of
+the fields:
+
+``GET /identities/?fields=id,data``
+
+::
+
+    [
+      {
+        "id": 1,
+        "data": "John Doe"
+      },
+      ...
+    ]
+
+License
+-------
+
+MIT license, see ``LICENSE`` file.

drf_dynamic_fields/__init__.py

@@ -0,0 +1,28 @@
+import warnings
+
+
+class DynamicFieldsMixin(object):
+    """
+    A serializer mixin that takes an additional `fields` argument that controls
+    which fields should be displayed.
+    """
+    def __init__(self, *args, **kwargs):
+        super(DynamicFieldsMixin, self).__init__(*args, **kwargs)
+
+        # If the context is not set, return
+        if not self.context:
+            return
+
+        # If the request is not passed in, warn and return
+        if 'request' not in self.context:
+            warnings.warn('Context does not have access to request')
+            return
+
+        fields = self.context['request'].query_params.get('fields', None)
+        if fields:
+            fields = fields.split(',')
+            # Drop any fields that are not specified in the `fields` argument.
+            allowed = set(fields)
+            existing = set(self.fields.keys())
+            for field_name in existing - allowed:
+                self.fields.pop(field_name)