Fixed null values for Django - fixes pgvector#35

ankane · ankane · commit 5e34237cff65 · 2023-09-24T20:48:27.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.2.3 (unreleased)
+
+- Fixed null values for Django
+
 ## 0.2.2 (2023-09-08)
 
 - Added support for Peewee
diff --git a/pgvector/django/__init__.py b/pgvector/django/__init__.py
@@ -16,6 +16,7 @@ def __init__(self):
 # https://docs.djangoproject.com/en/4.2/howto/custom-model-fields/
 class VectorField(Field):
     description = 'Vector'
+    empty_strings_allowed = False
 
     def __init__(self, *args, dimensions=None, **kwargs):
         self.dimensions = dimensions
@@ -47,10 +48,14 @@ def value_to_string(self, obj):
         return self.get_prep_value(self.value_from_object(obj))
 
     def validate(self, value, model_instance):
-        super().validate(value.tolist(), model_instance)
+        if isinstance(value, np.ndarray):
+            value = value.tolist()
+        super().validate(value, model_instance)
 
     def run_validators(self, value):
-        super().run_validators(value.tolist())
+        if isinstance(value, np.ndarray):
+            value = value.tolist()
+        super().run_validators(value)
 
     def formfield(self, **kwargs):
         return super().formfield(form_class=VectorFormField, **kwargs)
diff --git a/tests/test_django.py b/tests/test_django.py
@@ -56,7 +56,7 @@ class Migration(migrations.Migration):
             name='Item',
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('embedding', pgvector.django.VectorField(dimensions=3)),
+                ('embedding', pgvector.django.VectorField(dimensions=3, null=True)),
             ],
         ),
         migrations.AddIndex(
@@ -185,3 +185,7 @@ def test_clean(self):
 
     def test_get_or_create(self):
         Item.objects.get_or_create(embedding=[1, 2, 3])
+
+    def test_missing(self):
+        Item().save()
+        assert Item.objects.first().embedding is None
