feat: add stubs for django-polymorphic

Author: huynguyengl99

stubs/django-polymorphic/@tests/django_settings.py

@@ -0,0 +1,12 @@
+SECRET_KEY = "1"
+
+INSTALLED_APPS = (
+    "django.contrib.contenttypes",
+    "django.contrib.sites",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.admin.apps.SimpleAdminConfig",
+    "django.contrib.staticfiles",
+    "django.contrib.auth",
+    "polymorphic",
+)

stubs/django-polymorphic/@tests/stubtest_allowlist.txt

@@ -0,0 +1,45 @@
+# Admin __init__ methods with *args
+polymorphic.admin.PolymorphicChildModelAdmin.__init__
+polymorphic.admin.PolymorphicParentModelAdmin.__init__
+polymorphic.admin.childadmin.PolymorphicChildModelAdmin.__init__
+polymorphic.admin.parentadmin.PolymorphicParentModelAdmin.__init__
+
+# Admin get_form - stub includes change parameter for compatibility with Django base class
+polymorphic.admin.PolymorphicChildModelAdmin.get_form
+polymorphic.admin.childadmin.PolymorphicChildModelAdmin.get_form
+
+# QuerySet methods - version-specific Django parameters
+polymorphic.query.PolymorphicQuerySet.__repr__
+polymorphic.query.PolymorphicQuerySet.bulk_create
+polymorphic.query.PolymorphicQuerySet._p_list_class.__repr__
+polymorphic.managers.PolymorphicQuerySet.__repr__
+polymorphic.managers.PolymorphicQuerySet.bulk_create
+polymorphic.managers.PolymorphicQuerySet._p_list_class.__repr__
+
+# Model attributes - Django auto-generated
+polymorphic.models.PolymorphicModel.polymorphic_ctype_id
+
+# Type annotation helpers (not runtime classes)
+polymorphic.models.PolymorphicModel@AnnotatedWith
+
+# Optional dependencies - contrib modules may require additional packages
+polymorphic.contrib.extra_views
+
+# Template properties - read-only at runtime
+polymorphic.admin.PolymorphicChildModelAdmin.change_form_template
+polymorphic.admin.PolymorphicChildModelAdmin.delete_confirmation_template
+polymorphic.admin.PolymorphicChildModelAdmin.object_history_template
+polymorphic.admin.PolymorphicParentModelAdmin.change_list_template
+polymorphic.admin.childadmin.PolymorphicChildModelAdmin.change_form_template
+polymorphic.admin.childadmin.PolymorphicChildModelAdmin.delete_confirmation_template
+polymorphic.admin.childadmin.PolymorphicChildModelAdmin.object_history_template
+polymorphic.admin.parentadmin.PolymorphicParentModelAdmin.change_list_template
+
+# __all__ differences - stub uses list for easier editing
+polymorphic.admin.__all__
+polymorphic.formsets.__all__
+polymorphic.managers.__all__
+
+# Descriptor vs typed value - normal for stubs
+polymorphic.models.PolymorphicModel.objects
+polymorphic.models.PolymorphicModel.polymorphic_ctype

stubs/django-polymorphic/METADATA.toml

@@ -0,0 +1,7 @@
+version = "4.10.*"
+upstream_repository = "https://github.com/jazzband/django-polymorphic"
+requires = ["django-stubs"]
+
+[tool.stubtest]
+mypy_plugins = ["mypy_django_plugin.main"]
+mypy_plugins_config = {"django-stubs" = {"django_settings_module" = "@tests.django_settings"}}

stubs/django-polymorphic/polymorphic/__init__.pyi

@@ -0,0 +1,9 @@
+from typing import Final
+
+VERSION: Final[str]
+
+__title__: Final = "Django Polymorphic"
+__version__ = VERSION  # version synonym for backwards compatibility
+__author__: Final[str]
+__license__: Final = "BSD-3-Clause"
+__copyright__: Final[str]

stubs/django-polymorphic/polymorphic/admin/__init__.pyi

@@ -0,0 +1,31 @@
+from .childadmin import PolymorphicChildModelAdmin as PolymorphicChildModelAdmin
+from .filters import PolymorphicChildModelFilter as PolymorphicChildModelFilter
+from .forms import PolymorphicModelChoiceForm as PolymorphicModelChoiceForm
+from .generic import (
+    GenericPolymorphicInlineModelAdmin as GenericPolymorphicInlineModelAdmin,
+    GenericStackedPolymorphicInline as GenericStackedPolymorphicInline,
+)
+from .helpers import (
+    PolymorphicInlineAdminForm as PolymorphicInlineAdminForm,
+    PolymorphicInlineAdminFormSet as PolymorphicInlineAdminFormSet,
+    PolymorphicInlineSupportMixin as PolymorphicInlineSupportMixin,
+)
+from .inlines import (
+    PolymorphicInlineModelAdmin as PolymorphicInlineModelAdmin,
+    StackedPolymorphicInline as StackedPolymorphicInline,
+)
+from .parentadmin import PolymorphicParentModelAdmin as PolymorphicParentModelAdmin
+
+__all__ = [
+    "PolymorphicParentModelAdmin",
+    "PolymorphicChildModelAdmin",
+    "PolymorphicModelChoiceForm",
+    "PolymorphicChildModelFilter",
+    "PolymorphicInlineAdminForm",
+    "PolymorphicInlineAdminFormSet",
+    "PolymorphicInlineSupportMixin",
+    "PolymorphicInlineModelAdmin",
+    "StackedPolymorphicInline",
+    "GenericPolymorphicInlineModelAdmin",
+    "GenericStackedPolymorphicInline",
+]

stubs/django-polymorphic/polymorphic/admin/childadmin.pyi

@@ -0,0 +1,39 @@
+from collections.abc import Sequence
+from typing import Any, ClassVar
+
+from django.contrib import admin
+from django.db import models
+from django.forms import Form, ModelForm
+from django.http import HttpRequest, HttpResponse, HttpResponseRedirect
+
+class ParentAdminNotRegistered(RuntimeError): ...
+
+class PolymorphicChildModelAdmin(admin.ModelAdmin[Any]):
+    base_model: type[models.Model] | None
+    base_form: type[Form] | None
+    base_fieldsets: Sequence[tuple[str | None, dict[str, Any]]] | None
+    extra_fieldset_title: str
+    show_in_index: bool
+    change_form_template: ClassVar[list[str]]
+    delete_confirmation_template: ClassVar[list[str]]
+    object_history_template: ClassVar[list[str]]
+    def get_form(
+        self, request: HttpRequest, obj: Any | None = None, change: bool = False, **kwargs: Any
+    ) -> type[ModelForm[Any]]: ...
+    def get_model_perms(self, request: HttpRequest) -> dict[str, bool]: ...
+    def get_base_fieldsets(self, request: HttpRequest, obj: Any = None) -> list[tuple[str | None, dict[str, Any]]] | None: ...
+    def get_fieldsets(self, request: HttpRequest, obj: Any = None) -> list[tuple[str | None, dict[str, Any]]]: ...  # type: ignore[override]
+    def get_subclass_fields(self, request: HttpRequest, obj: Any = None) -> list[str]: ...
+    def response_post_save_add(self, request: HttpRequest, obj: Any) -> HttpResponseRedirect: ...
+    def response_post_save_change(self, request: HttpRequest, obj: Any) -> HttpResponseRedirect: ...
+    def render_change_form(
+        self,
+        request: HttpRequest,
+        context: dict[str, Any],
+        add: bool = False,
+        change: bool = False,
+        form_url: str = "",
+        obj: Any = None,
+    ) -> HttpResponse: ...
+    def delete_view(self, request: HttpRequest, object_id: str, context: dict[str, Any] | None = None) -> HttpResponse: ...
+    def history_view(self, request: HttpRequest, object_id: str, extra_context: dict[str, Any] | None = None) -> HttpResponse: ...

stubs/django-polymorphic/polymorphic/admin/filters.pyi

@@ -0,0 +1,12 @@
+from collections.abc import Iterable
+from typing import Any
+
+from django.contrib.admin import ModelAdmin, SimpleListFilter
+from django.db.models import QuerySet
+from django.http import HttpRequest
+
+class PolymorphicChildModelFilter(SimpleListFilter):
+    title: str
+    parameter_name: str
+    def lookups(self, request: HttpRequest, model_admin: ModelAdmin[Any]) -> Iterable[tuple[str, str]]: ...
+    def queryset(self, request: HttpRequest, queryset: QuerySet[Any]) -> QuerySet[Any]: ...

stubs/django-polymorphic/polymorphic/admin/forms.pyi

@@ -0,0 +1,8 @@
+from typing import Any
+
+from django import forms
+
+class PolymorphicModelChoiceForm(forms.Form):
+    type_label: str
+    ct_id: forms.ChoiceField
+    def __init__(self, *args: Any, **kwargs: Any) -> None: ...

stubs/django-polymorphic/polymorphic/admin/generic.pyi

@@ -0,0 +1,25 @@
+from typing import Any
+
+from django.contrib.contenttypes.admin import GenericInlineModelAdmin
+from django.contrib.contenttypes.models import ContentType
+from django.http import HttpRequest
+
+from ..formsets import BaseGenericPolymorphicInlineFormSet, GenericPolymorphicFormSetChild
+from .inlines import PolymorphicInlineModelAdmin
+
+class GenericPolymorphicInlineModelAdmin(PolymorphicInlineModelAdmin, GenericInlineModelAdmin):
+    formset: type[BaseGenericPolymorphicInlineFormSet]  # type: ignore[assignment]
+    def get_formset(self, request: HttpRequest, obj: Any = None, **kwargs: Any) -> type[BaseGenericPolymorphicInlineFormSet]: ...  # type: ignore[override]
+
+    class Child(PolymorphicInlineModelAdmin.Child):
+        formset_child: type[GenericPolymorphicFormSetChild]  # type: ignore[assignment]
+        ct_field: str
+        ct_fk_field: str
+        @property
+        def content_type(self) -> ContentType: ...
+        def get_formset_child(
+            self, request: HttpRequest, obj: Any = None, **kwargs: Any
+        ) -> GenericPolymorphicFormSetChild: ...  # type: ignore[override]
+
+class GenericStackedPolymorphicInline(GenericPolymorphicInlineModelAdmin):
+    template: str

stubs/django-polymorphic/polymorphic/admin/helpers.pyi

@@ -0,0 +1,25 @@
+from collections.abc import Iterator
+from typing import Any
+
+from django.contrib.admin.helpers import AdminField, InlineAdminForm, InlineAdminFormSet
+from django.http import HttpRequest
+
+class PolymorphicInlineAdminForm(InlineAdminForm):
+    def polymorphic_ctype_field(self) -> AdminField: ...
+    @property
+    def is_empty(self) -> bool: ...
+
+class PolymorphicInlineAdminFormSet(InlineAdminFormSet):
+    request: HttpRequest | None
+    obj: Any | None
+    def __init__(self, *args: Any, **kwargs: Any) -> None: ...
+    def __iter__(self) -> Iterator[PolymorphicInlineAdminForm]: ...
+    def get_child_fieldsets(self, child_inline: Any) -> list[tuple[str | None, dict[str, Any]]]: ...
+    def get_child_readonly_fields(self, child_inline: Any) -> list[str]: ...
+    def get_child_prepopulated_fields(self, child_inline: Any) -> dict[str, Any]: ...
+    def inline_formset_data(self) -> str: ...
+
+class PolymorphicInlineSupportMixin:
+    def get_inline_formsets(
+        self, request: HttpRequest, formsets: list[Any], inline_instances: list[Any], obj: Any = None, *args: Any, **kwargs: Any
+    ) -> list[InlineAdminFormSet]: ...