added convert_to_sql_value

There are a bunch of places in the codebase which need to check if value are Enums, JSON, or Table instances, and convert them to values the database will understand.

This logic has now been centralised into the `convert_to_sql_value` function.

Author: dantownsend

piccolo/columns/combination.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
-from enum import Enum
 import typing as t
 
 from piccolo.columns.operators.comparison import ComparisonOperator
 from piccolo.custom_types import Combinable, Iterable
 from piccolo.querystring import QueryString
+from piccolo.query.sql_values import convert_to_sql_value
 
 if t.TYPE_CHECKING:
     from piccolo.columns.base import Column
@@ -121,20 +121,17 @@ def clean_value(self, value: t.Any) -> t.Any:
             # it should still work.
             Band.select().where(Band.manager == guido).run_sync()
 
-        """
-        from piccolo.table import Table
+        Also, convert Enums to their underlying values, and serialise any JSON.
 
-        if isinstance(value, Table):
-            return value.id
-        else:
-            return value
+        """
+        return convert_to_sql_value(value=value, column=self.column)
 
     @property
     def values_querystring(self) -> QueryString:
-        if isinstance(self.values, Undefined):
-            raise ValueError("values is undefined")
+        values = self.values
 
-        values = [i.value if isinstance(i, Enum) else i for i in self.values]
+        if isinstance(values, Undefined):
+            raise ValueError("values is undefined")
 
         template = ", ".join(["{}" for _ in values])
         return QueryString(template, *values)
@@ -143,12 +140,8 @@ def values_querystring(self) -> QueryString:
     def querystring(self) -> QueryString:
         args: t.List[t.Any] = []
         if self.value != UNDEFINED:
-            value = (
-                self.value.value
-                if isinstance(self.value, Enum)
-                else self.value
-            )
-            args.append(value)
+            args.append(self.value)
+
         if self.values != UNDEFINED:
             args.append(self.values_querystring)
 

piccolo/query/mixins.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
-from enum import Enum
 import typing as t
 
 from piccolo.columns import And, Column, Secret, Where, Or
 from piccolo.custom_types import Combinable
+from piccolo.query.sql_values import convert_to_sql_value
 from piccolo.querystring import QueryString
 
 if t.TYPE_CHECKING:  # pragma: no cover
@@ -171,6 +171,7 @@ def add(self, *instances: Table, table_class: t.Type[Table]):
         for instance in instances:
             if not isinstance(instance, table_class):
                 raise TypeError("Incompatible type added.")
+
         self._add += instances
 
 
@@ -271,11 +272,11 @@ def values(self, values: t.Dict[t.Union[Column, str], t.Any]):
 
     def get_sql_values(self) -> t.List[t.Any]:
         """
-        Convert any Enums into values.
+        Convert any Enums into values, and serialise any JSON.
         """
         return [
-            value.value if isinstance(value, Enum) else value
-            for value in self._values.values()
+            convert_to_sql_value(value=value, column=column)
+            for column, value in self._values.items()
         ]
 
 

piccolo/query/sql_values.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+from enum import Enum
+import typing as t
+
+from piccolo.utils.encoding import dump_json
+
+if t.TYPE_CHECKING:
+    from piccolo.columns import Column
+
+
+def convert_to_sql_value(value: t.Any, column: Column) -> t.Any:
+    """
+    Some values which can be passed into Piccolo queries aren't valid in the
+    database. For example, Enums, Table instances, and dictionaries for JSON
+    columns.
+    """
+    from piccolo.table import Table
+    from piccolo.columns.column_types import JSON, JSONB
+
+    if isinstance(value, Table):
+        return value.id
+    elif isinstance(value, Enum):
+        return value.value
+    elif isinstance(column, (JSON, JSONB)) and not isinstance(value, str):
+        return dump_json(value)
+    else:
+        return value

piccolo/table.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
-from enum import Enum
 import inspect
 import itertools
 import types
@@ -38,6 +37,7 @@
 )
 from piccolo.query.methods.indexes import Indexes
 from piccolo.query.methods.create_index import CreateIndex
+from piccolo.query.sql_values import convert_to_sql_value
 from piccolo.querystring import QueryString, Unquoted
 from piccolo.utils import _camel_to_snake
 
@@ -418,10 +418,9 @@ def querystring(self) -> QueryString:
         """
         args_dict = {}
         for col in self._meta.columns:
-            value = self[col._meta.name]
-            args_dict[col._meta.name] = (
-                value.value if isinstance(value, Enum) else value
-            )
+            column_name = col._meta.name
+            value = convert_to_sql_value(value=self[column_name], column=col)
+            args_dict[column_name] = value
 
         def is_unquoted(arg):
             return type(arg) == Unquoted