Merge branch 'master' of https://github.com/dabapps/serialization-spec

.github/workflows/pypi.yml

@@ -0,0 +1,26 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

serialization_spec/serialization.py

@@ -1,3 +1,4 @@
+from django.core.exceptions import ImproperlyConfigured
 from django.db.models import Prefetch
 from rest_framework.utils import model_meta
 from rest_framework.fields import Field
@@ -6,6 +7,7 @@
 
 from typing import List, Dict, Union
 from collections import OrderedDict
+import copy
 
 """
 Parse a serialization spec such as:
@@ -201,18 +203,36 @@ def prefetch_related(request_user, queryset, model, prefixes, serialization_spec
     return queryset
 
 
+def get_serialization_spec(view_or_plugin, request_user=None):
+    if hasattr(view_or_plugin, 'get_serialization_spec'):
+        view_or_plugin.request_user = request_user
+        return view_or_plugin.get_serialization_spec()
+    return getattr(view_or_plugin, 'serialization_spec', None)
+
+
 def expand_nested_specs(serialization_spec, request_user):
-    def get_serialization_spec(serialization_spec_plugin):
-        if hasattr(serialization_spec_plugin, 'get_serialization_spec'):
-            serialization_spec_plugin.request_user = request_user
-            return serialization_spec_plugin.get_serialization_spec()
-        return getattr(serialization_spec_plugin, 'serialization_spec', [])
+    expanded_serialization_spec = []
+
+    for each in serialization_spec:
+        if not isinstance(each, dict):
+            expanded_serialization_spec.append(each)
+        else:
+            expanded_dict = {}
+            for key, childspec in each.items():
+                if isinstance(childspec, SerializationSpecPlugin):
+                    serialization_spec = get_serialization_spec(childspec, request_user)
+                    if serialization_spec is not None:
+                        plugin_copy = copy.deepcopy(childspec)
+                        plugin_copy.serialization_spec = expand_nested_specs(plugin_copy.serialization_spec, request_user)
+                        expanded_serialization_spec += plugin_copy.serialization_spec
+                        expanded_dict[key] = plugin_copy
+                    else:
+                        expanded_dict[key] = childspec
+                else:
+                    expanded_dict[key] = expand_nested_specs(childspec, request_user)
+            expanded_serialization_spec.append(expanded_dict)
 
-    return serialization_spec + sum([
-        get_serialization_spec(childspec)
-        for each in serialization_spec if isinstance(each, dict)
-        for key, childspec in each.items() if isinstance(childspec, SerializationSpecPlugin)
-    ], [])
+    return expanded_serialization_spec
 
 
 class NormalisedSpec:
@@ -278,8 +298,9 @@ def get_object(self):
 
     def get_queryset(self):
         queryset = self.queryset
-        if hasattr(self, 'get_serialization_spec'):
-            self.serialization_spec = self.get_serialization_spec()
+        self.serialization_spec = get_serialization_spec(self)
+        if self.serialization_spec is None:
+            raise ImproperlyConfigured('SerializationSpecMixin requires serialization_spec or get_serialization_spec')
         expand_many2many_id_fields(queryset.model, self.serialization_spec)
         serialization_spec = expand_nested_specs(self.serialization_spec, self.request.user)
         serialization_spec = normalise_spec(serialization_spec)