edits

Author: timgraham

django_mongodb_backend/forms/fields/array.py

@@ -21,9 +21,9 @@ def __init__(
         self.delimiter = delimiter
         super().__init__(**kwargs)
         if (min_length is not None or max_length is not None) and length is not None:
+            invalid_param = "max_length" if max_length is not None else "min_length"
             raise ImproperlyConfigured(
-                "SimpleArrayField param 'length' cannot be "
-                "specified with 'max_length' or 'min_length'."
+                f"The length and {invalid_param} parameters are mutually exclusive."
             )
         if min_length is not None:
             self.min_length = min_length

docs/source/ref/forms.rst

@@ -93,14 +93,11 @@ Stores an :class:`~bson.objectid.ObjectId`.
 
     .. attribute:: length
 
-        This is an optional argument which validates that the array reaches at
-        exactly the stated length.
+        This is an optional argument which validates that the array contains
+        the stated number of items.
 
-        .. 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.
+        ``length`` may not be specified along with ``max_length`` or
+        ``min_length``.
 
     .. attribute:: max_length
 

docs/source/ref/models/fields.rst

@@ -11,11 +11,9 @@ Some MongoDB-specific fields are available in ``django_mongodb_backend.fields``.
 .. class:: ArrayField(base_field, max_size=None, 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:`max_size
-    <ArrayField.max_size>` or :attr:`size
-    <ArrayField.size>`. ``ArrayField`` can be nested to store
-    multi-dimensional arrays.
+    pass another field instance as the :attr:`~ArrayField.base_field`. You may
+    also specify a :attr:`~ArrayField.size` or :attr:`~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
@@ -67,16 +65,14 @@ Some MongoDB-specific fields are available in ``django_mongodb_backend.fields``.
         If passed, the array will have a maximum size as specified, validated
         by forms and model validation, but not enforced by the database.
 
+        The ``max_size`` and ``size`` options are mutually exclusive.
+
     .. attribute:: size
 
         This is an optional argument.
 
-        If passed, the array will have size as specified, validated by forms and model validation, but not enforced by the database.
-
-        .. note::
-
-            Defining both ``size`` and ``max_size`` will raise an exception.
-            Use ``size`` for fixed-length arrays and ``max_size`` for variable-length arrays with an upper limit.
+        If passed, the array will have size as specified, validated by forms
+        and model validation, but not enforced by the database.
 
 Querying ``ArrayField``
 ~~~~~~~~~~~~~~~~~~~~~~~

docs/source/releases/5.1.x.rst

@@ -8,9 +8,9 @@ Django MongoDB Backend 5.1.x
 *Unreleased*
 
 - Backward-incompatible: :class:`~django_mongodb_backend.fields.ArrayField`\'s
-  ``size`` argument is renamed to ``max_size``.
-- Added the ``size`` parameter to :class:`~django_mongodb_backend.fields.ArrayField`
-  for enforcing fixed-length arrays.
+  :attr:`~.ArrayField.size` parameter is renamed to
+  :attr:`~.ArrayField.max_size`. The :attr:`~.ArrayField.size` parameter is now
+  used to enforce fixed-length arrays.
 - Added support for :doc:`database caching </topics/cache>`.
 - Fixed ``QuerySet.raw_aggregate()`` field initialization when the document key
   order doesn't match the order of the model's fields.

tests/forms_tests_/test_array.py

@@ -117,44 +117,32 @@ def test_min_length_singular(self):
 
     def test_size_length(self):
         field = SimpleArrayField(forms.CharField(max_length=27), length=4)
-        with self.assertRaises(exceptions.ValidationError) as cm:
+        msg = "List contains 3 items, it should contain 4."
+        with self.assertRaisesMessage(exceptions.ValidationError, msg):
             field.clean(["a", "b", "c"])
-        self.assertEqual(
-            cm.exception.messages[0],
-            "List contains 3 items, it should contain 4.",
-        )
-        with self.assertRaises(exceptions.ValidationError) as cm:
+        msg = "List contains 5 items, it should contain 4."
+        with self.assertRaisesMessage(exceptions.ValidationError, msg):
             field.clean(["a", "b", "c", "d", "e"])
-        self.assertEqual(
-            cm.exception.messages[0],
-            "List contains 5 items, it should contain 4.",
-        )
 
     def test_size_length_singular(self):
         field = SimpleArrayField(forms.CharField(max_length=27), length=4)
-        with self.assertRaises(exceptions.ValidationError) as cm:
+        msg = "List contains 1 item, it should contain 4."
+        with self.assertRaisesMessage(exceptions.ValidationError, msg):
             field.clean(["a"])
-        self.assertEqual(
-            cm.exception.messages[0],
-            "List contains 1 item, it should contain 4.",
-        )
 
     def test_required(self):
         field = SimpleArrayField(forms.CharField(), required=True)
         with self.assertRaises(exceptions.ValidationError) as cm:
             field.clean("")
         self.assertEqual(cm.exception.messages[0], "This field is required.")
 
-    def test_misconfigured(self):
-        msg = (
-            "SimpleArrayField param 'length' cannot be specified with 'max_length' or 'min_length'."
-        )
-        with self.assertRaises(exceptions.ImproperlyConfigured) as cm:
+    def test_length_and_max_min_length(self):
+        msg = "The length and max_length parameters are mutually exclusive."
+        with self.assertRaisesMessage(exceptions.ImproperlyConfigured, msg):
             SimpleArrayField(forms.CharField(), max_length=3, length=2)
-        self.assertEqual(cm.exception.args[0], msg)
-        with self.assertRaises(exceptions.ImproperlyConfigured) as cm:
+        msg = "The length and min_length parameters are mutually exclusive."
+        with self.assertRaisesMessage(exceptions.ImproperlyConfigured, msg):
             SimpleArrayField(forms.CharField(), min_length=3, length=2)
-        self.assertEqual(cm.exception.args[0], msg)
 
     def test_model_field_formfield(self):
         model_field = ArrayField(models.CharField(max_length=27))

tests/model_fields_/test_arrayfield.py

@@ -830,12 +830,9 @@ def test_with_max_size_singular(self):
     def test_with_size(self):
         field = ArrayField(models.IntegerField(), size=3)
         field.clean([1, 2, 3], None)
-        with self.assertRaises(exceptions.ValidationError) as cm:
+        msg = "List contains 4 items, it should contain 3."
+        with self.assertRaisesMessage(exceptions.ValidationError, msg):
             field.clean([1, 2, 3, 4], None)
-        self.assertEqual(
-            cm.exception.messages[0],
-            "List contains 4 items, it should contain 3.",
-        )
 
     def test_with_size_singular(self):
         field = ArrayField(models.IntegerField(), size=2)

tests/validators_/tests.py

@@ -4,22 +4,28 @@
 from django_mongodb_backend.validators import LengthValidator
 
 
-class TestValidators(SimpleTestCase):
-    def test_validators(self):
-        validator = LengthValidator(10)
-        with self.assertRaises(ValidationError) as context_manager:
-            validator([])
-        self.assertEqual(
-            context_manager.exception.messages, ["List contains 0 items, it should contain 10."]
-        )
-        with self.assertRaises(ValidationError) as context_manager:
-            validator([1])
-        self.assertEqual(
-            context_manager.exception.messages, ["List contains 1 item, it should contain 10."]
-        )
-        with self.assertRaises(ValidationError) as context_manager:
-            validator(list(range(11)))
-        self.assertEqual(
-            context_manager.exception.messages, ["List contains 11 items, it should contain 10."]
-        )
-        self.assertEqual(validator(list(range(10))), None)
+class TestLengthValidator(SimpleTestCase):
+    validator = LengthValidator(10)
+
+    def test_empty(self):
+        msg = "List contains 0 items, it should contain 10."
+        with self.assertRaisesMessage(ValidationError, msg):
+            self.validator([])
+
+    def test_singular(self):
+        msg = "List contains 1 item, it should contain 10."
+        with self.assertRaisesMessage(ValidationError, msg):
+            self.validator([1])
+
+    def test_too_short(self):
+        msg = "List contains 9 items, it should contain 10."
+        with self.assertRaisesMessage(ValidationError, msg):
+            self.validator([1, 2, 3, 4, 5, 6, 7, 8, 9])
+
+    def test_too_long(self):
+        msg = "List contains 11 items, it should contain 10."
+        with self.assertRaisesMessage(ValidationError, msg):
+            self.validator(list(range(11)))
+
+    def test_valid(self):
+        self.assertEqual(self.validator(list(range(10))), None)