Rename ArrayField.size to max_size

Author: timgraham

django_mongodb_backend/fields/array.py

@@ -27,13 +27,13 @@ class ArrayField(CheckFieldDefaultMixin, Field):
     }
     _default_hint = ("list", "[]")
 
-    def __init__(self, base_field, size=None, **kwargs):
+    def __init__(self, base_field, max_size=None, **kwargs):
         self.base_field = base_field
-        self.size = size
-        if self.size:
+        self.max_size = max_size
+        if self.max_size:
             self.default_validators = [
                 *self.default_validators,
-                ArrayMaxLengthValidator(self.size),
+                ArrayMaxLengthValidator(self.max_size),
             ]
         # For performance, only add a from_db_value() method if the base field
         # implements it.
@@ -127,7 +127,7 @@ def deconstruct(self):
         kwargs.update(
             {
                 "base_field": self.base_field.clone(),
-                "size": self.size,
+                "max_size": self.max_size,
             }
         )
         return name, path, args, kwargs
@@ -213,7 +213,7 @@ def formfield(self, **kwargs):
             **{
                 "form_class": SimpleArrayField,
                 "base_field": self.base_field.formfield(),
-                "max_length": self.size,
+                "max_length": self.max_size,
                 **kwargs,
             }
         )

docs/source/ref/models/fields.rst

@@ -8,13 +8,13 @@ Some MongoDB-specific fields are available in ``django_mongodb_backend.fields``.
 ``ArrayField``
 --------------
 
-.. class:: ArrayField(base_field, size=None, **options)
+.. class:: ArrayField(base_field, max_size=None, **options)
 
     A field for storing lists of data. Most field types can be used, and you
     pass another field instance as the :attr:`base_field
-    <ArrayField.base_field>`. You may also specify a :attr:`size
-    <ArrayField.size>`. ``ArrayField`` can be nested to store multi-dimensional
-    arrays.
+    <ArrayField.base_field>`. You may also specify a :attr:`max_size
+    <ArrayField.max_size>`. ``ArrayField`` can be nested to store
+    multi-dimensional arrays.
 
     If you give the field a :attr:`~django.db.models.Field.default`, ensure
     it's a callable such as ``list`` (for an empty default) or a callable that
@@ -50,16 +50,16 @@ Some MongoDB-specific fields are available in ``django_mongodb_backend.fields``.
                 board = ArrayField(
                     ArrayField(
                         models.CharField(max_length=10, blank=True),
-                        size=8,
+                        max_size=8,
                     ),
-                    size=8,
+                    max_size=8,
                 )
 
         Transformation of values between the database and the model, validation
         of data and configuration, and serialization are all delegated to the
         underlying base field.
 
-    .. attribute:: size
+    .. attribute:: max_size
 
         This is an optional argument.
 
@@ -168,8 +168,8 @@ Index transforms
 ^^^^^^^^^^^^^^^^
 
 Index transforms index into the array. Any non-negative integer can be used.
-There are no errors if it exceeds the :attr:`size <ArrayField.size>` of the
-array. The lookups available after the transform are those from the
+There are no errors if it exceeds the :attr:`max_size <ArrayField.max_size>` of
+the array. The lookups available after the transform are those from the
 :attr:`base_field <ArrayField.base_field>`. For example:
 
 .. code-block:: pycon

docs/source/releases/5.1.x.rst

@@ -7,6 +7,8 @@ Django MongoDB Backend 5.1.x
 
 *Unreleased*
 
+- Backward-incompatible: :class:`~django_mongodb_backend.fields.ArrayField`\'s
+  ``size`` argument is renamed to ``max_size``.
 - Added support for :doc:`database caching </topics/cache>`.
 
 5.1.0 beta 1

tests/forms_tests_/test_array.py

@@ -128,8 +128,8 @@ def test_model_field_formfield(self):
         self.assertIsInstance(form_field.base_field, forms.CharField)
         self.assertEqual(form_field.base_field.max_length, 27)
 
-    def test_model_field_formfield_size(self):
-        model_field = ArrayField(models.CharField(max_length=27), size=4)
+    def test_model_field_formfield_max_size(self):
+        model_field = ArrayField(models.CharField(max_length=27), max_size=4)
         form_field = model_field.formfield()
         self.assertIsInstance(form_field, SimpleArrayField)
         self.assertEqual(form_field.max_length, 4)

tests/model_fields_/array_default_migrations/0001_initial.py

@@ -21,7 +21,7 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "field",
-                    django_mongodb_backend.fields.ArrayField(models.IntegerField(), size=None),
+                    django_mongodb_backend.fields.ArrayField(models.IntegerField(), max_size=None),
                 ),
             ],
             options={},

tests/model_fields_/array_default_migrations/0002_integerarraymodel_field_2.py

@@ -13,7 +13,7 @@ class Migration(migrations.Migration):
             model_name="integerarraydefaultmodel",
             name="field_2",
             field=django_mongodb_backend.fields.ArrayField(
-                models.IntegerField(), default=[], size=None
+                models.IntegerField(), default=[], max_size=None
             ),
             preserve_default=False,
         ),

tests/model_fields_/array_index_migrations/0001_initial.py

@@ -22,7 +22,7 @@ class Migration(migrations.Migration):
                 (
                     "char",
                     django_mongodb_backend.fields.ArrayField(
-                        models.CharField(max_length=10), db_index=True, size=100
+                        models.CharField(max_length=10), db_index=True, max_size=100
                     ),
                 ),
                 ("char2", models.CharField(max_length=11, db_index=True)),

tests/model_fields_/test_arrayfield.py

@@ -89,11 +89,11 @@ def test_deconstruct(self):
         self.assertEqual(type(new.base_field), type(field.base_field))
         self.assertIsNot(new.base_field, field.base_field)
 
-    def test_deconstruct_with_size(self):
-        field = ArrayField(models.IntegerField(), size=3)
+    def test_deconstruct_with_max_size(self):
+        field = ArrayField(models.IntegerField(), max_size=3)
         name, path, args, kwargs = field.deconstruct()
         new = ArrayField(*args, **kwargs)
-        self.assertEqual(new.size, field.size)
+        self.assertEqual(new.max_size, field.max_size)
 
     def test_deconstruct_args(self):
         field = ArrayField(models.CharField(max_length=20))
@@ -722,7 +722,7 @@ class MigrationsTests(TransactionTestCase):
     )
     def test_adding_field_with_default(self):
         class IntegerArrayDefaultModel(models.Model):
-            field = ArrayField(models.IntegerField(), size=None)
+            field = ArrayField(models.IntegerField(), max_size=None)
 
         table_name = "model_fields__integerarraydefaultmodel"
         self.assertNotIn(table_name, connection.introspection.table_names(None))
@@ -734,8 +734,8 @@ class IntegerArrayDefaultModel(models.Model):
         call_command("migrate", "model_fields_", "0002", verbosity=0)
 
         class UpdatedIntegerArrayDefaultModel(models.Model):
-            field = ArrayField(models.IntegerField(), size=None)
-            field_2 = ArrayField(models.IntegerField(), default=[], size=None)
+            field = ArrayField(models.IntegerField(), max_size=None)
+            field_2 = ArrayField(models.IntegerField(), default=[], max_size=None)
 
             class Meta:
                 db_table = "model_fields__integerarraydefaultmodel"
@@ -800,8 +800,8 @@ def test_blank_true(self):
         # This should not raise a validation error
         field.clean([1, None], None)
 
-    def test_with_size(self):
-        field = ArrayField(models.IntegerField(), size=3)
+    def test_with_max_size(self):
+        field = ArrayField(models.IntegerField(), max_size=3)
         field.clean([1, 2, 3], None)
         with self.assertRaises(exceptions.ValidationError) as cm:
             field.clean([1, 2, 3, 4], None)
@@ -810,8 +810,8 @@ def test_with_size(self):
             "List contains 4 items, it should contain no more than 3.",
         )
 
-    def test_with_size_singular(self):
-        field = ArrayField(models.IntegerField(), size=1)
+    def test_with_max_size_singular(self):
+        field = ArrayField(models.IntegerField(), max_size=1)
         field.clean([1], None)
         msg = "List contains 2 items, it should contain no more than 1."
         with self.assertRaisesMessage(exceptions.ValidationError, msg):