can provide a JSON default as a dict or list

Author: dantownsend

piccolo/columns/column_types.py

@@ -1054,8 +1054,22 @@ class JSON(Column):
 
     value_type = str
 
-    def __init__(self, default: t.Union[str, None] = "{}", **kwargs) -> None:
-        self._validate_default(default, (str, None))
+    def __init__(
+        self, default: t.Union[str, t.List, t.Dict, None] = "{}", **kwargs
+    ) -> None:
+        self._validate_default(default, (str, list, dict, None))
+
+        if isinstance(default, (list, dict)):
+            # TODO - move to utils
+            try:
+                import orjson
+            except ImportError:
+                import json
+
+                default = json.dumps(default, default=str)
+            else:
+                default = orjson.dumps(default, default=str).decode("utf8")
+
         self.default = default
         kwargs.update({"default": default})
         super().__init__(**kwargs)

tests/columns/test_json.py

@@ -9,7 +9,15 @@ class MyTable(Table):
 
 
 class MyTableDefault(Table):
-    json = JSON(default="{}")
+    """
+    Test the different default types.
+    """
+
+    json = JSON()
+    json_str = JSON(default="{}")
+    json_dict = JSON(default={})
+    json_list = JSON(default=[])
+    json_none = JSON(default=None, null=True)
 
 
 class TestJSON(TestCase):
@@ -24,7 +32,25 @@ def test_json(self):
         row.save().run_sync()
         self.assertEqual(row.json, '{"a": 1}')
 
+
+class TestJSONDefault(TestCase):
+    def setUp(self):
+        MyTableDefault.create_table().run_sync()
+
+    def tearDown(self):
+        MyTableDefault.alter().drop_table().run_sync()
+
     def test_json_default(self):
-        row = MyTable()
+        row = MyTableDefault()
         row.save().run_sync()
+
         self.assertEqual(row.json, "{}")
+        self.assertEqual(row.json_str, "{}")
+        self.assertEqual(row.json_dict, "{}")
+        self.assertEqual(row.json_list, "[]")
+        self.assertEqual(row.json_none, None)
+
+    def test_invalid_default(self):
+        with self.assertRaises(ValueError):
+            for value in ("a", 1, ("x", "y", "z")):
+                JSON(default=value)