cosmetic edits and alphabetization

Author: timgraham

django_mongodb/features.py

@@ -41,7 +41,8 @@ class DatabaseFeatures(BaseDatabaseFeatures):
         # tuple index out of range in process_rhs()
         "lookup.tests.LookupTests.test_exact_sliced_queryset_limit_one",
         "lookup.tests.LookupTests.test_exact_sliced_queryset_limit_one_offset",
-        # Regex lookup doesn't work on json fields.
+        # Regex lookup doesn't work on JSONField:
+        # Unsupported conversion from array to string in $convert
         "model_fields.test_jsonfield.TestQuerying.test_icontains",
         # MongoDB gives the wrong result of log(number, base) when base is a
         # fractional Decimal: https://jira.mongodb.org/browse/SERVER-91223
@@ -58,7 +59,8 @@ class DatabaseFeatures(BaseDatabaseFeatures):
         "model_fields.test_jsonfield.TestQuerying.test_usage_in_subquery",
         # Length of null considered zero rather than null.
         "db_functions.text.test_length.LengthTests.test_basic",
-        # Django-mongo does not differentiate well between joins and key transforms.
+        # Key transforms are incorrectly treated as joins:
+        # Ordering can't span tables on MongoDB (value_custom__a).
         "model_fields.test_jsonfield.TestQuerying.test_order_grouping_custom_decoder",
         "model_fields.test_jsonfield.TestQuerying.test_ordering_by_transform",
         "model_fields.test_jsonfield.TestQuerying.test_ordering_grouping_by_key_transform",
@@ -334,8 +336,8 @@ def django_test_expected_failures(self):
             "lookup.tests.LookupTests.test_lookup_collision",
             "lookup.tests.LookupTests.test_lookup_rhs",
             "lookup.tests.LookupTests.test_isnull_non_boolean_value",
-            "model_fields.test_manytomanyfield.ManyToManyFieldDBTests.test_value_from_object_instance_with_pk",
             "model_fields.test_jsonfield.TestQuerying.test_join_key_transform_annotation_expression",
+            "model_fields.test_manytomanyfield.ManyToManyFieldDBTests.test_value_from_object_instance_with_pk",
             "model_fields.test_uuid.TestAsPrimaryKey.test_two_level_foreign_keys",
             "timezones.tests.LegacyDatabaseTests.test_query_annotation",
             "timezones.tests.NewDatabaseTests.test_query_annotation",
@@ -354,16 +356,16 @@ def django_test_expected_failures(self):
         },
         "Test executes raw SQL.": {
             "annotations.tests.NonAggregateAnnotationTestCase.test_raw_sql_with_inherited_field",
+            "model_fields.test_jsonfield.TestQuerying.test_key_sql_injection_escape",
+            "model_fields.test_jsonfield.TestQuerying.test_key_transform_raw_expression",
+            "model_fields.test_jsonfield.TestQuerying.test_nested_key_transform_raw_expression",
             "timezones.tests.LegacyDatabaseTests.test_cursor_execute_accepts_naive_datetime",
             "timezones.tests.LegacyDatabaseTests.test_cursor_execute_returns_naive_datetime",
             "timezones.tests.LegacyDatabaseTests.test_raw_sql",
             "timezones.tests.NewDatabaseTests.test_cursor_execute_accepts_naive_datetime",
             "timezones.tests.NewDatabaseTests.test_cursor_execute_returns_naive_datetime",
             "timezones.tests.NewDatabaseTests.test_cursor_explicit_time_zone",
             "timezones.tests.NewDatabaseTests.test_raw_sql",
-            "model_fields.test_jsonfield.TestQuerying.test_key_transform_raw_expression",
-            "model_fields.test_jsonfield.TestQuerying.test_key_sql_injection_escape",
-            "model_fields.test_jsonfield.TestQuerying.test_nested_key_transform_raw_expression",
         },
         "Bilateral transform not implemented.": {
             "db_functions.tests.FunctionTests.test_func_transform_bilateral",
@@ -415,7 +417,7 @@ def django_test_expected_failures(self):
             "db_functions.comparison.test_cast.CastTests.test_cast_from_python_to_datetime",
             "db_functions.comparison.test_cast.CastTests.test_cast_to_duration",
         },
-        "Mongodb's Null behaviour is different from sql's": {
+        "MongoDB's null behavior is different from SQL's.": {
             "model_fields.test_jsonfield.TestQuerying.test_expression_wrapper_key_transform",
             "model_fields.test_jsonfield.TestSaveLoad.test_json_null_different_from_sql_null",
             "model_fields.test_jsonfield.TestQuerying.test_lookup_exclude",

django_mongodb/fields/__init__.py

@@ -1,9 +1,8 @@
 from .auto import MongoAutoField
 from .json import register_json_field
 
+__all__ = ["register_fields", "MongoAutoField"]
+
 
 def register_fields():
     register_json_field()
-
-
-__all__ = ["MongoAutoField", "register_fields"]

django_mongodb/fields/json.py

@@ -13,8 +13,8 @@
     KeyTransformNumericLookupMixin,
 )
 
-from django_mongodb.lookups import builtin_lookup
-from django_mongodb.query_utils import process_lhs, process_rhs
+from ..lookups import builtin_lookup
+from ..query_utils import process_lhs, process_rhs
 
 
 def contained_by(self, compiler, connection):  # noqa: ARG001
@@ -50,11 +50,8 @@ def has_key_lookup(self, compiler, connection):
 _process_rhs = JSONExact.process_rhs
 
 
-def json_process_rhs(self, compiler, connection):
-    """
-    Django does some transformation over the parameters if it is null.
-    to avoid ambiguity, we keep using the parent process_rhs.
-    """
+def json_exact_process_rhs(self, compiler, connection):
+    """Skip JSONExact.process_rhs()'s conversion of None to "null"."""
     return (
         super(JSONExact, self).process_rhs(compiler, connection)
         if connection.vendor == "mongodb"
@@ -100,22 +97,19 @@ def key_transform_in(self, compiler, connection):
     return {"$and": [expr, type_in]}
 
 
-def _key_transform_root(self, compiler, connection):
-    previous = self.lhs
-    while isinstance(previous, KeyTransform):
-        previous = previous.lhs
-    return previous.as_mql(compiler, connection)
-
-
-def key_transform_isnull(self, compiler, connection):
+def key_transform_is_null(self, compiler, connection):
     """
     The KeyTransformIsNull lookup borrows the logic from HasKey for isnull=False.
-    If isnull=True, the query should only match objects that do not have the key.
-    # https://code.djangoproject.com/ticket/32252
+    If isnull=True, the query should only match objects that don't have the key.
+    https://code.djangoproject.com/ticket/32252
     """
     lhs_mql = process_lhs(self, compiler, connection)
     rhs_mql = process_rhs(self, compiler, connection)
-    root_column = _key_transform_root(self, compiler, connection)
+    # Get the root column.
+    previous = self.lhs
+    while isinstance(previous, KeyTransform):
+        previous = previous.lhs
+    root_column = previous.as_mql(compiler, connection)
     type_in = _expr_type_in(lhs_mql, ["missing"])
     result = {"$or": [type_in, {"$eq": [root_column, None]}]}
     if not rhs_mql:
@@ -137,8 +131,8 @@ def register_json_field():
     HasKey.mongo_operator = None
     HasKeyLookup.as_mql = has_key_lookup
     HasKeys.mongo_operator = "$and"
-    JSONExact.process_rhs = json_process_rhs
+    JSONExact.process_rhs = json_exact_process_rhs
     KeyTransform.as_mql = key_transform
     KeyTransformIn.as_mql = key_transform_in
-    KeyTransformIsNull.as_mql = key_transform_isnull
+    KeyTransformIsNull.as_mql = key_transform_is_null
     KeyTransformNumericLookupMixin.as_mql = key_transform_numeric_lookup_mixin

django_mongodb/functions.py

@@ -62,13 +62,11 @@ def cast(self, compiler, connection):
     lhs_mql = process_lhs(self, compiler, connection)[0]
     if max_length := self.output_field.max_length:
         lhs_mql = {"$substrCP": [lhs_mql, 0, max_length]}
-
-    # In case of "object", we skip the conversion as it doesn't need to be transformed
-    # for interpretation by JSONField. JSONField can handle various types,
-    # including int, object, or array.
+    # Skip the conversion for "object" as it doesn't need to be transformed for
+    # interpretation by JSONField, which can handle types including int,
+    # object, or array.
     if output_type != "object":
         lhs_mql = {"$convert": {"input": lhs_mql, "to": output_type}}
-
     if decimal_places := getattr(self.output_field, "decimal_places", None):
         lhs_mql = {"$trunc": [lhs_mql, decimal_places]}
     return lhs_mql

django_mongodb/lookups.py

@@ -17,6 +17,22 @@ def builtin_lookup(self, compiler, connection):
     return connection.mongo_operators[self.lookup_name](lhs_mql, value)
 
 
+_field_resolve_expression_parameter = FieldGetDbPrepValueIterableMixin.resolve_expression_parameter
+
+
+def field_resolve_expression_parameter(self, compiler, connection, sql, param):
+    """For MongoDB, this method must call as_mql() instead of as_sql()."""
+    sql, sql_params = _field_resolve_expression_parameter(self, compiler, connection, sql, param)
+    if connection.vendor == "mongodb":
+        params = [param]
+        if hasattr(param, "resolve_expression"):
+            param = param.resolve_expression(compiler.query)
+        if hasattr(param, "as_mql"):
+            params = [param.as_mql(compiler, connection)]
+        return sql, params
+    return sql, sql_params
+
+
 def in_(self, compiler, connection):
     if isinstance(self.lhs, MultiColSource):
         raise NotImplementedError("MultiColSource is not supported.")
@@ -52,24 +68,11 @@ def uuid_text_mixin(self, compiler, connection):  # noqa: ARG001
     raise NotSupportedError("Pattern lookups on UUIDField are not supported.")
 
 
-_resolve_expression_parameter = FieldGetDbPrepValueIterableMixin.resolve_expression_parameter
-
-
-def resolve_expression_parameter(self, compiler, connection, sql, param):
-    sql, sql_params = _resolve_expression_parameter(self, compiler, connection, sql, param)
-    if connection.vendor == "mongodb":
-        params = [param]
-        if hasattr(param, "resolve_expression"):
-            param = param.resolve_expression(compiler.query)
-        if hasattr(param, "as_mql"):
-            params = [param.as_mql(compiler, connection)]
-        return sql, params
-    return sql, sql_params
-
-
 def register_lookups():
     BuiltinLookup.as_mql = builtin_lookup
-    FieldGetDbPrepValueIterableMixin.resolve_expression_parameter = resolve_expression_parameter
+    FieldGetDbPrepValueIterableMixin.resolve_expression_parameter = (
+        field_resolve_expression_parameter
+    )
     In.as_mql = RelatedIn.as_mql = in_
     IsNull.as_mql = is_null
     PatternLookup.prep_lookup_value_mongo = pattern_lookup_prep_lookup_value