Check similiarities function in __init__

Author: WaVEV

django_mongodb_backend/indexes.py

@@ -168,22 +168,15 @@ class VectorSearchIndex(SearchIndex):
     def __init__(self, *expressions, similarities="cosine", **kwargs):
         super().__init__(*expressions, **kwargs)
         self.similarities = similarities
+        for func in similarities if isinstance(similarities, list) else (similarities,):
+            if func not in self.ALLOWED_SIMILARITY_FUNCTIONS:
+                raise ValueError(
+                    f"{func} isn't a valid similarity function, options "
+                    f"are {', '.join(sorted(self.ALLOWED_SIMILARITY_FUNCTIONS))}"
+                )
 
     def check(self, model, connection):
         errors = super().check(model, connection)
-        similarities = (
-            self.similarities if isinstance(self.similarities, list) else [self.similarities]
-        )
-        for func in similarities:
-            if func not in self.ALLOWED_SIMILARITY_FUNCTIONS:
-                errors.append(
-                    Error(
-                        f"{func} isn't a valid similarity function, options "
-                        f"are {', '.join(sorted(self.ALLOWED_SIMILARITY_FUNCTIONS))}",
-                        obj=self,
-                        id=f"{self._error_id_prefix}.E004",
-                    )
-                )
         viewed = set()
         expected_similarities = 0
         for field_name, _ in self.fields_orders:
@@ -195,7 +188,7 @@ def check(self, model, connection):
                         obj=self,
                         hint="If you need different configurations for the same field, "
                         "create separate indexes.",
-                        id=f"{self._error_id_prefix}.E005",
+                        id=f"{self._error_id_prefix}.E004",
                     )
                 )
                 continue

tests/indexes_/test_atlas_indexes.py

@@ -104,6 +104,14 @@ class VectorSearchIndexTests(TestMixin, TestCase):
     using Django's schema editor.
     """
 
+    def test_invalid_similarity_function(self):
+        msg = (
+            "sum isn't a valid similarity function, options "
+            f"are {', '.join(sorted(VectorSearchIndex.ALLOWED_SIMILARITY_FUNCTIONS))}"
+        )
+        with self.assertRaisesMessage(ValueError, msg):
+            VectorSearchIndex(fields=["vector_data"], similarities="sum")
+
     @skipUnlessDBFeature("supports_atlas_search")
     def test_deconstruct_default_similarity(self):
         index = VectorSearchIndex(

tests/indexes_/test_checks.py

@@ -131,61 +131,6 @@ class Meta:
             ],
         )
 
-    def test_invalid_similarity_function(self):
-        class Article(models.Model):
-            vector_data = ArrayField(models.DecimalField(), size=10)
-
-            class Meta:
-                indexes = [
-                    VectorSearchIndex(fields=["vector_data"], similarities="sum"),
-                ]
-
-        errors = checks.run_checks(app_configs=self.apps.get_app_configs(), databases={"default"})
-        self.assertEqual(
-            errors,
-            [
-                checks.Error(
-                    "sum isn't a valid similarity function, "
-                    "options are cosine, dotProduct, euclidean",
-                    id="django_mongodb_backend.indexes.VectorSearchIndex.E004",
-                    obj=Article._meta.indexes[0],
-                )
-            ],
-        )
-
-    def test_invalid_similarities_function(self):
-        class Article(models.Model):
-            vector1 = ArrayField(models.DecimalField(), size=10)
-            vector2 = ArrayField(models.DecimalField(), size=10)
-            vector3 = ArrayField(models.DecimalField(), size=10)
-
-            class Meta:
-                indexes = [
-                    VectorSearchIndex(
-                        fields=["vector1", "vector2", "vector3"],
-                        similarities=["sum", "dotProduct", "tangh"],
-                    ),
-                ]
-
-        errors = checks.run_checks(app_configs=self.apps.get_app_configs(), databases={"default"})
-        self.assertEqual(
-            errors,
-            [
-                checks.Error(
-                    "sum isn't a valid similarity function, "
-                    "options are cosine, dotProduct, euclidean",
-                    id="django_mongodb_backend.indexes.VectorSearchIndex.E004",
-                    obj=Article._meta.indexes[0],
-                ),
-                checks.Error(
-                    "tangh isn't a valid similarity function, "
-                    "options are cosine, dotProduct, euclidean",
-                    id="django_mongodb_backend.indexes.VectorSearchIndex.E004",
-                    obj=Article._meta.indexes[0],
-                ),
-            ],
-        )
-
     def test_define_field_twice(self):
         class Article(models.Model):
             vector_data = ArrayField(models.DecimalField(), size=10)
@@ -205,7 +150,7 @@ class Meta:
                 checks.Error(
                     "Field 'vector_data' is defined more than once. Vector and filter "
                     "fields must use distinct field names.",
-                    id="django_mongodb_backend.indexes.VectorSearchIndex.E005",
+                    id="django_mongodb_backend.indexes.VectorSearchIndex.E004",
                     hint="If you need different configurations for the same field,"
                     " create separate indexes.",
                     obj=Article._meta.indexes[0],
@@ -233,7 +178,7 @@ class Meta:
                     "An Atlas vector search index requires the same number of similarities "
                     "and vector fields, but 1 similarity function were expected and 2 "
                     "were provided.",
-                    id="django_mongodb_backend.indexes.VectorSearchIndex.E006",
+                    id="django_mongodb_backend.indexes.VectorSearchIndex.E005",
                     obj=Article._meta.indexes[0],
                 ),
             ],
@@ -260,7 +205,7 @@ class Meta:
                     "An Atlas vector search index requires the same number of similarities "
                     "and vector fields, but 2 similarities functions were expected and 1 "
                     "was provided.",
-                    id="django_mongodb_backend.indexes.VectorSearchIndex.E006",
+                    id="django_mongodb_backend.indexes.VectorSearchIndex.E005",
                     obj=Article._meta.indexes[0],
                 ),
             ],