add extra_forms arg

Author: timgraham

django_mongodb_backend/fields/embedded_model_array.py

@@ -16,11 +16,7 @@ def deconstruct(self):
         name, path, args, kwargs = super().deconstruct()
         if path == "django_mongodb_backend.fields.embedded_model_array.EmbeddedModelArrayField":
             path = "django_mongodb_backend.fields.EmbeddedModelArrayField"
-        kwargs.update(
-            {
-                "embedded_model": self.embedded_model,
-            }
-        )
+        kwargs["embedded_model"] = self.embedded_model
         del kwargs["base_field"]
         return name, path, args, kwargs
 

django_mongodb_backend/forms/fields/embedded_model_array.py

@@ -14,18 +14,18 @@ def models_to_dicts(models):
 
 
 class EmbeddedModelArrayField(forms.Field):
-    def __init__(self, model, prefix, max_num=None, *args, **kwargs):
+    def __init__(self, model, prefix, max_num=None, extra_forms=3, **kwargs):
         self.model = model
         self.prefix = prefix
         self.formset = formset_factory(
             form=modelform_factory(model, fields="__all__"),
             can_delete=True,
             max_num=max_num,
-            extra=3,
+            extra=extra_forms,
             validate_max=True,
         )
         kwargs["widget"] = EmbeddedModelArrayWidget()
-        super().__init__(*args, **kwargs)
+        super().__init__(**kwargs)
 
     def clean(self, value):
         if not value:

docs/source/ref/forms.rst

@@ -26,7 +26,7 @@ Some MongoDB-specific fields are available in ``django_mongodb_backend.forms``.
 ``EmbeddedModelArrayField``
 ---------------------------
 
-.. class:: EmbeddedModelArrayField(model, prefix, max_num=None, **kwargs)
+.. class:: EmbeddedModelArrayField(model, prefix, max_num=None, extra_forms=3, **kwargs)
 
     .. versionadded:: 5.2.0b1
 
@@ -48,6 +48,11 @@ Some MongoDB-specific fields are available in ``django_mongodb_backend.forms``.
         This is an optional argument which validates that the array does not
         exceed the stated length.
 
+    .. attribute:: extra_forms
+
+        This argument specifies the number of blank forms that will be
+        rendered by the formset.
+
 ``ObjectIdField``
 -----------------
 

docs/source/ref/models/fields.rst

@@ -275,7 +275,8 @@ See :doc:`/topics/embedded-models` for more details and examples.
 
     .. versionadded:: 5.2.0b1
 
-    Stores a list of models of type ``embedded_model``.
+    Similar to :class:`EmbeddedModelField`, but stores a list of models of type
+    ``embedded_model`` rather than a single instance.
 
     .. attribute:: embedded_model
 
@@ -289,6 +290,11 @@ See :doc:`/topics/embedded-models` for more details and examples.
         If passed, the array will have a maximum size as specified, validated
         by forms and model validation, but not enforced by the database.
 
+.. admonition:: Migrations support is limited
+
+    As described above for :class:`EmbeddedModelField`,
+    :djadmin:`makemigrations` does not yet detect changes to embedded models.
+
 ``ObjectIdAutoField``
 ---------------------
 

docs/source/releases/5.2.x.rst

@@ -7,6 +7,12 @@ Django MongoDB Backend 5.2.x
 
 *Unreleased*
 
+New features
+------------
+
+- Added :class:`~.fields.EmbeddedModelArrayField` for storing data as an array
+  of model instances.
+
 Bug fixes
 ---------
 

tests/model_forms_/test_embedded_model_array.py

@@ -1,5 +1,7 @@
 from django.test import TestCase
 
+from django_mongodb_backend.forms import EmbeddedModelArrayField
+
 from .forms import MovieForm
 from .models import Movie, Review
 
@@ -409,3 +411,65 @@ def test_rendering_initial(self):
                 id="id_reviews-MIN_NUM_FORMS"><input type="hidden"
                 name="reviews-MAX_NUM_FORMS" value="1000" id="id_reviews-MAX_NUM_FORMS">""",
         )
+
+    def test_extra_forms(self):
+        """The extra_forms argument specifies the number of extra forms."""
+
+        class ExtraMovieForm(MovieForm):
+            reviews = EmbeddedModelArrayField(Review, prefix="reviews", extra_forms=2)
+
+        form = ExtraMovieForm()
+        self.assertHTMLEqual(
+            str(form.fields["reviews"].get_bound_field(form, "reviews")),
+            """
+            <table>
+            <tbody>
+              <tr>
+                <th><label for="id_reviews-0-title">Title:</label></th>
+                <td>
+                  <input type="text" name="reviews-0-title" maxlength="255"
+                    id="id_reviews-0-title">
+                </td>
+              </tr>
+              <tr>
+                <th><label for="id_reviews-0-rating">Rating:</label></th>
+                <td>
+                  <input type="number" name="reviews-0-rating" id="id_reviews-0-rating">
+                </td>
+              </tr>
+              <tr>
+                <th><label for="id_reviews-0-DELETE">Delete:</label></th>
+                <td>
+                  <input type="checkbox" name="reviews-0-DELETE" id="id_reviews-0-DELETE">
+                </td>
+              </tr>
+            </tbody>
+            <tbody>
+              <tr>
+                <th><label for="id_reviews-1-title">Title:</label></th>
+                <td>
+                  <input type="text" name="reviews-1-title" maxlength="255" id="id_reviews-1-title">
+                </td>
+              </tr>
+              <tr>
+                <th><label for="id_reviews-1-rating">Rating:</label></th>
+                <td>
+                  <input type="number" name="reviews-1-rating" id="id_reviews-1-rating">
+                </td>
+              </tr>
+              <tr>
+                <th><label for="id_reviews-1-DELETE">Delete:</label></th>
+                <td>
+                  <input type="checkbox" name="reviews-1-DELETE" id="id_reviews-1-DELETE">
+                </td>
+              </tr>
+            </tbody>
+            </table>
+            <input type="hidden" name="reviews-TOTAL_FORMS" value="2"
+                id="id_reviews-TOTAL_FORMS"><input type="hidden"
+                name="reviews-INITIAL_FORMS" value="0"
+                id="id_reviews-INITIAL_FORMS">
+            <input type="hidden" name="reviews-MIN_NUM_FORMS" value="0"
+                id="id_reviews-MIN_NUM_FORMS"><input type="hidden"
+                name="reviews-MAX_NUM_FORMS" value="1000" id="id_reviews-MAX_NUM_FORMS">""",
+        )