Merge remote-tracking branch 'upstream/master' into field-widget-rework

Author: michalpokusa

.github/workflows/test.yml

@@ -70,14 +70,14 @@ jobs:
       - name: Run pytest tests
         run: PYTHONPATH='.' pytest --num-shards=4 --shard-id=${{ matrix.shard }} -n auto tests
       - name: Run mypy on the test cases
-        run: mypy --strict tests/assert_type
+        run: mypy --strict tests
 
   stubtest:
     timeout-minutes: 10
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.12']
+        python-version: ['3.12', '3.13']
       fail-fast: false
     steps:
       - uses: actions/checkout@v4

.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.11.5
+    rev: v0.11.8
     hooks:
       - id: ruff
         args: ["--fix", "--exit-non-zero-on-fix"]

README.md

@@ -49,6 +49,7 @@ We rely on different `django` and `mypy` versions:
 
 | django-stubs   | Mypy version | Django version | Django partial support | Python version |
 |----------------|--------------|----------------|------------------------|----------------|
+| 5.2.0          | 1.13+        | 5.2            | 5.1                    | 3.10 - 3.13    |
 | 5.1.3          | 1.13+        | 5.1            | 4.2                    | 3.9 - 3.13     |
 | 5.1.2          | 1.13+        | 5.1            | 4.2                    | 3.9 - 3.13     |
 | 5.1.1          | 1.13.x       | 5.1            | 4.2                    | 3.8 - 3.12     |
@@ -163,6 +164,11 @@ This happens because these Django classes do not support [`__class_getitem__`](h
 
    You can add extra types to patch with `django_stubs_ext.monkeypatch(extra_classes=[YourDesiredType])`
 
+   **If you use generic symbols in `django.contrib.auth.forms`**, you will have to do the monkeypatching
+   again in your first [`AppConfig.ready`](https://docs.djangoproject.com/en/5.2/ref/applications/#django.apps.AppConfig.ready).
+   This is currently required because `django.contrib.auth.forms` cannot be imported until django is initialized.
+
+
 2. You can use strings instead: `'QuerySet[MyModel]'` and `'Manager[MyModel]'`, this way it will work as a type for `mypy` and as a regular `str` in runtime.
 
 ### How can I create a HttpRequest that's guaranteed to have an authenticated user?

django-stubs/apps/__init__.pyi

@@ -1,2 +1,4 @@
 from .config import AppConfig as AppConfig
 from .registry import apps as apps
+
+__all__ = ["AppConfig", "apps"]

django-stubs/conf/global_settings.pyi

@@ -3,7 +3,9 @@ from re import Pattern
 
 # This is defined here as a do-nothing function because we can't import
 # django.utils.translation -- that module depends on the settings.
-from typing import Any, Literal, Protocol, TypeAlias, type_check_only
+from typing import Any, Literal, Protocol, TypeAlias, TypedDict, type_check_only
+
+from typing_extensions import NotRequired
 
 _Admins: TypeAlias = list[tuple[str, str]]
 
@@ -401,7 +403,12 @@ PASSWORD_RESET_TIMEOUT: int
 # upon login
 PASSWORD_HASHERS: list[str]
 
-AUTH_PASSWORD_VALIDATORS: list[dict[str, str]]
+@type_check_only
+class _AuthPasswordValidatorsDict(TypedDict):
+    NAME: str
+    OPTIONS: NotRequired[dict[str, Any]]
+
+AUTH_PASSWORD_VALIDATORS: list[_AuthPasswordValidatorsDict]
 
 ###########
 # SIGNING #

django-stubs/contrib/admin/__init__.pyi

@@ -22,3 +22,28 @@ from .sites import AdminSite as AdminSite
 from .sites import site as site
 
 def autodiscover() -> None: ...
+
+__all__ = [
+    "action",
+    "display",
+    "register",
+    "ModelAdmin",
+    "HORIZONTAL",
+    "VERTICAL",
+    "StackedInline",
+    "TabularInline",
+    "AdminSite",
+    "site",
+    "ListFilter",
+    "SimpleListFilter",
+    "FieldListFilter",
+    "BooleanFieldListFilter",
+    "RelatedFieldListFilter",
+    "ChoicesFieldListFilter",
+    "DateFieldListFilter",
+    "AllValuesFieldListFilter",
+    "EmptyFieldListFilter",
+    "RelatedOnlyFieldListFilter",
+    "ShowFacets",
+    "autodiscover",
+]

django-stubs/contrib/admin/options.pyi

@@ -25,7 +25,7 @@ from django.forms.models import (
     ModelForm,
     ModelMultipleChoiceField,
 )
-from django.forms.widgets import Media
+from django.forms.widgets import Media, MediaDefiningClass
 from django.http.request import HttpRequest
 from django.http.response import HttpResponse, HttpResponseBase, HttpResponseRedirect
 from django.template.response import _TemplateForResponseT
@@ -84,7 +84,7 @@ _ListDisplayT: TypeAlias = _ListOrTuple[_DisplayT[_ModelT]]
 
 # 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]):
+class BaseModelAdmin(Generic[_ModelT], metaclass=MediaDefiningClass):
     autocomplete_fields: ClassVar[_ListOrTuple[str]]
     raw_id_fields: ClassVar[_ListOrTuple[str]]
     fields: ClassVar[_FieldGroups | None]

django-stubs/contrib/admin/templatetags/admin_list.pyi

@@ -13,7 +13,6 @@ from django.utils.safestring import SafeString
 from .base import InclusionAdminNode
 
 register: Any
-DOT: str
 
 def paginator_number(cl: ChangeList, i: int) -> SafeString: ...
 def pagination(cl: ChangeList) -> dict[str, Any]: ...

django-stubs/contrib/auth/models.pyi

@@ -24,8 +24,8 @@ _AnyUser: TypeAlias = _User | AnonymousUser
 # These are only needed for generic classes in order to bind to a specific implementation
 _AnyUserType = TypeVar("_AnyUserType", bound=_AnyUser)  # noqa: PYI018
 
-# do not use the alias `_User` so the bound remains at `AbstractUser`
-_UserType = TypeVar("_UserType", bound=AbstractUser)
+# do not use the alias `_User` so the bound remains at `AbstractBaseUser`
+_UserType = TypeVar("_UserType", bound=AbstractBaseUser)
 
 def update_last_login(sender: _UserModel, user: _User, **kwargs: Any) -> None: ...
 
@@ -79,16 +79,16 @@ class PermissionsMixin(models.Model):
     groups = models.ManyToManyField(Group)
     user_permissions = models.ManyToManyField(Permission)
 
-    def get_user_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
-    async def aget_user_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
-    def get_group_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
-    async def aget_group_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
-    def get_all_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
-    async def aget_all_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
-    def has_perm(self, perm: str, obj: _AnyUser | None = ...) -> bool: ...
-    async def ahas_perm(self, perm: str, obj: _AnyUser | None = ...) -> bool: ...
-    def has_perms(self, perm_list: Iterable[str], obj: _AnyUser | None = ...) -> bool: ...
-    async def ahas_perms(self, perm_list: Iterable[str], obj: _AnyUser | None = ...) -> bool: ...
+    def get_user_permissions(self, obj: Model | None = ...) -> set[str]: ...
+    async def aget_user_permissions(self, obj: Model | None = ...) -> set[str]: ...
+    def get_group_permissions(self, obj: Model | None = ...) -> set[str]: ...
+    async def aget_group_permissions(self, obj: Model | None = ...) -> set[str]: ...
+    def get_all_permissions(self, obj: Model | None = ...) -> set[str]: ...
+    async def aget_all_permissions(self, obj: Model | None = ...) -> set[str]: ...
+    def has_perm(self, perm: str, obj: Model | None = ...) -> bool: ...
+    async def ahas_perm(self, perm: str, obj: Model | None = ...) -> bool: ...
+    def has_perms(self, perm_list: Iterable[str], obj: Model | None = ...) -> bool: ...
+    async def ahas_perms(self, perm_list: Iterable[str], obj: Model | None = ...) -> bool: ...
     def has_module_perms(self, app_label: str) -> bool: ...
     async def ahas_module_perms(self, app_label: str) -> bool: ...
 
@@ -131,16 +131,16 @@ class AnonymousUser:
     def groups(self) -> EmptyManager[Group]: ...
     @property
     def user_permissions(self) -> EmptyManager[Permission]: ...
-    def get_user_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
-    async def aget_user_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
-    def get_group_permissions(self, obj: _AnyUser | None = ...) -> set[Any]: ...
-    async def aget_group_permissions(self, obj: _AnyUser | None = ...) -> set[Any]: ...
-    def get_all_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
-    async def aget_all_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
-    def has_perm(self, perm: str, obj: _AnyUser | None = ...) -> bool: ...
-    async def ahas_perm(self, perm: str, obj: _AnyUser | None = ...) -> bool: ...
-    def has_perms(self, perm_list: Iterable[str], obj: _AnyUser | None = ...) -> bool: ...
-    async def ahas_perms(self, perm_list: Iterable[str], obj: _AnyUser | None = ...) -> bool: ...
+    def get_user_permissions(self, obj: Model | None = ...) -> set[str]: ...
+    async def aget_user_permissions(self, obj: Model | None = ...) -> set[str]: ...
+    def get_group_permissions(self, obj: Model | None = ...) -> set[Any]: ...
+    async def aget_group_permissions(self, obj: Model | None = ...) -> set[Any]: ...
+    def get_all_permissions(self, obj: Model | None = ...) -> set[str]: ...
+    async def aget_all_permissions(self, obj: Model | None = ...) -> set[str]: ...
+    def has_perm(self, perm: str, obj: Model | None = ...) -> bool: ...
+    async def ahas_perm(self, perm: str, obj: Model | None = ...) -> bool: ...
+    def has_perms(self, perm_list: Iterable[str], obj: Model | None = ...) -> bool: ...
+    async def ahas_perms(self, perm_list: Iterable[str], obj: Model | None = ...) -> bool: ...
     def has_module_perms(self, module: str) -> bool: ...
     async def ahas_module_perms(self, module: str) -> bool: ...
     @property

django-stubs/contrib/auth/views.pyi

@@ -31,7 +31,6 @@ class LogoutView(RedirectURLMixin, TemplateView):
     extra_context: Any
     def dispatch(self, request: HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse: ...
     def post(self, request: HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse: ...
-    def get_next_page(self) -> str | None: ...
 
 def logout_then_login(request: HttpRequest, login_url: str | None = ...) -> HttpResponseRedirect: ...
 def redirect_to_login(
@@ -51,7 +50,6 @@ class PasswordResetView(PasswordContextMixin, FormView):
     title: Any
     token_generator: Any
 
-INTERNAL_RESET_URL_TOKEN: str
 INTERNAL_RESET_SESSION_TOKEN: str
 
 class PasswordResetDoneView(PasswordContextMixin, TemplateView):