add ObjectIdField

Co-authored-by: Tim Graham <[email protected]>

Author: WaVEV

.github/workflows/runtests.py

@@ -57,6 +57,7 @@
     "force_insert_update",
     "foreign_object",
     "forms_tests",
+    "forms_tests_",
     "from_db_value",
     "generic_inline_admin",
     "generic_relations",

django_mongodb/fields/__init__.py

@@ -1,8 +1,9 @@
 from .auto import ObjectIdAutoField
 from .duration import register_duration_field
 from .json import register_json_field
+from .objectid import ObjectIdField
 
-__all__ = ["register_fields", "ObjectIdAutoField"]
+__all__ = ["register_fields", "ObjectIdAutoField", "ObjectIdField"]
 
 
 def register_fields():

django_mongodb/fields/auto.py

@@ -2,15 +2,11 @@
 from django.core import exceptions
 from django.db.models.fields import AutoField
 from django.utils.functional import cached_property
-from django.utils.translation import gettext_lazy as _
 
+from .objectid import ObjectIdMixin
 
-class ObjectIdAutoField(AutoField):
-    default_error_messages = {
-        "invalid": _("“%(value)s” value must be an Object Id."),
-    }
-    description = _("Object Id")
 
+class ObjectIdAutoField(ObjectIdMixin, AutoField):
     def __init__(self, *args, **kwargs):
         kwargs["db_column"] = "_id"
         super().__init__(*args, **kwargs)
@@ -42,12 +38,6 @@ def get_prep_value(self, value):
     def get_internal_type(self):
         return "ObjectIdAutoField"
 
-    def db_type(self, connection):
-        return "objectId"
-
-    def rel_db_type(self, connection):
-        return "objectId"
-
     def to_python(self, value):
         if value is None or isinstance(value, int):
             return value

django_mongodb/fields/objectid.py

@@ -0,0 +1,54 @@
+from bson import ObjectId, errors
+from django.core import exceptions
+from django.db.models.fields import Field
+from django.utils.translation import gettext_lazy as _
+
+from django_mongodb import forms
+
+
+class ObjectIdMixin:
+    default_error_messages = {
+        "invalid": _("“%(value)s” is not a valid Object Id."),
+    }
+    description = _("Object Id")
+
+    def db_type(self, connection):
+        return "objectId"
+
+    def rel_db_type(self, connection):
+        return "objectId"
+
+    def get_prep_value(self, value):
+        value = super().get_prep_value(value)
+        return self.to_python(value)
+
+    def to_python(self, value):
+        if value is None:
+            return value
+        try:
+            return ObjectId(value)
+        except (errors.InvalidId, TypeError):
+            raise exceptions.ValidationError(
+                self.error_messages["invalid"],
+                code="invalid",
+                params={"value": value},
+            ) from None
+
+    def formfield(self, **kwargs):
+        return super().formfield(
+            **{
+                "form_class": forms.ObjectIdField,
+                **kwargs,
+            }
+        )
+
+
+class ObjectIdField(ObjectIdMixin, Field):
+    def deconstruct(self):
+        name, path, args, kwargs = super().deconstruct()
+        if path.startswith("django_mongodb.fields.objectid"):
+            path = path.replace("django_mongodb.fields.objectid", "django_mongodb.fields")
+        return name, path, args, kwargs
+
+    def get_internal_type(self):
+        return "ObjectIdField"

django_mongodb/forms/__init__.py

@@ -0,0 +1,3 @@
+from .fields import ObjectIdField
+
+__all__ = ["ObjectIdField"]

django_mongodb/forms/fields.py

@@ -0,0 +1,27 @@
+from bson import ObjectId
+from bson.errors import InvalidId
+from django.core.exceptions import ValidationError
+from django.forms import Field
+from django.utils.translation import gettext_lazy as _
+
+
+class ObjectIdField(Field):
+    default_error_messages = {
+        "invalid": _("Enter a valid Object Id."),
+    }
+
+    def prepare_value(self, value):
+        if isinstance(value, ObjectId):
+            return str(value)
+        return value
+
+    def to_python(self, value):
+        value = super().to_python(value)
+        if value in self.empty_values:
+            return None
+        if not isinstance(value, ObjectId):
+            try:
+                value = ObjectId(value)
+            except InvalidId:
+                raise ValidationError(self.error_messages["invalid"], code="invalid") from None
+        return value

docs/source/fields.rst

@@ -0,0 +1,13 @@
+Model field reference
+=====================
+
+.. module:: django_mongodb.fields
+
+Some MongoDB-specific fields are available in ``django_mongodb.fields``.
+
+``ObjectIdField``
+-----------------
+
+.. class:: ObjectIdField
+
+Stores an :class:`~bson.objectid.ObjectId`.

docs/source/forms.rst

@@ -0,0 +1,13 @@
+Forms API reference
+===================
+
+.. module:: django_mongodb.forms
+
+Some MongoDB-specific fields are available in ``django_mongodb.forms``.
+
+``ObjectIdField``
+-----------------
+
+.. class:: ObjectIdField
+
+Stores an :class:`~bson.objectid.ObjectId`.

docs/source/index.rst

@@ -5,7 +5,9 @@ django-mongodb 5.0.x documentation
    :maxdepth: 1
    :caption: Contents:
 
+   fields
    querysets
+   forms
 
 Indices and tables
 ==================