Merge branch 'master' of https://github.com/FallenDeity/django-stubs

Author: FallenDeity

.github/workflows/test.yml

@@ -95,7 +95,7 @@ jobs:
           SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
 
       - name: Run stubtest
-        run: bash ./scripts/stubtest.sh
+        run: ./scripts/stubtest.sh
 
   run-pyright:
     timeout-minutes: 10

.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
         args: [--fix=lf]
       - id: check-case-conflict
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.7
+    rev: v0.9.10
     hooks:
       - id: ruff
         args: ["--fix", "--exit-non-zero-on-fix"]

CONTRIBUTING.md

@@ -79,11 +79,12 @@ rm -r .mypy_cache
 
 ### Testing stubs with `stubtest`
 
-Run `bash ./scripts/stubtest.sh` to test that stubs and sources are in-line.
+Run `./scripts/stubtest.sh` to test that stubs and sources are in-line.
 
-We have two special files to allow errors:
+We have some special files to allow errors:
 1. `scripts/stubtest/allowlist.txt` where we store things that we really don't care about: hacks, django internal utility modules, things that are handled by our plugin, things that are not representable by type system, etc
-2. `scripts/stubtest/allowlist_todo.txt` where we store all errors there are right now. Basically, this is a TODO list: we need to work through this list and fix things (or move entries to real `allowlist.txt`). In the end, ideally we can remove this file
+2. `scripts/stubtest/allowlist_todo.txt` where we store all errors there are right now. Basically, this is a TODO list: we need to work through this list and fix things (or move entries to real `allowlist.txt`). In the end, ideally we can remove this file.
+3. `scripts/stubtest/allowlist_todo_django51.txt` where we store new errors from the Django 5.0 to 5.1 upgrade. This is an extra TODO list.
 
 You might also want to disable `incremental` mode while working on `stubtest` changes.
 This mode leads to several known problems (stubs do not show up or have strange errors).

django-stubs/conf/urls/__init__.pyi

@@ -1,32 +1,9 @@
-# Stubs for django.conf.urls (Python 3.5)
-from collections.abc import Callable, Sequence
-from typing import Any, overload
-
-from django.http.response import HttpResponse, HttpResponseBase
-from django.urls import URLPattern, URLResolver
 from django.urls import include as include
-from typing_extensions import TypeAlias
-
-handler400: str | Callable[..., HttpResponse]
-handler403: str | Callable[..., HttpResponse]
-handler404: str | Callable[..., HttpResponse]
-handler500: str | Callable[..., HttpResponse]
+from django.views import defaults
 
-_IncludedURLConf: TypeAlias = tuple[Sequence[URLResolver | URLPattern], str | None, str | None]
+__all__ = ["handler400", "handler403", "handler404", "handler500", "include"]
 
-# Deprecated
-@overload
-def url(
-    regex: str, view: Callable[..., HttpResponseBase], kwargs: dict[str, Any] | None = ..., name: str | None = ...
-) -> URLPattern: ...
-@overload
-def url(
-    regex: str, view: _IncludedURLConf, kwargs: dict[str, Any] | None = ..., name: str | None = ...
-) -> URLResolver: ...
-@overload
-def url(
-    regex: str,
-    view: Sequence[URLResolver | str],
-    kwargs: dict[str, Any] | None = ...,
-    name: str | None = ...,
-) -> URLResolver: ...
+handler400 = defaults.bad_request
+handler403 = defaults.permission_denied
+handler404 = defaults.page_not_found
+handler500 = defaults.server_error

django-stubs/contrib/admin/models.pyi

@@ -1,4 +1,4 @@
-from typing import Any, ClassVar, Literal, overload
+from typing import Any, ClassVar
 from uuid import UUID
 
 from django.contrib.auth.models import AbstractUser
@@ -25,26 +25,13 @@ class LogEntryManager(models.Manager[LogEntry]):
         action_flag: int,
         change_message: Any = ...,
     ) -> LogEntry: ...
-    @overload
     def log_actions(
         self,
         user_id: int,
         queryset: QuerySet[Model],
         action_flag: int,
         change_message: str | list[Any] = "",
-        *,
-        single_object: Literal[True],
-    ) -> LogEntry: ...
-    @overload
-    def log_actions(
-        self,
-        user_id: int,
-        queryset: QuerySet[Model],
-        action_flag: int,
-        change_message: str | list[Any] = "",
-        *,
-        single_object: Literal[False] = False,
-    ) -> list[LogEntry]: ...
+    ) -> list[LogEntry] | LogEntry: ...
 
 class LogEntry(models.Model):
     id: models.AutoField

django-stubs/contrib/admin/options.pyi

@@ -1,6 +1,6 @@
 import enum
 from collections.abc import Callable, Iterable, Iterator, Mapping, Sequence
-from typing import Any, Generic, Literal, TypeVar, cast, overload, type_check_only
+from typing import Any, ClassVar, Generic, Literal, TypeVar, cast, overload, type_check_only
 
 from django import forms
 from django.contrib.admin.filters import FieldListFilter, ListFilter
@@ -84,23 +84,25 @@ _ListFilterT: TypeAlias = (
 _ModelT = TypeVar("_ModelT", bound=Model)
 _DisplayT: TypeAlias = _ListOrTuple[str | Callable[[_ModelT], str | bool]]
 
+# Options `form`, `list_display`, `list_display_links` and `actions` are not marked as `ClassVar` due to the
+# limitations of the current type system: `ClassVar` cannot contain type variables.
 class BaseModelAdmin(Generic[_ModelT]):
-    autocomplete_fields: _ListOrTuple[str]
-    raw_id_fields: _ListOrTuple[str]
-    fields: _FieldGroups | None
-    exclude: _ListOrTuple[str] | None
-    fieldsets: _FieldsetSpec | None
+    autocomplete_fields: ClassVar[_ListOrTuple[str]]
+    raw_id_fields: ClassVar[_ListOrTuple[str]]
+    fields: ClassVar[_FieldGroups | None]
+    exclude: ClassVar[_ListOrTuple[str] | None]
+    fieldsets: ClassVar[_FieldsetSpec | None]
     form: type[forms.ModelForm[_ModelT]]
-    filter_vertical: _ListOrTuple[str]
-    filter_horizontal: _ListOrTuple[str]
-    radio_fields: Mapping[str, _Direction]
-    prepopulated_fields: dict[str, Sequence[str]]
-    formfield_overrides: Mapping[type[Field], Mapping[str, Any]]
-    readonly_fields: _ListOrTuple[str]
-    ordering: _ListOrTuple[str] | None
-    sortable_by: _ListOrTuple[str] | None
-    show_full_result_count: bool
-    checks_class: Any
+    filter_vertical: ClassVar[_ListOrTuple[str]]
+    filter_horizontal: ClassVar[_ListOrTuple[str]]
+    radio_fields: ClassVar[Mapping[str, _Direction]]
+    prepopulated_fields: ClassVar[dict[str, Sequence[str]]]
+    formfield_overrides: ClassVar[Mapping[type[Field], Mapping[str, Any]]]
+    readonly_fields: ClassVar[_ListOrTuple[str]]
+    ordering: ClassVar[_ListOrTuple[str] | None]
+    sortable_by: ClassVar[_ListOrTuple[str] | None]
+    show_full_result_count: ClassVar[bool]
+    checks_class: ClassVar[Any]
     model: type[_ModelT]
     opts: Options[_ModelT]
     admin_site: AdminSite
@@ -150,33 +152,33 @@ _ActionCallable: TypeAlias = Callable[[_ModelAdmin, HttpRequest, QuerySet[_Model
 class ModelAdmin(BaseModelAdmin[_ModelT]):
     list_display: _DisplayT[_ModelT]
     list_display_links: _DisplayT[_ModelT] | None
-    list_filter: _ListOrTuple[_ListFilterT]
-    list_select_related: bool | _ListOrTuple[str]
-    list_per_page: int
-    list_max_show_all: int
-    list_editable: _ListOrTuple[str]
-    search_fields: _ListOrTuple[str]
-    search_help_text: _StrOrPromise | None
-    date_hierarchy: str | None
-    save_as: bool
-    save_as_continue: bool
-    save_on_top: bool
-    paginator: type
-    preserve_filters: bool
-    show_facets: ShowFacets
-    inlines: _ListOrTuple[type[InlineModelAdmin]]
-    add_form_template: _TemplateForResponseT | None
-    change_form_template: _TemplateForResponseT | None
-    change_list_template: _TemplateForResponseT | None
-    delete_confirmation_template: _TemplateForResponseT | None
-    delete_selected_confirmation_template: _TemplateForResponseT | None
-    object_history_template: _TemplateForResponseT | None
-    popup_response_template: _TemplateForResponseT | None
+    list_filter: ClassVar[_ListOrTuple[_ListFilterT]]
+    list_select_related: ClassVar[bool | _ListOrTuple[str]]
+    list_per_page: ClassVar[int]
+    list_max_show_all: ClassVar[int]
+    list_editable: ClassVar[_ListOrTuple[str]]
+    search_fields: ClassVar[_ListOrTuple[str]]
+    search_help_text: ClassVar[_StrOrPromise | None]
+    date_hierarchy: ClassVar[str | None]
+    save_as: ClassVar[bool]
+    save_as_continue: ClassVar[bool]
+    save_on_top: ClassVar[bool]
+    paginator: ClassVar[type]
+    preserve_filters: ClassVar[bool]
+    show_facets: ClassVar[ShowFacets]
+    inlines: ClassVar[_ListOrTuple[type[InlineModelAdmin]]]
+    add_form_template: ClassVar[_TemplateForResponseT | None]
+    change_form_template: ClassVar[_TemplateForResponseT | None]
+    change_list_template: ClassVar[_TemplateForResponseT | None]
+    delete_confirmation_template: ClassVar[_TemplateForResponseT | None]
+    delete_selected_confirmation_template: ClassVar[_TemplateForResponseT | None]
+    object_history_template: ClassVar[_TemplateForResponseT | None]
+    popup_response_template: ClassVar[_TemplateForResponseT | None]
     actions: Sequence[_ActionCallable[Self, _ModelT] | str] | None
-    action_form: Any
-    actions_on_top: bool
-    actions_on_bottom: bool
-    actions_selection_counter: bool
+    action_form: ClassVar[Any]
+    actions_on_top: ClassVar[bool]
+    actions_on_bottom: ClassVar[bool]
+    actions_selection_counter: ClassVar[bool]
     model: type[_ModelT]
     opts: Options[_ModelT]
     admin_site: AdminSite

django-stubs/contrib/flatpages/admin.pyi

@@ -1,11 +1,11 @@
-from typing import Any
+from typing import Any, ClassVar
 
 from django.contrib import admin
 from django.contrib.flatpages.models import FlatPage
 
 class FlatPageAdmin(admin.ModelAdmin[FlatPage]):
     form: Any
-    fieldsets: Any
+    fieldsets: ClassVar[Any]
     list_display: Any
-    list_filter: Any
-    search_fields: Any
+    list_filter: ClassVar[Any]
+    search_fields: ClassVar[Any]

django-stubs/contrib/gis/db/models/fields.pyi

@@ -121,7 +121,6 @@ class GeometryField(BaseSpatialField[_ST, _GT]):
         srid: Any = ...,
         **kwargs: Any,
     ) -> forms.GeometryField: ...
-    def select_format(self, compiler: Any, sql: Any, params: Any) -> Any: ...
 
 class PointField(GeometryField[_ST, _GT]):
     _pyi_private_set_type: Point | Combinable
@@ -181,7 +180,6 @@ class GeometryCollectionField(GeometryField[_ST, _GT]):
 
 class ExtentField(Field):
     def get_internal_type(self) -> Any: ...
-    def select_format(self, compiler: Any, sql: Any, params: Any) -> Any: ...
 
 class RasterField(BaseSpatialField):
     def db_type(self, connection: Any) -> Any: ...

django-stubs/contrib/gis/db/models/functions.pyi

@@ -11,6 +11,7 @@ from django.utils.functional import cached_property
 NUMERIC_TYPES: Any
 
 class GeoFuncMixin:
+    function: str | None = None
     geom_param_pos: Any
     @property
     def geo_field(self) -> Any: ...

django-stubs/contrib/postgres/operations.pyi

@@ -1,11 +1,8 @@
-from typing import Literal
-
 from django.db.backends.base.schema import BaseDatabaseSchemaEditor
 from django.db.migrations import AddConstraint, AddIndex, RemoveIndex
 from django.db.migrations.operations.base import Operation
 
 class CreateExtension(Operation):
-    reversible: bool
     name: str
     def __init__(self, name: str) -> None: ...
     def extension_exists(self, schema_editor: BaseDatabaseSchemaEditor, extension: str) -> bool: ...
@@ -37,11 +34,8 @@ class UnaccentExtension(CreateExtension):
 class NotInTransactionMixin:
     def _ensure_not_in_transaction(self, schema_editor: BaseDatabaseSchemaEditor) -> None: ...
 
-class AddIndexConcurrently(NotInTransactionMixin, AddIndex):
-    atomic: Literal[False]
-
-class RemoveIndexConcurrently(NotInTransactionMixin, RemoveIndex):
-    atomic: Literal[False]
+class AddIndexConcurrently(NotInTransactionMixin, AddIndex): ...
+class RemoveIndexConcurrently(NotInTransactionMixin, RemoveIndex): ...
 
 class CollationOperation(Operation):
     name: str