ENH: Raise exception on incorrect props

Author: thclark

django_svelte_jsoneditor/exceptions.py

@@ -1,2 +1,2 @@
-class ExampleError(Exception):
-    """Example for custom exception definition"""
+class InvalidPropError(ValueError):
+    """Raised when props are incorrectly configured"""

django_svelte_jsoneditor/settings.py

@@ -1,5 +1,7 @@
 from django.conf import settings
 
+from .exceptions import InvalidPropError
+
 
 DEFAULT_SVELTE_JSONEDITOR_PROPS = {
     "mode": "tree",
@@ -16,9 +18,23 @@
 }
 
 
+_AVAILABLE_PROPS = set(DEFAULT_SVELTE_JSONEDITOR_PROPS.keys())
+
+
+def check_props(props):
+    """Check that props given to the widget are valid"""
+    for key in props:
+        if key not in _AVAILABLE_PROPS:
+            raise InvalidPropError(f"Invalid prop '{key}'")
+
+    return props
+
+
 def get_props():
     """Get default props overridden by any props set in the SVELTE_JSONEDITOR_PROPS setting"""
-    return {
-        **DEFAULT_SVELTE_JSONEDITOR_PROPS,
-        **getattr(settings, "SVELTE_JSONEDITOR_PROPS", {}),
-    }
+    return check_props(
+        {
+            **DEFAULT_SVELTE_JSONEDITOR_PROPS,
+            **getattr(settings, "SVELTE_JSONEDITOR_PROPS", {}),
+        }
+    )

django_svelte_jsoneditor/widgets.py

@@ -1,7 +1,7 @@
 import json
 from django.forms import Textarea
 
-from .settings import get_props
+from .settings import check_props, get_props
 
 
 class SvelteJSONEditorWidget(Textarea):
@@ -12,6 +12,7 @@ def __init__(self, props=None, attrs=None):
             attrs = {}
 
         self.props = {} if props is None else props.copy()
+        check_props(self.props)
         attrs.update({"class": "hidden"})
 
         super().__init__(attrs)

tests/test_widget.py

@@ -7,6 +7,7 @@
 from django.contrib.auth.models import User
 from django.test import Client, TestCase
 from django.test.utils import override_settings
+from django_svelte_jsoneditor.exceptions import InvalidPropError
 from django_svelte_jsoneditor.widgets import SvelteJSONEditorWidget
 
 from tests.server.example.models import ExampleBlankJsonFieldModel, ExampleJsonFieldModel
@@ -99,3 +100,15 @@ class SvelteJsonEditorForm(forms.Form):
 
         form = SvelteJsonEditorForm()
         self.assertIn('"readOnly": false', str(form["my_json"]))
+
+    @override_settings(SVELTE_JSONEDITOR_PROPS={**{"incorrectProp": True}})
+    def test_svelte_jsoneditor_widget_incorrect_props(self):
+
+        # for props at the widget level
+        with self.assertRaises(InvalidPropError):
+            SvelteJSONEditorWidget(props={"incorrectProp": True})
+
+        # for props in settings
+        with self.assertRaises(InvalidPropError):
+            widget = SvelteJSONEditorWidget()
+            widget.get_context("my_json", "null", {"required": True, "id": "id_my_json"})