INTPYTHON-795 Update to Django 6.0

timgraham · timgraham · commit 9c186c30ef4a · 2025-12-11T15:01:20.000-05:00
- Adapt aggregation for AggregateFilter django/django@4b977a5 - Mark StringAgg as not supported - Fix JONField negative indexing
diff --git a/.evergreen/run-tests.sh b/.evergreen/run-tests.sh
@@ -3,13 +3,13 @@
 set -eux
 
 # Install django-mongodb-backend
-/opt/python/3.10/bin/python3 -m venv venv
+/opt/python/3.12/bin/python3 -m venv venv
 . venv/bin/activate
 python -m pip install -U pip
 pip install -e .
 
 # Install django and test dependencies
-git clone --branch mongodb-5.2.x https://github.com/mongodb-forks/django django_repo
+git clone --branch mongodb-6.0.x https://github.com/mongodb-forks/django django_repo
 pushd django_repo/tests/
 pip install -e ..
 pip install -r requirements/py3.txt
diff --git a/.github/workflows/linters.yml b/.github/workflows/linters.yml
@@ -17,7 +17,7 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-python@v6
         with:
-          python-version: '3.10'
+          python-version: '3.12'
           cache: 'pip'
           cache-dependency-path: 'pyproject.toml'
       - name: Install Python dependencies
@@ -39,7 +39,7 @@ jobs:
         with:
           cache: 'pip'
           cache-dependency-path: 'pyproject.toml'
-          python-version: '3.10'
+          python-version: '3.12'
       - name: Install dependencies
         run: |
           pip install -U pip
diff --git a/.github/workflows/test-python-atlas.yml b/.github/workflows/test-python-atlas.yml
@@ -33,7 +33,7 @@ jobs:
         uses: actions/checkout@v6
         with:
           repository: 'mongodb-forks/django'
-          ref: 'mongodb-5.2.x'
+          ref: 'mongodb-6.0.x'
           path: 'django_repo'
           persist-credentials: false
       - name: Install system packages for Django's Python test dependencies
diff --git a/.github/workflows/test-python-geo.yml b/.github/workflows/test-python-geo.yml
@@ -34,7 +34,7 @@ jobs:
         uses: actions/checkout@v6
         with:
           repository: 'mongodb-forks/django'
-          ref: 'mongodb-5.2.x'
+          ref: 'mongodb-6.0.x'
           path: 'django_repo'
           persist-credentials: false
       - name: Install system packages for Django's Python test dependencies
diff --git a/.github/workflows/test-python.yml b/.github/workflows/test-python.yml
@@ -33,7 +33,7 @@ jobs:
         uses: actions/checkout@v6
         with:
           repository: 'mongodb-forks/django'
-          ref: 'mongodb-5.2.x'
+          ref: 'mongodb-6.0.x'
           path: 'django_repo'
           persist-credentials: false
       - name: Install system packages for Django's Python test dependencies
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -21,6 +21,6 @@ python:
           - docs
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
+    python: "3.12"
diff --git a/README.md b/README.md
@@ -17,21 +17,21 @@ https://django-mongodb-backend.readthedocs.io/en/latest/.
 ### Install
 
 Use the version of `django-mongodb-backend` that corresponds to your version of
-Django. For example, to get the latest compatible release for Django 5.2.x:
+Django. For example, to get the latest compatible release for Django 6.0.x:
 
 ```bash
-pip install django-mongodb-backend==5.2.*
+pip install django-mongodb-backend==6.0.*
 ```
 
 ### Create a project
 
 From your shell, run the following command to create a new Django project
 called `example` using our project template. Make sure the end of the template
-URL corresponds to your version of Django (e.g. `5.2.x.zip` for any Django
-5.2.x version).
+URL corresponds to your version of Django (e.g. `6.0.x.zip` for any Django
+6.0.x version).
 
 ```bash
-django-admin startproject example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.2.x.zip
+django-admin startproject example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/6.0.x.zip
 ```
 
 You can check what version of Django you're using with:
diff --git a/django_mongodb_backend/__init__.py b/django_mongodb_backend/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "5.2.4.dev0"
+__version__ = "6.0.0.dev0"
 
 # Check Django compatibility before other imports which may fail if the
 # wrong version of Django is installed.
diff --git a/django_mongodb_backend/aggregates.py b/django_mongodb_backend/aggregates.py
@@ -1,4 +1,11 @@
-from django.db.models.aggregates import Aggregate, Count, StdDev, Variance
+from django.db import NotSupportedError
+from django.db.models.aggregates import (
+    Aggregate,
+    Count,
+    StdDev,
+    StringAgg,
+    Variance,
+)
 from django.db.models.expressions import Case, Value, When
 from django.db.models.lookups import IsNull
 from django.db.models.sql.where import WhereNode
@@ -11,13 +18,19 @@
 
 def aggregate(self, compiler, connection, operator=None, resolve_inner_expression=False):
     agg_expression, *_ = self.get_source_expressions()
-    if self.filter:
-        agg_expression = Case(
-            When(self.filter, then=agg_expression),
-            # Skip rows that don't meet the criteria.
-            default=Remove(),
-        )
-    lhs_mql = agg_expression.as_mql(compiler, connection, as_expr=True)
+    lhs_mql = None
+    if self.filter is not None:
+        try:
+            lhs_mql = self.filter.as_mql(compiler, connection, as_expr=True)
+        except NotSupportedError:
+            # Generate a CASE statement for this AggregateFilter.
+            agg_expression = Case(
+                When(self.filter.condition, then=agg_expression),
+                # Skip rows that don't meet the criteria.
+                default=Remove(),
+            )
+    if lhs_mql is None:
+        lhs_mql = agg_expression.as_mql(compiler, connection, as_expr=True)
     if resolve_inner_expression:
         return lhs_mql
     operator = operator or MONGO_AGGREGATIONS.get(self.__class__, self.function.lower())
@@ -32,18 +45,30 @@ def count(self, compiler, connection, resolve_inner_expression=False):
     """
     agg_expression, *_ = self.get_source_expressions()
     if not self.distinct or resolve_inner_expression:
+        lhs_mql = None
         conditions = [IsNull(agg_expression, False)]
         if self.filter:
-            conditions.append(self.filter)
-        inner_expression = Case(
-            When(WhereNode(conditions), then=agg_expression if self.distinct else Value(1)),
-            # Skip rows that don't meet the criteria.
-            default=Remove(),
-        )
-        inner_expression = inner_expression.as_mql(compiler, connection, as_expr=True)
+            try:
+                lhs_mql = self.filter.as_mql(compiler, connection, as_expr=True)
+            except NotSupportedError:
+                # Generate a CASE statement for this AggregateFilter.
+                conditions.append(self.filter.condition)
+                condition = When(
+                    WhereNode(conditions),
+                    then=agg_expression if self.distinct else Value(1),
+                )
+                inner_expression = Case(condition, default=Remove())
+        else:
+            inner_expression = Case(
+                When(WhereNode(conditions), then=agg_expression if self.distinct else Value(1)),
+                # Skip rows that don't meet the criteria.
+                default=Remove(),
+            )
+        if lhs_mql is None:
+            lhs_mql = inner_expression.as_mql(compiler, connection, as_expr=True)
         if resolve_inner_expression:
-            return inner_expression
-        return {"$sum": inner_expression}
+            return lhs_mql
+        return {"$sum": lhs_mql}
     # If distinct=True or resolve_inner_expression=False, sum the size of the
     # set.
     return {"$size": agg_expression.as_mql(compiler, connection, as_expr=True)}
@@ -57,8 +82,13 @@ def stddev_variance(self, compiler, connection):
     return aggregate(self, compiler, connection, operator=operator)
 
 
+def string_agg(self, compiler, connection):  # noqa: ARG001
+    raise NotSupportedError("StringAgg is not supported.")
+
+
 def register_aggregates():
     Aggregate.as_mql_expr = aggregate
     Count.as_mql_expr = count
     StdDev.as_mql_expr = stddev_variance
+    StringAgg.as_mql_expr = string_agg
     Variance.as_mql_expr = stddev_variance
diff --git a/django_mongodb_backend/features.py b/django_mongodb_backend/features.py
@@ -99,6 +99,13 @@ class DatabaseFeatures(GISFeatures, BaseDatabaseFeatures):
         "model_fields.test_jsonfield.TestSaveLoad.test_bulk_update_custom_get_prep_value",
         # To debug: https://github.com/mongodb/django-mongodb-backend/issues/362
         "constraints.tests.UniqueConstraintTests.test_validate_case_when",
+        # bulk_create() population of _order doesn't work because of ObjectId
+        # type mismatch when querying object_id CharField.
+        # https://github.com/django/django/commit/953095d1e603fe0f8f01175b1409ca23818dcff9
+        "contenttypes_tests.test_order_with_respect_to.OrderWithRespectToGFKTests.test_bulk_create_allows_duplicate_order_values",
+        "contenttypes_tests.test_order_with_respect_to.OrderWithRespectToGFKTests.test_bulk_create_mixed_scenario",
+        "contenttypes_tests.test_order_with_respect_to.OrderWithRespectToGFKTests.test_bulk_create_respects_mixed_manual_order",
+        "contenttypes_tests.test_order_with_respect_to.OrderWithRespectToGFKTests.test_bulk_create_with_existing_children",
     }
     # $bitAnd, #bitOr, and $bitXor are new in MongoDB 6.3.
     _django_test_expected_failures_bitwise = {
@@ -139,6 +146,7 @@ def django_test_expected_failures(self):
             "validation.test_unique.PerformUniqueChecksTest.test_unique_db_default",
         },
         "Insert expressions aren't supported.": {
+            "basic.tests.ModelTest.test_save_expressions",
             "bulk_create.tests.BulkCreateTests.test_bulk_insert_now",
             "bulk_create.tests.BulkCreateTests.test_bulk_insert_expressions",
             "expressions.tests.BasicExpressionsTests.test_new_object_create",
@@ -201,6 +209,7 @@ def django_test_expected_failures(self):
             "prefetch_related.tests.LookupOrderingTest.test_order",
             "prefetch_related.tests.MultiDbTests.test_using_is_honored_m2m",
             "prefetch_related.tests.MultiTableInheritanceTest",
+            "prefetch_related.tests.PrefetchRelatedMTICacheTests",
             "prefetch_related.tests.PrefetchRelatedTests",
             "prefetch_related.tests.ReadPrefetchedObjectsCacheTests",
             "prefetch_related.tests.Ticket21410Tests",
@@ -563,6 +572,7 @@ def django_test_expected_failures(self):
         "Custom lookups are not supported.": {
             "custom_lookups.tests.BilateralTransformTests",
             "custom_lookups.tests.LookupTests.test_basic_lookup",
+            "custom_lookups.tests.LookupTests.test_custom_lookup_with_subquery",
             "custom_lookups.tests.LookupTests.test_custom_name_lookup",
             "custom_lookups.tests.LookupTests.test_div3_extract",
             "custom_lookups.tests.SubqueryTransformTests.test_subquery_usage",
@@ -580,6 +590,16 @@ def django_test_expected_failures(self):
             "test_utils.tests.DisallowedDatabaseQueriesTests.test_disallowed_database_queries",
             "test_utils.tests.DisallowedDatabaseQueriesTests.test_disallowed_thread_database_connection",
         },
+        "search lookup not supported on non-Atlas.": {
+            "expressions.tests.BasicExpressionsTests.test_lookups_subquery",
+        },
+        "StringAgg is not supported.": {
+            "aggregation.tests.AggregateTestCase.test_distinct_on_stringagg",
+            "aggregation.tests.AggregateTestCase.test_string_agg_escapes_delimiter",
+            "aggregation.tests.AggregateTestCase.test_string_agg_filter",
+            "aggregation.tests.AggregateTestCase.test_string_agg_filter_in_subquery",
+            "aggregation.tests.AggregateTestCase.test_stringagg_default_value",
+        },
     }
 
     @cached_property
diff --git a/django_mongodb_backend/fields/json.py b/django_mongodb_backend/fields/json.py
@@ -24,7 +24,7 @@
 def valid_path_key_name(key_name):
     # A lookup can use path syntax (field.subfield) unless it contains a dollar
     # sign or period.
-    return not any(char in key_name for char in ("$", "."))
+    return not key_name.startswith("-") and not any(char in key_name for char in ("$", "."))
 
 
 def build_json_mql_path(lhs, key_transforms, as_expr=False):
@@ -36,7 +36,12 @@ def build_json_mql_path(lhs, key_transforms, as_expr=False):
         get_field = {"$getField": {"input": result, "field": key}}
         # Handle array indexing if the key is a digit. If key is something
         # like '001', it's not an array index despite isdigit() returning True.
-        if key.isdigit() and str(int(key)) == key:
+        try:
+            int(key)
+            is_digit = str(int(key)) == key
+        except ValueError:
+            is_digit = False
+        if is_digit:
             result = {
                 "$cond": {
                     "if": {"$isArray": result},
diff --git a/django_mongodb_backend/gis/operations.py b/django_mongodb_backend/gis/operations.py
@@ -40,6 +40,7 @@ def gis_operators(self):
         "FromWKT",
         "GeoHash",
         "GeometryDistance",
+        "GeometryType",
         "Intersection",
         "IsEmpty",
         "IsValid",
@@ -52,6 +53,7 @@ def gis_operators(self):
         "Perimeter",
         "PointOnSurface",
         "Reverse",
+        "Rotate",
         "Scale",
         "SnapToGrid",
         "SymDifference",
diff --git a/django_mongodb_backend/query_utils.py b/django_mongodb_backend/query_utils.py
@@ -1,4 +1,4 @@
-from django.core.exceptions import FullResultSet
+from django.core.exceptions import EmptyResultSet, FullResultSet
 from django.db.models import F
 from django.db.models.expressions import CombinedExpression, Func, Value
 from django.db.models.sql.query import Query
@@ -19,6 +19,8 @@ def process_lhs(node, compiler, connection, as_expr=False):
                 result.append(expr.as_mql(compiler, connection, as_expr=as_expr))
             except FullResultSet:
                 result.append(Value(True).as_mql(compiler, connection, as_expr=as_expr))
+            except EmptyResultSet:
+                result.append(Value(None).as_mql(compiler, connection, as_expr=as_expr))
         return result
     # node is a Transform with just one source expression, aliased as "lhs".
     if is_direct_value(node.lhs):
diff --git a/docs/conf.py b/docs/conf.py
@@ -42,8 +42,8 @@
 
 intersphinx_mapping = {
     "django": (
-        "https://docs.djangoproject.com/en/5.2/",
-        "https://docs.djangoproject.com/en/5.2/_objects/",
+        "https://docs.djangoproject.com/en/6.0/",
+        "https://docs.djangoproject.com/en/6.0/_objects/",
     ),
     "mongodb": ("https://www.mongodb.com/docs/languages/python/django-mongodb/v5.2/", None),
     "pymongo": ("https://www.mongodb.com/docs/languages/python/pymongo-driver/current/", None),
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,7 +2,7 @@
 Django MongoDB Backend
 ======================
 
-version 5.2.x for Django 5.2.x
+version 6.0.x for Django 6.0.x
 
 .. rubric:: Everything you need to know about Django MongoDB Backend.
 
diff --git a/docs/internals/contributing/unit-tests.rst b/docs/internals/contributing/unit-tests.rst
@@ -35,13 +35,13 @@ Third, clone your fork and install it:
 
 Next, get and install a copy of MongoDB's Django fork. This fork has some
 test suite adaptions for Django MongoDB Backend. There is a branch for each
-feature release of Django (e.g. ``mongodb-5.2.x`` below).
+feature release of Django (e.g. ``mongodb-6.0.x`` below).
 
 .. code-block:: bash
 
    $ git clone https://github.com/mongodb-forks/django.git django-repo
    $ cd django-repo
-   $ git checkout -t origin/mongodb-5.2.x
+   $ git checkout -t origin/mongodb-6.0.x
    $ python -m pip install -e .
    $ python -m pip install -r tests/requirements/py3.txt
 
diff --git a/docs/intro/configure.rst b/docs/intro/configure.rst
@@ -18,9 +18,9 @@ project template:
 
 .. code-block:: bash
 
-    $ django-admin startproject mysite --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.2.x.zip
+    $ django-admin startproject mysite --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/6.0.x.zip
 
-(If you're using a version of Django other than 5.2.x, replace the two numbers
+(If you're using a version of Django other than 6.0.x, replace the two numbers
 to match the first two numbers from your version.)
 
 This template includes the following line in ``settings.py``::
@@ -85,22 +85,25 @@ third-party apps. For example:
 Creating Django applications
 ============================
 
-Whenever you run ``python manage.py startapp``, you must remove the line::
+To create a new application, use ``python manage.py startapp``. No extra steps
+are necessary.
 
-    default_auto_field = 'django.db.models.BigAutoField'
+.. versionchanged:: 6.0
 
-from the new application's ``apps.py`` file (or change it to reference
-``"django_mongodb_backend.fields.ObjectIdAutoField"``).
+    In Django 5.2.x and older, whenever you run ``python manage.py startapp``,
+    you must remove the line::
 
-Alternatively, you can use the following :djadmin:`startapp` template which
-includes this change:
+        default_auto_field = 'django.db.models.BigAutoField'
 
-.. code-block:: bash
+    from the new application's ``apps.py`` file (or change it to reference
+    ``"django_mongodb_backend.fields.ObjectIdAutoField"``).
 
-    $ python manage.py startapp myapp --template https://github.com/mongodb-labs/django-mongodb-app/archive/refs/heads/5.2.x.zip
+    Alternatively, you can use the following :djadmin:`startapp` template which
+    includes this change:
 
-(If you're using a version of Django other than 5.2.x, replace the two numbers
-to match the first two numbers from your version.)
+    .. code-block:: bash
+
+        $ python manage.py startapp myapp --template https://github.com/mongodb-labs/django-mongodb-app/archive/refs/heads/5.2.x.zip
 
 .. _configuring-databases-setting:
 
diff --git a/docs/intro/install.rst b/docs/intro/install.rst
diff --git a/docs/releases/5.2.x.rst b/docs/releases/5.2.x.rst
diff --git a/docs/releases/6.0.x.rst b/docs/releases/6.0.x.rst
diff --git a/docs/releases/index.rst b/docs/releases/index.rst
diff --git a/docs/topics/known-issues.rst b/docs/topics/known-issues.rst
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/requirements.txt b/requirements.txt
diff --git a/tests/aggregation_/test_stringagg.py b/tests/aggregation_/test_stringagg.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-__version__ = "5.2.4.dev0"`
	`1`	`+__version__ = "6.0.0.dev0"`
`2`	`2`
`3`	`3`	`# Check Django compatibility before other imports which may fail if the`
`4`	`4`	`# wrong version of Django is installed.`