Refactor objectId fields.

Author: WaVEV

django_mongodb/fields/__init__.py

@@ -1,7 +1,7 @@
 from .auto import ObjectIdAutoField
 from .duration import register_duration_field
 from .json import register_json_field
-from .object_id import ObjectIdField
+from .objectid import ObjectIdField
 
 __all__ = ["register_fields", "ObjectIdAutoField", "ObjectIdField"]
 

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_mixin import ObjectIdMixin
 
-class ObjectIdAutoField(AutoField):
-    default_error_messages = {
-        "invalid": _("“%(value)s” value must be an Object Id."),
-    }
-    description = _("Object Id")
 
+class ObjectIdAutoField(AutoField, ObjectIdMixin):
     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/object_id.py renamed to django_mongodb/fields/objectid.py

@@ -2,24 +2,14 @@
 from bson.errors import InvalidId
 from django.core import exceptions
 from django.db.models.fields import Field
-from django.utils.translation import gettext_lazy as _
 
+from .objectid_mixin import ObjectIdMixin
 
-class ObjectIdField(Field):
-    default_error_messages = {
-        "invalid": _("“%(value)s” value must be an Object Id."),
-    }
-    description = _("ObjectId")
 
+class ObjectIdField(Field, ObjectIdMixin):
     def get_internal_type(self):
         return "ObjectIdField"
 
-    def db_type(self, connection):
-        return "objectId"
-
-    def rel_db_type(self, connection):
-        return "objectId"
-
     def to_python(self, value):
         try:
             return ObjectId(value)
@@ -32,6 +22,6 @@ def to_python(self, value):
 
     def deconstruct(self):
         name, path, args, kwargs = super().deconstruct()
-        if path.startswith("django_mongodb.fields.auto"):
-            path = path.replace("django_mongodb.fields.auto", "django_mongodb.fields")
+        if path.startswith("django_mongodb.fields.objectid"):
+            path = path.replace("django_mongodb.fields.objectid", "django_mongodb.fields")
         return name, path, args, kwargs

django_mongodb/fields/objectid_mixin.py

@@ -0,0 +1,14 @@
+from django.utils.translation import gettext_lazy as _
+
+
+class ObjectIdMixin:
+    default_error_messages = {
+        "invalid": _("“%(value)s” value must be an Object Id."),
+    }
+    description = _("Object Id")
+
+    def db_type(self, connection):
+        return "objectId"
+
+    def rel_db_type(self, connection):
+        return "objectId"