Code review fixes

Author: aclark4life

django_mongodb_backend/fields/encryption.py

@@ -4,18 +4,6 @@
 from django_mongodb_backend.fields.objectid import ObjectIdField
 
 
-class EncryptedArrayField(ArrayField):
-    encrypted = True
-
-
-class EncryptedEmbeddedModelArrayField(EmbeddedModelArrayField):
-    encrypted = True
-
-
-class EncryptedEmbeddedModelField(EmbeddedModelField):
-    encrypted = True
-
-
 class EncryptedFieldMixin:
     encrypted = True
 
@@ -40,6 +28,7 @@ def deconstruct(self):
         return name, path, args, kwargs
 
 
+# Django fields
 class EncryptedBinaryField(EncryptedFieldMixin, models.BinaryField):
     pass
 
@@ -88,10 +77,6 @@ class EncryptedIntegerField(EncryptedFieldMixin, models.IntegerField):
     pass
 
 
-class EncryptedObjectIdField(EncryptedFieldMixin, ObjectIdField):
-    pass
-
-
 class EncryptedPositiveBigIntegerField(EncryptedFieldMixin, models.PositiveBigIntegerField):
     pass
 
@@ -122,3 +107,20 @@ class EncryptedURLField(EncryptedFieldMixin, models.URLField):
 
 class EncryptedUUIDField(EncryptedFieldMixin, models.UUIDField):
     pass
+
+
+# MongoDB fields
+class EncryptedArrayField(EncryptedFieldMixin, ArrayField):
+    pass
+
+
+class EncryptedEmbeddedModelArrayField(EncryptedFieldMixin, EmbeddedModelArrayField):
+    pass
+
+
+class EncryptedEmbeddedModelField(EncryptedFieldMixin, EmbeddedModelField):
+    pass
+
+
+class EncryptedObjectIdField(EncryptedFieldMixin, ObjectIdField):
+    pass

django_mongodb_backend/management/commands/showencryptedfieldsmap.py

@@ -11,8 +11,6 @@ class Command(BaseCommand):
     Shows the mapping of encrypted fields to field attributes, including data
     type, data keys and query types. The output can be used to set
     ``encrypted_fields_map`` in ``AutoEncryptionOpts``.
-
-    Defaults to showing keys from the ``key_vault_namespace`` collection.
     """
 
     def add_arguments(self, parser):

docs/ref/django-admin.rst

@@ -36,21 +36,3 @@ Available commands
     .. code-block:: console
 
         $ python manage.py showencryptedfieldsmap --database encrypted
-
-    The output will look like::
-
-        {
-            "myapp.mymodel": {
-                "encrypted_field_1": {
-                    "bsonType": "string",
-                    "keyId": "UUID('...')",
-                    "queries": ["equality", "range"]
-                },
-                "encrypted_field_2": {
-                    "bsonType": "int",
-                    "keyId": "UUID('...')",
-                    "queries": ["equality"]
-                }
-            },
-            ...
-        }

docs/ref/models/encrypted-fields.rst

@@ -63,13 +63,13 @@ for use with Queryable Encryption.
 +----------------------------------------+------------------------------------------------------+
 | Encrypted Field                        | MongoDB Field                                        |
 +----------------------------------------+------------------------------------------------------+
-| ``EncryptedArrayField``                | :ref:`arrayfield`                                    |
+| ``EncryptedArrayField``                | :class:`~.fields.ArrayField`                         |
 +----------------------------------------+------------------------------------------------------+
-| ``EncryptedEmbeddedModelArrayField``   | :ref:`embeddedmodelarrayfield`                       |
+| ``EncryptedEmbeddedModelArrayField``   | :class:`~.fields.EmbeddedModelArrayField`            |
 +----------------------------------------+------------------------------------------------------+
-| ``EncryptedEmbeddedModelField``        | :ref:`embeddedmodelfield`                            |
+| ``EncryptedEmbeddedModelField``        | :class:`~.fields.EmbeddedModelField`                 |
 +----------------------------------------+------------------------------------------------------+
-| ``EncryptedObjectIdField``             | :ref:`objectidfield`                                 |
+| ``EncryptedObjectIdField``             | :class:`~.fields.ObjectIdField`                      |
 +----------------------------------------+------------------------------------------------------+
 
 The following fields are supported by Django MongoDB Backend but not by

docs/ref/models/fields.rst

@@ -46,8 +46,6 @@ MongoDB-specific model fields
 
 Some MongoDB-specific fields are available in ``django_mongodb_backend.fields``.
 
-.. _arrayfield:
-
 ``ArrayField``
 --------------
 
@@ -262,8 +260,6 @@ transform do not change. For example:
 
 These indexes use 0-based indexing.
 
-.. _embeddedmodelfield:
-
 ``EmbeddedModelField``
 ----------------------
 
@@ -314,8 +310,6 @@ These indexes use 0-based indexing.
     created these models and then added an indexed field to ``Address``,
     the index created in the nested ``Book`` embed is not created.
 
-.. _embeddedmodelarrayfield:
-
 ``EmbeddedModelArrayField``
 ---------------------------
 
@@ -352,8 +346,6 @@ These indexes use 0-based indexing.
     This field is typically the default primary key field for all models stored
     in MongoDB. See :ref:`specifying the-default-pk-field`.
 
-.. _objectidfield:
-
 ``ObjectIdField``
 -----------------
 

docs/ref/settings.rst

@@ -12,8 +12,6 @@ Key Management Service (KMS) credentials for Queryable Encryption.
 
 .. setting:: DATABASE-KMS-CREDENTIALS
 
-.. _database-kms-credentials:
-
 ``KMS_CREDENTIALS``
 -------------------
 

tests/encryption_/models.py

@@ -74,8 +74,8 @@ class Movie(EncryptedTestModel):
     title = models.CharField(max_length=200)
     plot = models.TextField(blank=True)
     runtime = models.IntegerField(default=0)
-    released = models.DateTimeField("release date", null=True, blank=True)
-    cast = EncryptedEmbeddedModelArrayField(Actor, null=True, blank=True)
+    released = models.DateTimeField("release date")
+    cast = EncryptedEmbeddedModelArrayField(Actor)
 
     def __str__(self):
         return self.title

tests/encryption_/test_fields.py

@@ -70,6 +70,7 @@ def setUp(self):
         self.movie = Movie.objects.create(
             title="Sample Movie",
             cast=[self.actor1, self.actor2],
+            released=datetime.date(2024, 6, 1),
         )
 
     def test_array(self):