feat: Add tests and support for gis models

Author: FallenDeity

django-stubs/contrib/admin/models.pyi

@@ -31,6 +31,8 @@ class LogEntryManager(models.Manager[LogEntry]):
         queryset: QuerySet[Model],
         action_flag: int,
         change_message: str | list[Any] = "",
+        *,
+        single_object: bool = False,
     ) -> list[LogEntry] | LogEntry: ...
 
 class LogEntry(models.Model):

django-stubs/contrib/auth/models.pyi

@@ -9,6 +9,7 @@ from django.db import models
 from django.db.models import QuerySet
 from django.db.models.base import Model
 from django.db.models.expressions import Combinable
+from django.db.models.fields.related_descriptors import ManyToManyDescriptor
 from django.db.models.manager import EmptyManager
 from django.utils.functional import _StrOrPromise
 from typing_extensions import Self, TypeAlias
@@ -29,7 +30,8 @@ class Permission(models.Model):
     content_type = models.ForeignKey[ContentType | Combinable, ContentType](ContentType, on_delete=models.CASCADE)
     content_type_id: int
     codename = models.CharField(max_length=100)
-    group_set: models.ManyToManyField[Group, Group_permissions]
+    group_set: ManyToManyDescriptor[Group, Group_permissions]
+    user_set: ManyToManyDescriptor[User, User_permissions]
     def natural_key(self) -> tuple[str, str, str]: ...
 
 class GroupManager(models.Manager[Group]):
@@ -48,13 +50,40 @@ class Group_permissions(models.Model):
     permission: models.ForeignKey[Permission | Combinable, Permission]
     permission_id: int
 
+# This is a model that only exists in Django's model registry and doesn't have any
+# class statement form. It's the through model between 'User' and 'Group'.
+@type_check_only
+class User_groups(models.Model):
+    objects: ClassVar[models.Manager[Self]]
+
+    id: models.AutoField
+    pk: models.AutoField
+    user: models.ForeignKey[User | Combinable, User]
+    user_id: int
+    group: models.ForeignKey[Group | Combinable, Group]
+    group_id: int
+
+# This is a model that only exists in Django's model registry and doesn't have any
+# class statement form. It's the through model between 'User' and 'Permission'.
+@type_check_only
+class User_permissions(models.Model):
+    objects: ClassVar[models.Manager[Self]]
+
+    id: models.AutoField
+    pk: models.AutoField
+    user: models.ForeignKey[User | Combinable, User]
+    user_id: int
+    permission: models.ForeignKey[Permission | Combinable, Permission]
+    permission_id: int
+
 class Group(models.Model):
     objects: ClassVar[GroupManager]
 
     id: models.AutoField
     pk: models.AutoField
     name = models.CharField(max_length=150)
     permissions = models.ManyToManyField[Permission, Group_permissions](Permission)
+    user_set: ManyToManyDescriptor[User, User_groups]
     def natural_key(self) -> tuple[str]: ...
 
 _T = TypeVar("_T", bound=Model)
@@ -77,8 +106,8 @@ class UserManager(BaseUserManager[_T]):
 
 class PermissionsMixin(models.Model):
     is_superuser = models.BooleanField()
-    groups = models.ManyToManyField(Group)
-    user_permissions = models.ManyToManyField(Permission)
+    groups = models.ManyToManyField[Group, User_groups](Group)
+    user_permissions = models.ManyToManyField[Permission, User_permissions](Permission)
 
     def get_user_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...
     def get_group_permissions(self, obj: _AnyUser | None = ...) -> set[str]: ...

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

@@ -1,5 +1,5 @@
 from collections.abc import Iterable
-from typing import Any, NamedTuple, TypeVar
+from typing import Any, Generic, NamedTuple, TypeVar, type_check_only
 
 from django.contrib.gis import forms
 from django.contrib.gis.geos import (
@@ -23,18 +23,66 @@ _ST = TypeVar("_ST")
 # __get__ return type
 _GT = TypeVar("_GT")
 
+_ST_PointField = TypeVar("_ST_PointField", default=Point | Combinable)
+_GT_PointField = TypeVar("_GT_PointField", default=Point)
+_Form_PointField = TypeVar("_Form_PointField", bound=forms.PointField, default=forms.PointField)
+_Geom_PointField = TypeVar("_Geom_PointField", bound=Point, default=Point)
+
+_ST_LineStringField = TypeVar("_ST_LineStringField", default=LineString | Combinable)
+_GT_LineStringField = TypeVar("_GT_LineStringField", default=LineString)
+_Form_LineStringField = TypeVar("_Form_LineStringField", bound=forms.LineStringField, default=forms.LineStringField)
+_Geom_LineStringField = TypeVar("_Geom_LineStringField", bound=LineString, default=LineString)
+
+_ST_PolygonField = TypeVar("_ST_PolygonField", default=Polygon | Combinable)
+_GT_PolygonField = TypeVar("_GT_PolygonField", default=Polygon)
+_Form_PolygonField = TypeVar("_Form_PolygonField", bound=forms.PolygonField, default=forms.PolygonField)
+_Geom_PolygonField = TypeVar("_Geom_PolygonField", bound=Polygon, default=Polygon)
+
+_ST_MultiPointField = TypeVar("_ST_MultiPointField", default=MultiPoint | Combinable)
+_GT_MultiPointField = TypeVar("_GT_MultiPointField", default=MultiPoint)
+_Form_MultiPointField = TypeVar("_Form_MultiPointField", bound=forms.MultiPointField, default=forms.MultiPointField)
+_Geom_MultiPointField = TypeVar("_Geom_MultiPointField", bound=MultiPoint, default=MultiPoint)
+
+_ST_MultiLineStringField = TypeVar("_ST_MultiLineStringField", default=MultiLineString | Combinable)
+_GT_MultiLineStringField = TypeVar("_GT_MultiLineStringField", default=MultiLineString)
+_Form_MultiLineStringField = TypeVar(
+    "_Form_MultiLineStringField", bound=forms.MultiLineStringField, default=forms.MultiLineStringField
+)
+_Geom_MultiLineStringField = TypeVar("_Geom_MultiLineStringField", bound=MultiLineString, default=MultiLineString)
+
+_ST_MultiPolygonField = TypeVar("_ST_MultiPolygonField", default=MultiPolygon | Combinable)
+_GT_MultiPolygonField = TypeVar("_GT_MultiPolygonField", default=MultiPolygon)
+_Form_MultiPolygonField = TypeVar(
+    "_Form_MultiPolygonField", bound=forms.MultiPolygonField, default=forms.MultiPolygonField
+)
+_Geom_MultiPolygonField = TypeVar("_Geom_MultiPolygonField", bound=MultiPolygon, default=MultiPolygon)
+
+_ST_GeometryCollectionField = TypeVar("_ST_GeometryCollectionField", default=GeometryCollection | Combinable)
+_GT_GeometryCollectionField = TypeVar("_GT_GeometryCollectionField", default=GeometryCollection)
+_Form_GeometryCollectionField = TypeVar(
+    "_Form_GeometryCollectionField", bound=forms.GeometryCollectionField, default=forms.GeometryCollectionField
+)
+_Geom_GeometryCollectionField = TypeVar(
+    "_Geom_GeometryCollectionField", bound=GeometryCollection, default=GeometryCollection
+)
+
+_Form_ClassT = TypeVar("_Form_ClassT", bound=forms.GeometryField)
+_GEOM_ClassT = TypeVar("_GEOM_ClassT", bound=GEOSGeometry)
+
 class SRIDCacheEntry(NamedTuple):
     units: Any
     units_name: str
     spheroid: str
     geodetic: bool
 
 def get_srid_info(srid: int, connection: Any) -> SRIDCacheEntry: ...
+@type_check_only
+class SpatialClassField(Generic[_Form_ClassT, _GEOM_ClassT]):
+    form_class: type[_Form_ClassT]
+    geom_class: type[_GEOM_ClassT] | None
 
-class BaseSpatialField(Field[_ST, _GT]):
-    form_class: type[forms.GeometryField]
+class BaseSpatialField(Field[_ST, _GT], SpatialClassField[_Form_ClassT, _GEOM_ClassT]):
     geom_type: str
-    geom_class: type[GEOSGeometry] | None
     geography: bool
     spatial_index: bool
     srid: int
@@ -52,7 +100,7 @@ class BaseSpatialField(Field[_ST, _GT]):
         null: bool = ...,
         db_index: bool = ...,
         default: Any = ...,
-        db_default: type[NOT_PROVIDED] | Expression | _ST = ...,
+        db_default: type[NOT_PROVIDED] | Expression | _ST = ...,  # pyright: ignore[reportInvalidTypeVarUse]
         editable: bool = ...,
         auto_created: bool = ...,
         serialize: bool = ...,
@@ -78,7 +126,7 @@ class BaseSpatialField(Field[_ST, _GT]):
     def get_raster_prep_value(self, value: Any, is_candidate: Any) -> Any: ...
     def get_prep_value(self, value: Any) -> Any: ...
 
-class GeometryField(BaseSpatialField[_ST, _GT]):
+class GeometryField(BaseSpatialField[_ST, _GT, _Form_ClassT, _GEOM_ClassT]):
     dim: int
     def __init__(
         self,
@@ -98,7 +146,7 @@ class GeometryField(BaseSpatialField[_ST, _GT]):
         null: bool = ...,
         db_index: bool = ...,
         default: Any = ...,
-        db_default: type[NOT_PROVIDED] | Expression | _ST = ...,
+        db_default: type[NOT_PROVIDED] | Expression | _ST = ...,  # pyright: ignore[reportInvalidTypeVarUse]
         editable: bool = ...,
         auto_created: bool = ...,
         serialize: bool = ...,
@@ -122,62 +170,58 @@ class GeometryField(BaseSpatialField[_ST, _GT]):
         **kwargs: Any,
     ) -> forms.GeometryField: ...
 
-class PointField(GeometryField[_ST, _GT]):
+class PointField(GeometryField[_ST_PointField, _GT_PointField, _Form_PointField, _Geom_PointField]):
     _pyi_private_set_type: Point | Combinable
     _pyi_private_get_type: Point
     _pyi_lookup_exact_type: Point
 
-    geom_class: type[Point]
-    form_class: type[forms.PointField]
-
-class LineStringField(GeometryField[_ST, _GT]):
+class LineStringField(
+    GeometryField[_ST_LineStringField, _GT_LineStringField, _Form_LineStringField, _Geom_LineStringField]
+):
     _pyi_private_set_type: LineString | Combinable
     _pyi_private_get_type: LineString
     _pyi_lookup_exact_type: LineString
 
-    geom_class: type[LineString]
-    form_class: type[forms.LineStringField]
-
-class PolygonField(GeometryField[_ST, _GT]):
+class PolygonField(GeometryField[_ST_PolygonField, _GT_PolygonField, _Form_PolygonField, _Geom_PolygonField]):
     _pyi_private_set_type: Polygon | Combinable
     _pyi_private_get_type: Polygon
     _pyi_lookup_exact_type: Polygon
 
-    geom_class: type[Polygon]
-    form_class: type[forms.PolygonField]
-
-class MultiPointField(GeometryField[_ST, _GT]):
+class MultiPointField(
+    GeometryField[_ST_MultiPointField, _GT_MultiPointField, _Form_MultiPointField, _Geom_MultiPointField]
+):
     _pyi_private_set_type: MultiPoint | Combinable
     _pyi_private_get_type: MultiPoint
     _pyi_lookup_exact_type: MultiPoint
 
-    geom_class: type[MultiPoint]
-    form_class: type[forms.MultiPointField]
-
-class MultiLineStringField(GeometryField[_ST, _GT]):
+class MultiLineStringField(
+    GeometryField[
+        _ST_MultiLineStringField, _GT_MultiLineStringField, _Form_MultiLineStringField, _Geom_MultiLineStringField
+    ]
+):
     _pyi_private_set_type: MultiLineString | Combinable
     _pyi_private_get_type: MultiLineString
     _pyi_lookup_exact_type: MultiLineString
 
-    geom_class: type[MultiLineString]
-    form_class: type[forms.MultiLineStringField]
-
-class MultiPolygonField(GeometryField[_ST, _GT]):
+class MultiPolygonField(
+    GeometryField[_ST_MultiPolygonField, _GT_MultiPolygonField, _Form_MultiPolygonField, _Geom_MultiPolygonField]
+):
     _pyi_private_set_type: MultiPolygon | Combinable
     _pyi_private_get_type: MultiPolygon
     _pyi_lookup_exact_type: MultiPolygon
 
-    geom_class: type[MultiPolygon]
-    form_class: type[forms.MultiPolygonField]
-
-class GeometryCollectionField(GeometryField[_ST, _GT]):
+class GeometryCollectionField(
+    GeometryField[
+        _ST_GeometryCollectionField,
+        _GT_GeometryCollectionField,
+        _Form_GeometryCollectionField,
+        _Geom_GeometryCollectionField,
+    ]
+):
     _pyi_private_set_type: GeometryCollection | Combinable
     _pyi_private_get_type: GeometryCollection
     _pyi_lookup_exact_type: GeometryCollection
 
-    geom_class: type[GeometryCollection]
-    form_class: type[forms.GeometryCollectionField]
-
 class ExtentField(Field):
     def get_internal_type(self) -> Any: ...
 

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

@@ -230,7 +230,7 @@ class Field(RegisterLookupMixin, Generic[_ST, _GT]):
         validators: Iterable[validators._ValidatorCallable] = (),
         error_messages: _ErrorMessagesMapping | None = None,
         db_comment: str | None = None,
-        db_default: type[NOT_PROVIDED] | Expression | _ST = ...,
+        db_default: type[NOT_PROVIDED] | Expression | _ST = ...,  # pyright: ignore[reportInvalidTypeVarUse]
     ) -> None: ...
     def __set__(self, instance: Any, value: _ST) -> None: ...
     # class access

django-stubs/utils/ipv6.pyi

@@ -6,4 +6,4 @@ MAX_IPV6_ADDRESS_LENGTH: int
 def clean_ipv6_address(
     ip_str: Any, unpack_ipv4: bool = False, error_message: str = ..., max_length: int = 39
 ) -> str: ...
-def is_valid_ipv6_address(ip_addr: str | IPv6Address) -> bool: ...
+def is_valid_ipv6_address(ip_str: str | IPv6Address) -> bool: ...

scripts/stubtest/allowlist.txt

@@ -27,13 +27,6 @@ django.core.files.storage.default_storage
 django.contrib.admin.models.LogEntry_RelatedManager
 django.contrib.auth.models.Permission_RelatedManager
 
-# '<Model>_ManyRelatedManager' entries are plugin generated and these subclasses only exist
-# _locally/dynamically_ runtime -- Created via
-# 'django.db.models.fields.related_descriptors.create_forward_many_to_many_manager'
-django.contrib.auth.models.Group_ManyRelatedManager
-django.contrib.auth.models.Permission_ManyRelatedManager
-django.contrib.auth.models.User_ManyRelatedManager
-
 # BaseArchive abstract methods that take no argument, but typed with arguments to match the Archive and TarArchive Implementations
 django.utils.archive.BaseArchive.list
 django.utils.archive.BaseArchive.extract
@@ -458,8 +451,12 @@ django.contrib.auth.models.Group@AnnotatedWith
 django.contrib.auth.models.Permission@AnnotatedWith
 django.contrib.auth.models.PermissionsMixin@AnnotatedWith
 django.contrib.auth.models.User@AnnotatedWith
+django.contrib.auth.models.Group_permissions@AnnotatedWith
+django.contrib.auth.models.User_groups@AnnotatedWith
+django.contrib.auth.models.User_permissions@AnnotatedWith
 django.contrib.contenttypes.models.ContentType@AnnotatedWith
 django.contrib.flatpages.models.FlatPage@AnnotatedWith
+django.contrib.flatpages.models.FlatPage_sites@AnnotatedWith
 django.contrib.gis.db.backends.oracle.models.OracleGeometryColumns@AnnotatedWith
 django.contrib.gis.db.backends.oracle.models.OracleSpatialRefSys@AnnotatedWith
 django.contrib.gis.db.backends.postgis.models.PostGISGeometryColumns@AnnotatedWith

scripts/stubtest/allowlist_todo.txt

@@ -472,7 +472,6 @@ django.contrib.sessions.models.SessionManager.__slotnames__
 django.contrib.sitemaps.views.SitemapIndexItem
 django.contrib.sites.admin.SiteAdmin
 django.contrib.sites.models.Site.domain
-django.contrib.sites.models.Site.flatpage_set
 django.contrib.sites.models.Site.id
 django.contrib.sites.models.Site.name
 django.contrib.sites.models.SiteManager.__slotnames__

tests/assert_type/contrib/admin/test_admin_models.py

@@ -0,0 +1,20 @@
+from datetime import datetime
+from typing import Optional
+
+from django.contrib.admin.models import LogEntry, LogEntryManager
+from django.contrib.auth.models import AbstractUser
+from django.contrib.contenttypes.models import ContentType
+from typing_extensions import assert_type
+
+log_entry = LogEntry()
+assert_type(log_entry.id, int)
+assert_type(log_entry.pk, int)
+assert_type(log_entry.action_time, datetime)
+assert_type(log_entry.user, AbstractUser)
+assert_type(log_entry.content_type, Optional[ContentType])
+assert_type(log_entry.content_type_id, Optional[int])
+assert_type(log_entry.object_id, Optional[str])
+assert_type(log_entry.object_repr, str)
+assert_type(log_entry.action_flag, int)
+assert_type(log_entry.change_message, str)
+assert_type(LogEntry.objects, LogEntryManager)

tests/assert_type/contrib/auth/test_auth_models.py

@@ -0,0 +1,51 @@
+from datetime import datetime
+from typing import Optional
+
+from django.contrib.auth.models import Group, Group_permissions, Permission, User, User_groups, User_permissions
+from django.contrib.contenttypes.models import ContentType
+from django.db.models import Manager
+from typing_extensions import assert_type
+
+user = User()
+assert_type(user.id, int)
+assert_type(user.pk, int)
+assert_type(user.password, str)
+assert_type(user.last_login, Optional[datetime])
+assert_type(user.is_active, bool)
+assert_type(user.username, str)
+assert_type(user.first_name, str)
+assert_type(user.last_name, str)
+assert_type(user.email, str)
+assert_type(user.is_staff, bool)
+assert_type(user.is_active, bool)
+assert_type(user.date_joined, datetime)
+assert_type(user.groups.get(), Group)
+assert_type(user.groups.through, type[User_groups])
+assert_type(user.user_permissions.get(), Permission)
+assert_type(user.user_permissions.through, type[User_permissions])
+
+group = Group()
+assert_type(group.id, int)
+assert_type(group.pk, int)
+assert_type(group.name, str)
+assert_type(group.permissions.get(), Permission)
+assert_type(group.permissions.through, type[Group_permissions])
+assert_type(Group.permissions.through, type[Group_permissions])
+assert_type(Group.permissions.through.objects, Manager[Group_permissions])
+
+group_permissions = Group.permissions.through.objects.get()
+assert_type(group_permissions.id, int)
+assert_type(group_permissions.pk, int)
+assert_type(group_permissions.group, Group)
+assert_type(group_permissions.group_id, int)
+assert_type(group_permissions.permission, Permission)
+assert_type(group_permissions.permission_id, int)
+
+permission = Permission()
+assert_type(permission.id, int)
+assert_type(permission.pk, int)
+assert_type(permission.name, str)
+assert_type(permission.content_type, ContentType)
+assert_type(permission.content_type_id, int)
+assert_type(permission.group_set.get(), Group)
+assert_type(permission.group_set.through.objects.get(), Group_permissions)