Merge pull request #388 from peopledoc/from-json-pass-context

Pass context to serializer in from_json

Author: brunobord

CHANGELOG.rst

@@ -5,7 +5,7 @@ ChangeLog
 master (unreleased)
 ===================
 
-Nothing to see here yet.
+- Pass context to serializer in from_json.
 
 Release 6.0.0 (2020-10-07)
 ==========================

demo/tests/test_forms.py

@@ -1,5 +1,5 @@
 import json
-import os
+from os.path import dirname, join
 
 from django import forms
 from django.core.exceptions import ValidationError
@@ -8,7 +8,7 @@
 from freezegun import freeze_time
 
 from formidable.constants import REQUIRED, EDITABLE, READONLY, HIDDEN
-from formidable.models import Formidable
+from formidable.models import Formidable, get_serializer
 from formidable.forms import FormidableForm, widgets, fields
 
 
@@ -787,8 +787,10 @@ def test_from_json(self):
         We should have an instance of ``Formidable``.
 
         """
-        filepath = os.path.join(os.path.dirname(__file__),
-                                '../fixtures/augmentation_heures.json')
+        filepath = join(
+            dirname(__file__),
+            '../fixtures/augmentation_heures.json'
+        )
         with open(filepath) as f:
             schema_definition = json.load(f)
 
@@ -808,3 +810,20 @@ def test_from_json_raised_error(self):
         self.assertEqual(len(context.exception.messages), 3)
         for message in context.exception.messages:
             self.assertEqual(message, 'This field is required.')
+
+    def test_get_serializer_with_context(self):
+        filepath = join(
+            dirname(__file__),
+            '../fixtures/augmentation_heures.json'
+        )
+        with open(filepath) as f:
+            schema_definition = json.load(f)
+
+        # get_serializer is a function that is called in from_json.
+        serializer = get_serializer(schema_definition)
+        self.assertEqual(serializer.context, {})
+
+        serializer = get_serializer(
+            schema_definition,
+            context={"hello": "world"})
+        self.assertEqual(serializer.context, {"hello": "world"})

formidable/models.py

@@ -7,6 +7,17 @@
 from formidable.register import FieldSerializerRegister
 
 
+def get_serializer(definition_schema, context=None):
+    """
+    Return a FormidableSerializer instance, including eventual context.
+    """
+    from formidable.serializers import FormidableSerializer
+    serializer = FormidableSerializer(data=definition_schema)
+    # pass context to serializer so we can use it during data validation
+    serializer.context.update(context or {})  # If None, will default to {}
+    return serializer
+
+
 class Formidable(models.Model):
 
     label = models.CharField(max_length=256)
@@ -48,9 +59,8 @@ def from_json(definition_schema, **kwargs):
         <Formidable: Formidable object>
 
         """
-        from formidable.serializers import FormidableSerializer
-
-        serializer = FormidableSerializer(data=definition_schema)
+        context = kwargs.pop("context", {})
+        serializer = get_serializer(definition_schema, context)
         if not serializer.is_valid():
             raise ValidationError(serializer.errors)