Add window frame exclusion from Django 5.1 (#2554)

Author: adamchainz

django-stubs/db/backends/base/features.pyi

@@ -99,6 +99,7 @@ class BaseDatabaseFeatures:
     supports_index_on_text_field: bool
     supports_over_clause: bool
     supports_frame_range_fixed_distance: bool
+    supports_frame_exclusion: bool
     only_supports_unbounded_with_preceding_and_following: bool
     supports_cast_with_precision: bool
     time_cast_precision: int

django-stubs/db/models/__init__.pyi

@@ -41,6 +41,7 @@ from .expressions import ValueRange as ValueRange
 from .expressions import When as When
 from .expressions import Window as Window
 from .expressions import WindowFrame as WindowFrame
+from .expressions import WindowFrameExclusion as WindowFrameExclusion
 from .fields import NOT_PROVIDED as NOT_PROVIDED
 from .fields import AutoField as AutoField
 from .fields import BigAutoField as BigAutoField

django-stubs/db/models/expressions.pyi

@@ -1,6 +1,7 @@
 import datetime
 from collections.abc import Callable, Iterable, Iterator, Mapping, Sequence
 from decimal import Decimal
+from enum import Enum
 from typing import Any, ClassVar, Generic, Literal, NoReturn, TypeVar
 
 from django.db.backends.base.base import BaseDatabaseWrapper
@@ -298,13 +299,25 @@ class Window(SQLiteNumericMixin, Expression):
         output_field: Field | None = None,
     ) -> None: ...
 
+class WindowFrameExclusion(Enum):
+    CURRENT_ROW = "CURRENT ROW"
+    GROUP = "GROUP"
+    TIES = "TIES"
+    NO_OTHERS = "NO OTHERS"
+
 class WindowFrame(Expression):
     template: str
     frame_type: str
-    def __init__(self, start: int | None = None, end: int | None = None) -> None: ...
+    def __init__(
+        self,
+        start: int | None = None,
+        end: int | None = None,
+        exclusion: WindowFrameExclusion | None = None,
+    ) -> None: ...
     def window_frame_start_end(
         self, connection: BaseDatabaseWrapper, start: int | None, end: int | None
     ) -> tuple[int, int]: ...
+    def get_exclusion(self) -> str: ...
 
 class RowRange(WindowFrame): ...
 class ValueRange(WindowFrame): ...

scripts/stubtest/allowlist.txt

@@ -266,6 +266,7 @@ django.db.backends.mysql.features.DatabaseFeatures.supports_index_column_orderin
 django.db.backends.mysql.features.DatabaseFeatures.supports_transactions
 django.db.backends.mysql.features.DatabaseFeatures.update_can_self_select
 django.db.backends.oracle.features.DatabaseFeatures.supports_boolean_expr_in_select_clause
+django.db.backends.oracle.features.DatabaseFeatures.supports_frame_exclusion
 django.db.backends.postgresql.base.DatabaseWrapper.pg_version
 django.db.backends.postgresql.features.DatabaseFeatures.is_postgresql_13
 django.db.migrations.RenameField.new_name_lower

scripts/stubtest/allowlist_todo_django51.txt

@@ -20,9 +20,6 @@ django.contrib.gis.db.backends.mysql.operations.MySQLOperations.collect
 django.contrib.gis.db.models.ForeignObjectRel.accessor_name
 django.contrib.gis.db.models.ForeignObjectRel.cache_name
 django.contrib.gis.db.models.OrderBy.constraint_validation_compatible
-django.contrib.gis.db.models.WindowFrame.__init__
-django.contrib.gis.db.models.WindowFrame.get_exclusion
-django.contrib.gis.db.models.WindowFrameExclusion
 django.contrib.gis.db.models.functions.FromWKB.__init__
 django.contrib.gis.db.models.functions.FromWKB.as_oracle
 django.contrib.gis.db.models.functions.FromWKB.output_field
@@ -70,7 +67,6 @@ django.core.files.storage.filesystem.FileSystemStorage.__init__
 django.core.files.storage.filesystem.FileSystemStorage.is_name_available
 django.core.files.storage.get_storage_class
 django.core.signing.Signer.__init__
-django.db.backends.base.features.BaseDatabaseFeatures.supports_frame_exclusion
 django.db.backends.base.operations.BaseDatabaseOperations.bulk_insert_sql
 django.db.backends.base.operations.BaseDatabaseOperations.force_group_by
 django.db.backends.base.operations.BaseDatabaseOperations.window_frame_end
@@ -82,29 +78,20 @@ django.db.backends.ddl_references.Table.references_index
 django.db.backends.oracle.features.DatabaseFeatures.bare_select_suffix
 django.db.backends.oracle.features.DatabaseFeatures.supports_aggregation_over_interval_types
 django.db.backends.oracle.features.DatabaseFeatures.supports_comparing_boolean_expr
-django.db.backends.oracle.features.DatabaseFeatures.supports_frame_exclusion
 django.db.backends.postgresql.base.DatabaseWrapper.close_pool
 django.db.backends.postgresql.base.DatabaseWrapper.pool
 django.db.backends.postgresql.features.DatabaseFeatures.django_test_skips
 django.db.backends.postgresql.features.DatabaseFeatures.is_postgresql_16
-django.db.backends.postgresql.features.DatabaseFeatures.supports_frame_exclusion
 django.db.backends.sqlite3.base.DatabaseWrapper.transaction_modes
-django.db.backends.sqlite3.features.DatabaseFeatures.supports_frame_exclusion
 django.db.backends.sqlite3.operations.DatabaseOperations.force_group_by
 django.db.migrations.autodetector.MigrationAutodetector.generate_altered_index_together
 django.db.migrations.autodetector.OperationDependency
 django.db.models.ForeignObjectRel.accessor_name
 django.db.models.ForeignObjectRel.cache_name
 django.db.models.OrderBy.constraint_validation_compatible
-django.db.models.WindowFrame.__init__
-django.db.models.WindowFrame.get_exclusion
-django.db.models.WindowFrameExclusion
 django.db.models.expressions.BaseExpression.constraint_validation_compatible
 django.db.models.expressions.BaseExpression.get_expression_for_validation
 django.db.models.expressions.OrderBy.constraint_validation_compatible
-django.db.models.expressions.WindowFrame.__init__
-django.db.models.expressions.WindowFrame.get_exclusion
-django.db.models.expressions.WindowFrameExclusion
 django.db.models.fields.mixins.FieldCacheMixin.cache_name
 django.db.models.fields.related.ForeignObjectRel.accessor_name
 django.db.models.fields.related.ForeignObjectRel.cache_name