Change SimpleArrayField size for length

Author: WaVEV

django_mongodb_backend/fields/array.py

@@ -227,7 +227,7 @@ def formfield(self, **kwargs):
                 "form_class": SimpleArrayField,
                 "base_field": self.base_field.formfield(),
                 "max_length": self.max_size,
-                "size": self.size,
+                "length": self.size,
                 **kwargs,
             }
         )

django_mongodb_backend/forms/fields/array.py

@@ -15,14 +15,14 @@ class SimpleArrayField(forms.CharField):
     }
 
     def __init__(
-        self, base_field, *, delimiter=",", max_length=None, min_length=None, size=None, **kwargs
+        self, base_field, *, delimiter=",", max_length=None, min_length=None, length=None, **kwargs
     ):
         self.base_field = base_field
         self.delimiter = delimiter
         super().__init__(**kwargs)
-        if (min_length is not None or max_length is not None) and size is not None:
+        if (min_length is not None or max_length is not None) and length is not None:
             raise ImproperlyConfigured(
-                "SimpleArrayField param 'size' cannot be "
+                "SimpleArrayField param 'length' cannot be "
                 "specified with 'max_length' or 'min_length'."
             )
         if min_length is not None:
@@ -31,9 +31,9 @@ def __init__(
         if max_length is not None:
             self.max_length = max_length
             self.validators.append(ArrayMaxLengthValidator(int(max_length)))
-        if size is not None:
-            self.size = size
-            self.validators.append(LengthValidator(int(size)))
+        if length is not None:
+            self.length = length
+            self.validators.append(LengthValidator(int(length)))
 
     def clean(self, value):
         value = super().clean(value)

docs/source/ref/forms.rst

@@ -33,7 +33,7 @@ Stores an :class:`~bson.objectid.ObjectId`.
 ``SimpleArrayField``
 --------------------
 
-.. class:: SimpleArrayField(base_field, delimiter=',', max_length=None, min_length=None)
+.. class:: SimpleArrayField(base_field, delimiter=',', length=None, max_length=None, min_length=None)
 
     A field which maps to an array. It is represented by an HTML ``<input>``.
 
@@ -91,6 +91,17 @@ Stores an :class:`~bson.objectid.ObjectId`.
             in cases where the delimiter is a valid character in the underlying
             field. The delimiter does not need to be only one character.
 
+    .. attribute:: length
+
+        This is an optional argument which validates that the array reaches at
+        exactly the stated length.
+
+        .. note::
+            Defining ``length`` along with ``max_length`` or ``min_length``
+            will raise an exception. Use ``length`` for fixed-length arrays
+            and ``max_length`` / ``min_length`` for variable-length arrays
+            with an upper or lower limit.
+
     .. attribute:: max_length
 
         This is an optional argument which validates that the array does not
@@ -101,15 +112,6 @@ Stores an :class:`~bson.objectid.ObjectId`.
         This is an optional argument which validates that the array reaches at
         least the stated length.
 
-    .. attribute:: size
-
-        This is an optional argument which validates that the array reaches at
-        exactly the stated length.
-
-        .. note::
-            Defining ``size`` along with ``max_length`` or ``min_length`` will raise an exception.
-            Use ``size`` for fixed-length arrays and ``max_length`` / ``min_length`` for variable-length arrays with an upper or lower limit.
-
     .. admonition:: User friendly forms
 
         ``SimpleArrayField`` is not particularly user friendly in most cases,

docs/source/ref/models/fields.rst

@@ -55,10 +55,6 @@ Some MongoDB-specific fields are available in ``django_mongodb_backend.fields``.
                     ),
                     size=8,
                 )
-                active_pieces = ArrayField(
-                    models.CharField(max_length=10, blank=True),
-                    max_size=32
-                )
 
         Transformation of values between the database and the model, validation
         of data and configuration, and serialization are all delegated to the

tests/forms_tests_/test_array.py

@@ -116,7 +116,7 @@ def test_min_length_singular(self):
             field.clean([1])
 
     def test_size_length(self):
-        field = SimpleArrayField(forms.CharField(max_length=27), size=4)
+        field = SimpleArrayField(forms.CharField(max_length=27), length=4)
         with self.assertRaises(exceptions.ValidationError) as cm:
             field.clean(["a", "b", "c"])
         self.assertEqual(
@@ -131,7 +131,7 @@ def test_size_length(self):
         )
 
     def test_size_length_singular(self):
-        field = SimpleArrayField(forms.CharField(max_length=27), size=4)
+        field = SimpleArrayField(forms.CharField(max_length=27), length=4)
         with self.assertRaises(exceptions.ValidationError) as cm:
             field.clean(["a"])
         self.assertEqual(
@@ -146,12 +146,14 @@ def test_required(self):
         self.assertEqual(cm.exception.messages[0], "This field is required.")
 
     def test_misconfigured(self):
-        msg = "SimpleArrayField param 'size' cannot be specified with 'max_length' or 'min_length'."
+        msg = (
+            "SimpleArrayField param 'length' cannot be specified with 'max_length' or 'min_length'."
+        )
         with self.assertRaises(exceptions.ImproperlyConfigured) as cm:
-            SimpleArrayField(forms.CharField(), max_length=3, size=2)
+            SimpleArrayField(forms.CharField(), max_length=3, length=2)
         self.assertEqual(cm.exception.args[0], msg)
         with self.assertRaises(exceptions.ImproperlyConfigured) as cm:
-            SimpleArrayField(forms.CharField(), min_length=3, size=2)
+            SimpleArrayField(forms.CharField(), min_length=3, length=2)
         self.assertEqual(cm.exception.args[0], msg)
 
     def test_model_field_formfield(self):
@@ -171,7 +173,7 @@ def test_model_field_formfield_size(self):
         model_field = ArrayField(models.CharField(max_length=27), size=4)
         form_field = model_field.formfield()
         self.assertIsInstance(form_field, SimpleArrayField)
-        self.assertEqual(form_field.size, 4)
+        self.assertEqual(form_field.length, 4)
 
     def test_model_field_choices(self):
         model_field = ArrayField(models.IntegerField(choices=((1, "A"), (2, "B"))))