INTPYTHON-599 Make a field's custom lookups available in embedded model queries

Author: timgraham

django_mongodb_backend/fields/embedded_model.py

@@ -155,6 +155,9 @@ def __init__(self, key_name, ref_field, *args, **kwargs):
         self.key_name = str(key_name)
         self.ref_field = ref_field
 
+    def get_lookup(self, name):
+        return self.ref_field.get_lookup(name)
+
     def get_transform(self, name):
         """
         Validate that `name` is either a field of an embedded model or a
@@ -204,6 +207,10 @@ def as_mql(self, compiler, connection):
             result = build_json_mql_path(result, json_key_transforms)
         return result
 
+    @property
+    def output_field(self):
+        return self.ref_field
+
 
 class KeyTransformFactory:
     def __init__(self, key_name, ref_field):

docs/source/releases/5.1.x.rst

@@ -2,6 +2,14 @@
 Django MongoDB Backend 5.1.x
 ============================
 
+5.1.0 beta 3
+============
+
+*Unreleased*
+
+- Added support for a field's custom lookups in ``EmbeddedModelField``, e.g.
+  ``ArrayField``’s ``contains``, ``contained__by``, etc.
+
 .. _django-mongodb-backend-5.1.0-beta-2:
 
 5.1.0 beta 2

docs/source/releases/5.2.x.rst

@@ -12,3 +12,8 @@ Initial release from the state of :ref:`django-mongodb-backend 5.1.0 beta 2
 
 Regarding new features in Django 5.2,
 :class:`~django.db.models.CompositePrimaryKey` isn't supported.
+
+Bug fixes:
+
+- Added support for a field's custom lookups in ``EmbeddedModelField``, e.g.
+  ``ArrayField``’s ``contains``, ``contained__by``, etc.

tests/model_fields_/models.py

@@ -110,12 +110,14 @@ class Address(EmbeddedModel):
     city = models.CharField(max_length=20)
     state = models.CharField(max_length=2)
     zip_code = models.IntegerField(db_index=True)
+    tags = ArrayField(models.CharField(max_length=100), null=True, blank=True)
 
 
 class Author(EmbeddedModel):
     name = models.CharField(max_length=10)
     age = models.IntegerField()
     address = EmbeddedModelField(Address)
+    skills = ArrayField(models.CharField(max_length=100), null=True, blank=True)
 
 
 class Book(models.Model):

tests/model_fields_/test_embedded_model.py

@@ -186,6 +186,49 @@ def test_nested(self):
         self.assertCountEqual(Book.objects.filter(author__address__city="NYC"), [obj])
 
 
+class ArrayFieldTests(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.book = Book.objects.create(
+            author=Author(
+                name="Shakespeare",
+                age=55,
+                skills=["writing", "editing"],
+                address=Address(city="NYC", state="NY", tags=["home", "shipping"]),
+            ),
+        )
+
+    def test_contains(self):
+        self.assertCountEqual(Book.objects.filter(author__skills__contains=["nonexistent"]), [])
+        self.assertCountEqual(
+            Book.objects.filter(author__skills__contains=["writing"]), [self.book]
+        )
+        # Nested
+        self.assertCountEqual(
+            Book.objects.filter(author__address__tags__contains=["nonexistent"]), []
+        )
+        self.assertCountEqual(
+            Book.objects.filter(author__address__tags__contains=["home"]), [self.book]
+        )
+
+    def test_contained_by(self):
+        self.assertCountEqual(
+            Book.objects.filter(author__skills__contained_by=["writing", "publishing"]), []
+        )
+        self.assertCountEqual(
+            Book.objects.filter(author__skills__contained_by=["writing", "editing", "publishing"]),
+            [self.book],
+        )
+        # Nested
+        self.assertCountEqual(
+            Book.objects.filter(author__address__tags__contained_by=["home", "work"]), []
+        )
+        self.assertCountEqual(
+            Book.objects.filter(author__address__tags__contained_by=["home", "work", "shipping"]),
+            [self.book],
+        )
+
+
 class InvalidLookupTests(SimpleTestCase):
     def test_invalid_field(self):
         msg = "Author has no field named 'first_name'"