- Add return_int parameter to Enum[8|16]Field to control whether to get an int or str value when querying from the database.

- Fix TupleField container_class.
- Add fields documentation.

Author: 林志文

README.md

@@ -317,6 +317,13 @@ $ tox
 Changelog
 ---
 
+### 1.0.1 (2023-02-23)
+
+- Add `return_int` parameter to `Enum[8|16]Field` to control whether to get an int or str value when querying from the database.
+- Fix TupleField container_class.
+- Add fields documentation.
+
+
 ### 1.0.0 (2023-02-21)
 
 - Add tests for migrations.

clickhouse_backend/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

clickhouse_backend/driver/__init__.py

@@ -8,6 +8,7 @@
 )
 
 from .connection import Connection
+# Binary is compatible for django's BinaryField.
 from .types import (  # NOQA
     Binary
 )

clickhouse_backend/models/fields/__init__.py

@@ -28,8 +28,8 @@
     "UUIDField",
     "DateField", "Date32Field", "DateTimeField", "DateTime64Field",
     "Enum8Field", "Enum16Field", "EnumField",
-    "ArrayField", "TupleField", "MapField",
     "IPv4Field", "IPv6Field", "GenericIPAddressField",
+    "ArrayField", "TupleField", "MapField",
 ]
 
 
@@ -256,6 +256,11 @@ class EnumField(FieldMixin, fields.Field):
     MIN_INT = -32768
     MAX_INT = 32767
 
+    def __init__(self, *args, return_int=True, **kwargs):
+        """Use return_int to control whether to get an int or str value when querying from the database."""
+        self.return_int = return_int
+        super().__init__(*args, **kwargs)
+
     def _check_choices(self):
         """Note: although clickhouse support arbitrary bytes in Enum name,
         but clickhouse-driver 0.2.5 will raise UnicodeDecodeError when execute query."""
@@ -343,7 +348,8 @@ def get_prep_value(self, value):
         return value
 
     def from_db_value(self, value, expression, connection):
-        if value is None:
+        """Clickhouse return enum name for Enum column."""
+        if value is None or not self.return_int:
             return value
         return self._name_value_map[value]
 

clickhouse_backend/models/fields/tuple.py

@@ -102,16 +102,6 @@ def check(self, **kwargs):
                     )
                 ]
 
-        if self.is_named_tuple:
-            name = self.name
-            if name:
-                name = name.capitalize()
-            else:
-                name = "Tuple"
-            self.container_class = collections.namedtuple(name, (fn for fn, _ in self.base_fields))
-        else:
-            self.container_class = tuple
-
         return []
 
     def get_internal_type(self):
@@ -144,6 +134,15 @@ def set_attributes_from_name(self, name):
                 field.set_attributes_from_name(name)
             else:
                 field[1].set_attributes_from_name(name)
+        if self.is_named_tuple:
+            name = self.name
+            if name:
+                name = name.capitalize()
+            else:
+                name = "Tuple"
+            self.container_class = collections.namedtuple(name, (fn for fn, _ in self.base_fields))
+        else:
+            self.container_class = tuple
 
     def _convert_type(self, value):
         if value is None or isinstance(value, self.container_class):

docs/Fields.md

@@ -77,19 +77,16 @@ def test_validate(self):
             base_fields=[
                 models.TupleField(
                     base_fields=[
-                        models.Int8Field(name="field"),
-                        models.IPv4Field(name="field")
+                        models.Int8Field(),
+                        models.IPv4Field()
                     ],
-                    name="field"
                 ),
                 models.ArrayField(
-                    base_field=models.StringField(name="field"),
-                    name="field"
+                    base_field=models.StringField(),
                 )
             ],
-            name="field"
         )
-        field.check()
+        field.set_attributes_from_name("field")
         with self.assertRaises(ValidationError):
             field.clean([130], None)
         with self.assertRaises(ValidationError):
@@ -105,23 +102,20 @@ def test_validate(self):
                     "tup",
                     models.TupleField(
                         base_fields=[
-                            ("int", models.Int8Field(name="field")),
-                            ("ip", models.IPv4Field(name="field"))
+                            ("int", models.Int8Field()),
+                            ("ip", models.IPv4Field())
                         ],
-                        name="field"
                     )
                 ),
                 (
                     "arr",
                     models.ArrayField(
-                        base_field=models.StringField(name="field"),
-                        name="field"
+                        base_field=models.StringField(),
                     )
                 )
             ],
-            name="field"
         )
-        field.check()
+        field.set_attributes_from_name("field")
         with self.assertRaises(ValidationError):
             field.clean([130], None)
         with self.assertRaises(ValidationError):