Add "Field.formfield" annotations

Author: brianhelba

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

@@ -108,7 +108,9 @@ class GeometryField(BaseSpatialField[_ST, _GT]):
         validators: Iterable[_ValidatorCallable] = ...,
         error_messages: _ErrorMessagesMapping | None = ...,
     ) -> None: ...
-    def formfield(self, **kwargs: Any) -> Any: ...  # type: ignore[override]
+    def formfield(  # type: ignore[override]
+        self, form_class: type[forms.GeometryField] | None = ..., geom_type: str = ..., srid: Any = ..., **kwargs: Any
+    ) -> forms.GeometryField: ...
     def select_format(self, compiler: Any, sql: Any, params: Any) -> Any: ...
 
 class PointField(GeometryField[_ST, _GT]):

django-stubs/db/models/fields/__init__.pyi

@@ -5,6 +5,7 @@ from datetime import date, time, timedelta
 from datetime import datetime as real_datetime
 from typing import Any, ClassVar, Generic, Literal, Protocol, TypeVar, overload
 
+from django import forms
 from django.core import validators  # due to weird mypy.stubtest error
 from django.core.checks import CheckMessage
 from django.core.exceptions import FieldDoesNotExist as FieldDoesNotExist
@@ -202,7 +203,12 @@ class Field(RegisterLookupMixin, Generic[_ST, _GT]):
     def get_db_prep_save(self, value: Any, connection: BaseDatabaseWrapper) -> Any: ...
     def get_internal_type(self) -> str: ...
     # TODO: plugin support
-    def formfield(self, form_class: Any | None = ..., choices_form_class: Any | None = ..., **kwargs: Any) -> Any: ...
+    def formfield(
+        self,
+        form_class: type[forms.Field] | None = ...,
+        choices_form_class: type[forms.ChoiceField] | None = ...,
+        **kwargs: Any,
+    ) -> forms.Field: ...
     def save_form_data(self, instance: Model, data: Any) -> None: ...
     def contribute_to_class(self, cls: type[Model], name: str, private_only: bool = ...) -> None: ...
     def to_python(self, value: Any) -> Any: ...

scripts/stubtest/allowlist.txt

@@ -14,6 +14,9 @@ django.contrib.auth.migrations.*
 django.contrib.flatpages.migrations.*
 django.contrib.contenttypes.migrations.*
 
+# Annotate optional parameters which Django accepts as **kwargs
+django.contrib.gis.db.models.GeometryField.formfield
+
 # default_storage is actually an instance of DefaultStorage, but it proxies through to a Storage
 django.core.files.storage.default_storage