Add lots of missing argument & return type hints (#1204)

* Add lots of missing argument & return type hints

Discovered by setting mypy options disallow_untyped_defs, disallow_incomplete_defs.

* Sequence -> List

* Fixes from review

* Drop ordering_field

* Revert ModelBackend.with_perm

* typing_extensions.TypedDict instead

* bla

* Remove private method _get_lines_from_file

* A few additions

* Hints for BaseSpatialFeatures

Author: intgr

django-stubs/conf/global_settings.pyi

@@ -83,7 +83,7 @@ DATABASES: Dict[str, Dict[str, Any]] = ...
 
 # Classes used to implement DB routing behavior.
 class Router(Protocol):
-    def allow_migrate(self, db, app_label, **hints): ...
+    def allow_migrate(self, db: str, app_label: str, **hints: Any) -> Optional[bool]: ...
 
 DATABASE_ROUTERS: List[Union[str, Router]] = ...
 

django-stubs/contrib/admin/checks.pyi

@@ -1,21 +1,21 @@
-from typing import Any, Optional, Sequence
+from typing import Any, List, Optional, Sequence
 
 from django.apps.config import AppConfig
 from django.contrib.admin.options import BaseModelAdmin
 from django.core.checks.messages import CheckMessage, Error
 
-def check_admin_app(app_configs: Optional[Sequence[AppConfig]], **kwargs: Any) -> Sequence[CheckMessage]: ...
-def check_dependencies(**kwargs: Any) -> Sequence[CheckMessage]: ...
+def check_admin_app(app_configs: Optional[Sequence[AppConfig]], **kwargs: Any) -> List[CheckMessage]: ...
+def check_dependencies(**kwargs: Any) -> List[CheckMessage]: ...
 
 class BaseModelAdminChecks:
-    def check(self, admin_obj: BaseModelAdmin, **kwargs: Any) -> Sequence[CheckMessage]: ...
+    def check(self, admin_obj: BaseModelAdmin, **kwargs: Any) -> List[CheckMessage]: ...
 
 class ModelAdminChecks(BaseModelAdminChecks):
-    def check(self, admin_obj: BaseModelAdmin, **kwargs: Any) -> Sequence[CheckMessage]: ...
+    def check(self, admin_obj: BaseModelAdmin, **kwargs: Any) -> List[CheckMessage]: ...
 
 class InlineModelAdminChecks(BaseModelAdminChecks):
-    def check(self, inline_obj: BaseModelAdmin, **kwargs: Any) -> Sequence[CheckMessage]: ...  # type: ignore
+    def check(self, inline_obj: BaseModelAdmin, **kwargs: Any) -> List[CheckMessage]: ...  # type: ignore
 
-def must_be(type: Any, option: Any, obj: Any, id: Any): ...
-def must_inherit_from(parent: Any, option: Any, obj: Any, id: Any): ...
-def refer_to_missing_field(field: Any, option: Any, obj: Any, id: Any): ...
+def must_be(type: Any, option: Any, obj: Any, id: Any) -> List[CheckMessage]: ...
+def must_inherit_from(parent: Any, option: Any, obj: Any, id: Any) -> List[CheckMessage]: ...
+def refer_to_missing_field(field: Any, option: Any, obj: Any, id: Any) -> List[CheckMessage]: ...

django-stubs/contrib/admin/helpers.pyi

@@ -4,6 +4,7 @@ from django import forms
 from django.contrib.admin.options import ModelAdmin
 from django.db.models import Model
 from django.db.models.fields import AutoField
+from django.forms import BaseForm
 from django.forms.boundfield import BoundField
 from django.forms.models import ModelForm
 from django.forms.utils import ErrorDict, ErrorList
@@ -143,7 +144,7 @@ class InlineAdminFormSet:
     def fields(self) -> Iterator[Dict[str, Union[Dict[str, bool], bool, Widget, str]]]: ...
     def inline_formset_data(self) -> str: ...
     @property
-    def forms(self): ...
+    def forms(self) -> List[BaseForm]: ...
     @property
     def non_form_errors(self) -> Callable[[], ErrorList]: ...
     @property
@@ -170,7 +171,6 @@ class InlineAdminForm(AdminForm):
     def pk_field(self) -> AdminField: ...
     def fk_field(self) -> AdminField: ...
     def deletion_field(self) -> AdminField: ...
-    def ordering_field(self): ...
 
 class InlineFieldset(Fieldset):
     formset: Any = ...

django-stubs/contrib/admin/options.pyi

@@ -34,7 +34,13 @@ from django.forms.fields import Field as FormField
 from django.forms.fields import TypedChoiceField
 from django.forms.forms import BaseForm
 from django.forms.formsets import BaseFormSet
-from django.forms.models import BaseInlineFormSet, ModelChoiceField, ModelMultipleChoiceField
+from django.forms.models import (
+    BaseInlineFormSet,
+    BaseModelFormSet,
+    ModelChoiceField,
+    ModelForm,
+    ModelMultipleChoiceField,
+)
 from django.forms.widgets import Media
 from django.http.request import HttpRequest
 from django.http.response import HttpResponse, HttpResponseRedirect, JsonResponse
@@ -191,8 +197,10 @@ class ModelAdmin(BaseModelAdmin[_ModelT]):
     def get_object(
         self, request: HttpRequest, object_id: str, from_field: Optional[str] = ...
     ) -> Optional[_ModelT]: ...
-    def get_changelist_form(self, request: Any, **kwargs: Any): ...
-    def get_changelist_formset(self, request: Any, **kwargs: Any): ...
+    def get_changelist_form(self, request: Any, **kwargs: Any) -> Type[ModelForm[_ModelT]]: ...
+    def get_changelist_formset(
+        self, request: Any, **kwargs: Any
+    ) -> Type[BaseModelFormSet[_ModelT, ModelForm[_ModelT]]]: ...
     def get_formsets_with_inlines(self, request: HttpRequest, obj: Optional[_ModelT] = ...) -> Iterator[Any]: ...
     def get_paginator(
         self,

django-stubs/contrib/admin/utils.pyi

@@ -14,7 +14,7 @@ from django.forms.forms import BaseForm
 from django.forms.formsets import BaseFormSet
 from django.http.request import HttpRequest
 from django.utils.datastructures import _IndexableCollection
-from typing_extensions import Literal
+from typing_extensions import Literal, TypedDict
 
 class FieldIsAForeignKeyColumnName(Exception): ...
 
@@ -45,7 +45,11 @@ class NestedObjects(Collector):
     def nested(self, format_callback: Callable = ...) -> List[Any]: ...
     def can_fast_delete(self, *args: Any, **kwargs: Any) -> bool: ...
 
-def model_format_dict(obj: Union[Model, Type[Model], QuerySet, Options[Model]]): ...
+class ModelFormatDict(TypedDict):
+    verbose_name: str
+    verbose_name_plural: str
+
+def model_format_dict(obj: Union[Model, Type[Model], QuerySet, Options[Model]]) -> ModelFormatDict: ...
 def model_ngettext(obj: Union[Options, QuerySet], n: Optional[int] = ...) -> str: ...
 def lookup_field(
     name: Union[Callable, str], obj: Model, model_admin: Optional[BaseModelAdmin] = ...

django-stubs/contrib/admindocs/utils.pyi

@@ -1,10 +1,12 @@
-from typing import Any, Callable, Dict, Optional, Tuple
+from typing import Any, Callable, Dict, List, Optional, Tuple
+
+from django.utils.safestring import SafeString
 
 docutils_is_available: bool
 
 def get_view_name(view_func: Callable) -> str: ...
 def parse_docstring(docstring: str) -> Tuple[str, str, Dict[str, str]]: ...
-def parse_rst(text: str, default_reference_context: Any, thing_being_parsed: Optional[Any] = ...): ...
+def parse_rst(text: str, default_reference_context: Any, thing_being_parsed: Optional[Any] = ...) -> SafeString: ...
 
 ROLES: Dict[str, str]
 
@@ -17,7 +19,7 @@ def default_reference_role(
     inliner: Any,
     options: Optional[Any] = ...,
     content: Optional[Any] = ...,
-): ...
+) -> Tuple[List[Any], List[Any]]: ...
 
 named_group_matcher: Any
 unnamed_group_matcher: Any

django-stubs/contrib/admindocs/views.pyi

@@ -16,7 +16,7 @@ class ModelIndexView(BaseAdminDocsView): ...
 class ModelDetailView(BaseAdminDocsView): ...
 class TemplateDetailView(BaseAdminDocsView): ...
 
-def get_return_data_type(func_name: Any): ...
+def get_return_data_type(func_name: Any) -> str: ...
 def get_readable_field_data_type(field: Union[Field, str]) -> str: ...
 def extract_views_from_urlpatterns(
     urlpatterns: Iterable[_AnyURL], base: str = ..., namespace: Optional[str] = ...

django-stubs/contrib/auth/backends.pyi

@@ -2,6 +2,7 @@ from typing import Any, Optional, Set, TypeVar, Union
 
 from django.contrib.auth.base_user import AbstractBaseUser
 from django.contrib.auth.models import AnonymousUser, Permission
+from django.db.models import QuerySet
 from django.db.models.base import Model
 from django.http.request import HttpRequest
 
@@ -33,7 +34,7 @@ class ModelBackend(BaseBackend):
         is_active: bool = ...,
         include_superusers: bool = ...,
         obj: Optional[Model] = ...,
-    ): ...
+    ) -> QuerySet[AbstractBaseUser]: ...
 
 class AllowAllUsersModelBackend(ModelBackend): ...
 

django-stubs/contrib/auth/models.pyi

@@ -5,6 +5,7 @@ from django.contrib.auth.base_user import BaseUserManager as BaseUserManager
 from django.contrib.auth.validators import UnicodeUsernameValidator
 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.manager import EmptyManager
 from typing_extensions import Literal
@@ -51,7 +52,7 @@ class UserManager(BaseUserManager[_T]):
         include_superusers: bool = ...,
         backend: Optional[str] = ...,
         obj: Optional[Model] = ...,
-    ): ...
+    ) -> QuerySet[_T]: ...
 
 class PermissionsMixin(models.Model):
     is_superuser = models.BooleanField()

django-stubs/contrib/auth/views.pyi

@@ -1,4 +1,4 @@
-from typing import Any, Optional, Set
+from typing import Any, Dict, Optional, Set
 
 from django.contrib.auth.base_user import AbstractBaseUser
 from django.contrib.auth.forms import AuthenticationForm
@@ -35,7 +35,7 @@ def redirect_to_login(
 
 class PasswordContextMixin:
     extra_context: Any = ...
-    def get_context_data(self, **kwargs: Any): ...
+    def get_context_data(self, **kwargs: Any) -> Dict[str, Any]: ...
 
 class PasswordResetView(PasswordContextMixin, FormView):
     email_template_name: str = ...