feat: Typehint inbuilt models and fields

Author: FallenDeity

django-stubs/contrib/admin/models.pyi

@@ -1,9 +1,12 @@
 from typing import Any, ClassVar, Literal, overload
 from uuid import UUID
 
+from django.contrib.auth.models import AbstractUser
+from django.contrib.contenttypes.models import ContentType
 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 typing_extensions import deprecated
 
 ADDITION: int
@@ -44,10 +47,14 @@ class LogEntryManager(models.Manager[LogEntry]):
     ) -> list[LogEntry]: ...
 
 class LogEntry(models.Model):
+    id: models.AutoField
+    pk: models.AutoField
     action_time: models.DateTimeField
-    user: models.ForeignKey
-    content_type: models.ForeignKey
-    object_id: models.TextField
+    user: models.ForeignKey[AbstractUser | Combinable, AbstractUser]
+    user_id: Any
+    content_type: models.ForeignKey[ContentType | Combinable | None, ContentType | None]
+    content_type_id: int | None
+    object_id: models.TextField[str | int | Combinable | None, str | None]
     object_repr: models.CharField
     action_flag: models.PositiveSmallIntegerField
     change_message: models.TextField

django-stubs/contrib/auth/base_user.pyi

@@ -1,4 +1,5 @@
 from collections.abc import Iterable
+from datetime import date, datetime
 from typing import Any, ClassVar, Literal, TypeVar, overload
 
 from django.db import models
@@ -19,7 +20,7 @@ class AbstractBaseUser(models.Model):
     REQUIRED_FIELDS: ClassVar[list[str]]
 
     password = models.CharField(max_length=128)
-    last_login = models.DateTimeField(blank=True, null=True)
+    last_login = models.DateTimeField[str | datetime | date | Combinable, datetime | None](blank=True, null=True)
     is_active: bool | BooleanField[bool | Combinable, bool]
 
     def get_username(self) -> str: ...

django-stubs/contrib/auth/models.pyi

@@ -1,5 +1,5 @@
 from collections.abc import Iterable
-from typing import Any, ClassVar, Literal, TypeVar
+from typing import Any, ClassVar, Literal, TypeVar, type_check_only
 
 from django.contrib.auth.base_user import AbstractBaseUser as AbstractBaseUser
 from django.contrib.auth.base_user import BaseUserManager as BaseUserManager
@@ -8,6 +8,7 @@ from django.contrib.contenttypes.models import ContentType
 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.manager import EmptyManager
 from django.utils.functional import _StrOrPromise
 from typing_extensions import Self, TypeAlias
@@ -20,22 +21,40 @@ class PermissionManager(models.Manager[Permission]):
     def get_by_natural_key(self, codename: str, app_label: str, model: str) -> Permission: ...
 
 class Permission(models.Model):
-    content_type_id: int
     objects: ClassVar[PermissionManager]
 
+    id: models.AutoField
+    pk: models.AutoField
     name = models.CharField(max_length=255)
-    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
+    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]
     def natural_key(self) -> tuple[str, str, str]: ...
 
 class GroupManager(models.Manager[Group]):
     def get_by_natural_key(self, name: str) -> Group: ...
 
+# 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 'Group' and 'Permission'.
+@type_check_only
+class Group_permissions(models.Model):
+    objects: ClassVar[models.Manager[Self]]
+
+    id: models.AutoField
+    pk: models.AutoField
+    group: models.ForeignKey[Group | Combinable, Group]
+    group_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)
+    permissions = models.ManyToManyField[Permission, Group_permissions](Permission)
     def natural_key(self) -> tuple[str]: ...
 
 _T = TypeVar("_T", bound=Model)
@@ -90,7 +109,9 @@ class AbstractUser(AbstractBaseUser, PermissionsMixin):
         self, subject: _StrOrPromise, message: _StrOrPromise, from_email: str = ..., **kwargs: Any
     ) -> None: ...
 
-class User(AbstractUser): ...
+class User(AbstractUser):
+    id: models.AutoField
+    pk: models.AutoField
 
 class AnonymousUser:
     id: None

django-stubs/contrib/contenttypes/models.pyi

@@ -1,7 +1,10 @@
 from typing import Any, ClassVar
 
+from django.contrib.admin.models import LogEntry
+from django.contrib.auth.models import Permission
 from django.db import models
 from django.db.models.base import Model
+from django.db.models.fields.related_descriptors import ReverseManyToOneDescriptor
 from django.db.models.query import QuerySet
 
 class ContentTypeManager(models.Manager[ContentType]):
@@ -12,13 +15,16 @@ class ContentTypeManager(models.Manager[ContentType]):
     def clear_cache(self) -> None: ...
 
 class ContentType(models.Model):
-    id: int
+    id: models.AutoField
+    pk: models.AutoField
     app_label = models.CharField(max_length=100)
     model = models.CharField(max_length=100)
+    logentry_set: ReverseManyToOneDescriptor[LogEntry]
+    permission_set: ReverseManyToOneDescriptor[Permission]
     objects: ClassVar[ContentTypeManager]
     @property
     def name(self) -> str: ...
     def model_class(self) -> type[Model] | None: ...
     def get_object_for_this_type(self, **kwargs: Any) -> Model: ...
-    def get_all_objects_for_this_type(self, **kwargs: Any) -> QuerySet: ...
+    def get_all_objects_for_this_type(self, **kwargs: Any) -> QuerySet[Model]: ...
     def natural_key(self) -> tuple[str, str]: ...

django-stubs/contrib/flatpages/models.pyi

@@ -1,12 +1,31 @@
+from typing import ClassVar, type_check_only
+
 from django.contrib.sites.models import Site
 from django.db import models
+from django.db.models.expressions import Combinable
+from typing_extensions import Self
+
+# 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 'FlatPage' and 'Site'.
+@type_check_only
+class FlatPage_sites(models.Model):
+    objects: ClassVar[models.Manager[Self]]
+
+    id: models.AutoField
+    pk: models.AutoField
+    site: models.ForeignKey[Site | Combinable, Site]
+    site_id: int
+    flatpage: models.ForeignKey[FlatPage | Combinable, FlatPage]
+    flatpage_id: int
 
 class FlatPage(models.Model):
+    id: models.AutoField
+    pk: models.AutoField
     url: models.CharField
     title: models.CharField
     content: models.TextField
     enable_comments: models.BooleanField
     template_name: models.CharField
     registration_required: models.BooleanField
-    sites: models.ManyToManyField[Site, Site]
+    sites: models.ManyToManyField[Site, FlatPage_sites]
     def get_absolute_url(self) -> str: ...

django-stubs/contrib/redirects/models.pyi

@@ -1,6 +1,11 @@
+from django.contrib.sites.models import Site
 from django.db import models
+from django.db.models.expressions import Combinable
 
 class Redirect(models.Model):
-    site: models.ForeignKey
+    id: models.AutoField
+    pk: models.AutoField
+    site: models.ForeignKey[Site | Combinable, Site]
+    site_id: int
     old_path: models.CharField
     new_path: models.CharField

django-stubs/contrib/sessions/base_session.pyi

@@ -3,6 +3,7 @@ from typing import Any, ClassVar, TypeVar
 
 from django.contrib.sessions.backends.base import SessionBase
 from django.db import models
+from django.db.models.expressions import Combinable
 from typing_extensions import Self
 
 _T = TypeVar("_T", bound=AbstractBaseSession)
@@ -12,7 +13,8 @@ class BaseSessionManager(models.Manager[_T]):
     def save(self, session_key: str, session_dict: dict[str, Any], expire_date: datetime) -> _T: ...
 
 class AbstractBaseSession(models.Model):
-    session_key = models.CharField(primary_key=True)
+    pk: models.CharField[str | int | Combinable | None, str]
+    session_key = models.CharField[str | int | Combinable | None, str](primary_key=True)
     session_data = models.TextField()
     expire_date = models.DateTimeField()
     objects: ClassVar[BaseSessionManager[Self]]

django-stubs/contrib/sessions/models.pyi

@@ -1,8 +1,11 @@
-from typing import TypeVar
+from typing import ClassVar, TypeVar
 
 from django.contrib.sessions.base_session import AbstractBaseSession, BaseSessionManager
+from typing_extensions import Self
 
 _T = TypeVar("_T", bound=Session)
 
 class SessionManager(BaseSessionManager[_T]): ...
-class Session(AbstractBaseSession): ...
+
+class Session(AbstractBaseSession):
+    objects: ClassVar[SessionManager[Self]]  # type: ignore[assignment]

django-stubs/contrib/sites/models.pyi

@@ -1,6 +1,9 @@
 from typing import Any, ClassVar
 
+from django.contrib.flatpages.models import FlatPage, FlatPage_sites
+from django.contrib.redirects.models import Redirect
 from django.db import models
+from django.db.models.fields.related_descriptors import ManyToManyDescriptor, ReverseManyToOneDescriptor
 from django.http.request import HttpRequest
 
 SITE_CACHE: Any
@@ -13,8 +16,12 @@ class SiteManager(models.Manager[Site]):
 class Site(models.Model):
     objects: ClassVar[SiteManager]
 
+    id: models.AutoField
+    pk: models.AutoField
     domain = models.CharField(max_length=100)
     name = models.CharField(max_length=50)
+    flatpage_set: ManyToManyDescriptor[FlatPage, FlatPage_sites]
+    redirect_set: ReverseManyToOneDescriptor[Redirect]
     def natural_key(self) -> tuple[str]: ...
 
 def clear_site_cache(sender: type[Site], **kwargs: Any) -> None: ...