Large update (#909)

* Make module declaration precise.

* Make settings match real file.

* Replace `include` with import.

* Make types more specific.

* Replace `WSGIRequest` with `HttpRequest` where possible.

* Replace all `OrderedDict` occurrences with plain `Dict` (it is not used in Django 3.2 and later)

* Add fake datastructures for convenience: _PropertyDescriptor and _ListOrTuple now can live here. Added _IndexableCollection (often useful as alias for 'sequence or queryset')

* Actualize other datastructures.

* Rework MultiValueDict to reflect the fact that some methods can return empty list instead of value.

* Deprecate SafeText in favor of SafeString.

* Minor improvements to utils

* Disallow using str in TimeFormat and DateFormat, drop removed fmt `B`

* Do not let classproperty expect classmethod, make return value covariant.

* Sync with real file.

* Improve types for timezone.

* Sync deprecated, new and removed features in translation utils.

* Drop removed files, sync huge deprecations.

* Fix incompatible decorators (properties, contextmanagers)

* Rework pagination.

* Sync validators with real code. Add _ValidatorCallable for any external use (field validation etc.)

* Add shared type definitions (for fields of both forms and models). Actualize model fields. Mark keyword-only args explicitly in stubs (where code uses **kwargs). Disallow bytes for verbose_name.

* Make all checks return Sequence[CheckMessage] or subclass to be covariant.

* Add bidirectional references between backend.base and other files. Replace some Any's with specific types.

* Actualize db.migrations: remove removed methods, replace "None" annotations in wrong places, improve some wrong annotations.

* Actualize db.utils to match real file.

* Replace FileResponse and TemplateResponse with HttpResponse(Base) where needed: at least HttpResponseNotModified/HttpResponseRedirect can be returned instead of it, so annotation was wrong.

* Replace Any in forms where possible. Actualize class bases and method arguments.

* Improve typing of serializers.

* Actualize views, rename variable bound to Model to _M for consistency.

* Make types of file-related code consistent. Disallow using bytes as path, because many methods expect str-only paths. Make File inherit from IO[AnyStr] instead of IO[Any]: it makes impossible to instantiate file of union type, but allows precise types for some methods.

* Minor improvements: stop using None as annotation in wrong places, replace obvious Any's with precise types, actualize methods (missing/renamed/signature changed).

* Allow less specific containers, replace Any's with specific types.

* Improve types for requests and responses.

* Use AbstractBaseUser instead of User in auth.

* Use broader type for permission_required

* Use wider container types. Add 'type: ignore' to avoid issues with mypy.stubtest.

* Disallow using backend class as argument (it is passed to import_string).

* Add required methods to PasseordValidator.

* Allow using Path instance as argument.

* Actualize methods.

* Add 'type: ignore' to avoid issues with mypy.stubtest.

* Replace Any's with specific types and BaseForm with ModelForm.

* Actualize contrib.postgres

* Remove render_to_response, add 'get_absolute_url' to corresponding protocol.

* Actualize signers.

* Use precise types for handlers. Disallow str as stream type for LimitedStream.

* Exact types for ValidationError

* Replace wrong used Union with Sequence.

* Actualize static handlers.

* More specific types for admin. Fixes #874.

* Improve types and replace 'Tags' with str (it isn't Enum, so annotation was wrong).

* Replace Any with specific types, actualize signatures.

* Add async variants of handlers and clients. Use fake class to distinguish between request types in RequestFactory and AsyncRequestFactory.

* Fix signature, minor improvements.

* Actualize signatures and class names, replace Any with more specific types.

* Fix signature.

* Add some missing methods to Collector

* Combinable rarely returns Self type: almost always it's CombinedExpression.

* No Random in source anymore.

* Drop removed SimpleCol.

* Replace _OutputField with Field: nothing in docs about strings.

* Introduce reusable types, add missing methods. Remove strange types (probably created by stubgen). Remove RawQuery from Compiler: it obviously doesn't work with RawQuery.

* Use literal constants.

* Actualize base classes.

* Callable is not accepted by get_field.

* Add precise types.

* Use property and broader containers where possible. Add missing methods.

* Actualize indexes.

* More specific types for signals.

* Fix signatures, drop missing methods.

* Actualize window functions to match source.

* Actualize text functions, add missing methods, use type aliases for consistency.

* Add missing property decorators, methods and attributes. Use type aliases. Remove absent YearComparisonLookup and any SafeText references (they aren't related to lookups at all).

* Use bound TypeVar, mark all BuiltinLookup descendants as generic explicitly. Remove strange Union from Lookup.__init__

* Apply type alias, fix base class and argument name.

* Actualize BaseExpression methods.

* Fix imports.

* Add missing class and fix incompatible bases.

* Use same types in __init__ and attribute.

* OrderBy accepts F or Expression.

* Non-expressions are converted to Values.

* Add missing attributes.

* Add missing methods, fix 'None' argument type.

* Define properties where possible, remove 'None' argument annotations, remove inadequate type in make_immutable_fields_list.

* Remove absent QueryWrapper. Replace some Any with precise types.

* Fix wrong types and actualize signatures. Deny ManagerDescriptor.__get__ on model instances.

* Use more specific types.

* Arity can be None in subclasses.

* Reformat with black

* Make DeletionMixin generic.

* Fix wrong type variable in _RequestFactory.

* Fix variable name in signature.

* Disallow returning None from Form.clean()

* Allow again returning None from Form.clean

* Drop some unused imports.

* Add tests for MultiValueDict.

* Add tests for utils.timezone.

* Fix #834.

* Add more files to import_all test

* Allow None for `context_object_name`

* Fix CI

* Fix test to work on python 3.8

Author: sterliakov

django-stubs/apps/config.pyi

@@ -1,4 +1,5 @@
-from typing import Any, Dict, Iterator, Optional, Type
+import types
+from typing import Dict, Iterator, Optional, Type
 
 from django.apps.registry import Apps
 from django.db.models.base import Model
@@ -7,14 +8,14 @@ MODELS_MODULE_NAME: str
 
 class AppConfig:
     name: str = ...
-    module: Optional[Any] = ...
+    module: Optional[types.ModuleType] = ...
     apps: Optional[Apps] = ...
     label: str = ...
     verbose_name: str = ...
     path: str = ...
     models_module: Optional[str] = ...
     models: Dict[str, Type[Model]] = ...
-    def __init__(self, app_name: str, app_module: Optional[Any]) -> None: ...
+    def __init__(self, app_name: str, app_module: Optional[types.ModuleType]) -> None: ...
     @classmethod
     def create(cls, entry: str) -> AppConfig: ...
     def get_model(self, model_name: str, require_ready: bool = ...) -> Type[Model]: ...

django-stubs/conf/__init__.pyi

@@ -1,29 +1,37 @@
-from typing import Any
+from typing import Any, Optional
 
 from django.utils.functional import LazyObject
 
 # explicit dependency on standard settings to make it loaded
 from . import global_settings
 
 ENVIRONMENT_VARIABLE: str = ...
-DEFAULT_CONTENT_TYPE_DEPRECATED_MSG: str = ...
-FILE_CHARSET_DEPRECATED_MSG: str = ...
+PASSWORD_RESET_TIMEOUT_DAYS_DEPRECATED_MSG: str = ...
+DEFAULT_HASHING_ALGORITHM_DEPRECATED_MSG: str = ...
 
 # required for plugin to be able to distinguish this specific instance of LazySettings from others
 class _DjangoConfLazyObject(LazyObject):
     def __getattr__(self, item: Any) -> Any: ...
 
 class LazySettings(_DjangoConfLazyObject):
-    configured: bool
-    def configure(self, default_settings: Any = ..., **options: Any) -> Any: ...
+    @property
+    def configured(self) -> bool: ...
+    def configure(self, default_settings: Any = ..., **options: Any) -> None: ...
 
 settings: LazySettings = ...
 
 class Settings:
-    def __init__(self, settings_module: str): ...
+    def __init__(self, settings_module: str) -> None: ...
     def is_overridden(self, setting: str) -> bool: ...
 
-class UserSettingsHolder: ...
+class UserSettingsHolder:
+    SETTINGS_MODULE: Optional[Any] = ...
+    def __init__(self, default_settings: Any) -> None: ...
+    def __getattr__(self, name: str) -> Any: ...
+    def __setattr__(self, name: str, value: Any) -> None: ...
+    def __delattr__(self, name: str) -> None: ...
+    def is_overridden(self, setting: str) -> bool: ...
 
 class SettingsReference(str):
+    def __new__(self, value: Any, setting_name: str) -> SettingsReference: ...
     def __init__(self, value: str, setting_name: str) -> None: ...

django-stubs/conf/global_settings.pyi

@@ -68,15 +68,11 @@ USE_L10N: bool = ...
 # notifications and other various emails.
 MANAGERS = ADMINS
 
-# Default content type and charset to use for all HttpResponse objects, if a
+# Default charset to use for all HttpResponse objects, if a
 # MIME type isn't manually specified. These are used to construct the
 # Content-Type header.
-DEFAULT_CONTENT_TYPE: str = ...
 DEFAULT_CHARSET: str = ...
 
-# Encoding of files read from disk (template and initial SQL files).
-FILE_CHARSET: str = ...
-
 # Email address that error messages come from.
 SERVER_EMAIL: str = ...
 
@@ -136,7 +132,7 @@ APPEND_SLASH: bool = ...
 PREPEND_WWW: bool = ...
 
 # Override the server-derived value of SCRIPT_NAME
-FORCE_SCRIPT_NAME = None
+FORCE_SCRIPT_NAME: Optional[str] = ...
 
 # List of compiled regular expression objects representing User-Agent strings
 # that are not allowed to visit any page, systemwide. Use this for bad
@@ -148,7 +144,7 @@ FORCE_SCRIPT_NAME = None
 #         re.compile(r'^SiteSucker.*'),
 #         re.compile(r'^sohu-search'),
 #     ]
-DISALLOWED_USER_AGENTS: List[Pattern] = ...
+DISALLOWED_USER_AGENTS: List[Pattern[str]] = ...
 
 ABSOLUTE_URL_OVERRIDES: Dict[str, Any] = ...
 
@@ -162,7 +158,7 @@ ABSOLUTE_URL_OVERRIDES: Dict[str, Any] = ...
 #        re.compile(r'^/phpmyadmin/'),
 #        re.compile(r'\.(cgi|php|pl)$'),
 #    ]
-IGNORABLE_404_URLS: List[Pattern] = ...
+IGNORABLE_404_URLS: List[Pattern[str]] = ...
 
 # A secret key for this particular Django installation. Used in secret-key
 # hashing algorithms. Set this in your settings, or Django will complain
@@ -210,12 +206,12 @@ FILE_UPLOAD_TEMP_DIR: Optional[str] = ...
 
 # The numeric mode to set newly-uploaded files to. The value should be a mode
 # you'd pass directly to os.chmod; see https://docs.python.org/library/os.html#files-and-directories.
-FILE_UPLOAD_PERMISSIONS = None
+FILE_UPLOAD_PERMISSIONS: int = ...
 
 # The numeric mode to assign to newly-created directories, when uploading files.
 # The value should be a mode as you'd pass to os.chmod;
 # see https://docs.python.org/library/os.html#files-and-directories.
-FILE_UPLOAD_DIRECTORY_PERMISSIONS = None
+FILE_UPLOAD_DIRECTORY_PERMISSIONS: Optional[int] = ...
 
 # Python module path where user will place custom format definition.
 # The directory where this setting is pointing should contain subdirectories
@@ -330,43 +326,43 @@ MIDDLEWARE: List[str] = ...
 ############
 
 # Cache to store session data if using the cache session backend.
-SESSION_CACHE_ALIAS = "default"
+SESSION_CACHE_ALIAS: str = ...
 # Cookie name. This can be whatever you want.
-SESSION_COOKIE_NAME = "sessionid"
+SESSION_COOKIE_NAME: str = ...
 # Age of cookie, in seconds (default: 2 weeks).
-SESSION_COOKIE_AGE = 60 * 60 * 24 * 7 * 2
+SESSION_COOKIE_AGE: int = ...
 # A string like "example.com", or None for standard domain cookie.
 SESSION_COOKIE_DOMAIN: Optional[str] = ...
 # Whether the session cookie should be secure (https:// only).
-SESSION_COOKIE_SECURE = False
+SESSION_COOKIE_SECURE: bool = ...
 # The path of the session cookie.
-SESSION_COOKIE_PATH = "/"
+SESSION_COOKIE_PATH: str = ...
 # Whether to use the non-RFC standard httpOnly flag (IE, FF3+, others)
-SESSION_COOKIE_HTTPONLY = True
+SESSION_COOKIE_HTTPONLY: bool = ...
 # Whether to set the flag restricting cookie leaks on cross-site requests.
 # This can be 'Lax', 'Strict', or None to disable the flag.
 SESSION_COOKIE_SAMESITE: Optional[str] = ...
 # Whether to save the session data on every request.
-SESSION_SAVE_EVERY_REQUEST = False
+SESSION_SAVE_EVERY_REQUEST: bool = ...
 # Whether a user's session cookie expires when the Web browser is closed.
-SESSION_EXPIRE_AT_BROWSER_CLOSE = False
+SESSION_EXPIRE_AT_BROWSER_CLOSE: bool = ...
 # The module to store session data
-SESSION_ENGINE = "django.contrib.sessions.backends.db"
+SESSION_ENGINE: str = ...
 # Directory to store session files if using the file session module. If None,
 # the backend will use a sensible default.
 SESSION_FILE_PATH: Optional[str] = ...
 # class to serialize session data
-SESSION_SERIALIZER = "django.contrib.sessions.serializers.JSONSerializer"
+SESSION_SERIALIZER: str = ...
 
 #########
 # CACHE #
 #########
 
 # The cache backends to use.
 CACHES: Dict[str, Dict[str, Any]] = ...
-CACHE_MIDDLEWARE_KEY_PREFIX = ""
-CACHE_MIDDLEWARE_SECONDS = 600
-CACHE_MIDDLEWARE_ALIAS = "default"
+CACHE_MIDDLEWARE_KEY_PREFIX: str = ...
+CACHE_MIDDLEWARE_SECONDS: int = ...
+CACHE_MIDDLEWARE_ALIAS: str = ...
 
 ##################
 # AUTHENTICATION #
@@ -376,14 +372,14 @@ AUTH_USER_MODEL: str = ...
 
 AUTHENTICATION_BACKENDS: Sequence[str] = ...
 
-LOGIN_URL = "/accounts/login/"
+LOGIN_URL: str = ...
 
 LOGIN_REDIRECT_URL: str = ...
 
 LOGOUT_REDIRECT_URL: Optional[str] = ...
 
 # The number of days a password reset link is valid for
-PASSWORD_RESET_TIMEOUT_DAYS = 3
+PASSWORD_RESET_TIMEOUT_DAYS: int = ...
 
 # the first hasher in this list is the preferred algorithm.  any
 # password using different algorithms will be converted automatically
@@ -396,34 +392,34 @@ AUTH_PASSWORD_VALIDATORS: List[Dict[str, str]] = ...
 # SIGNING #
 ###########
 
-SIGNING_BACKEND = "django.core.signing.TimestampSigner"
+SIGNING_BACKEND: str = ...
 
 ########
 # CSRF #
 ########
 
 # Dotted path to callable to be used as view when a request is
 # rejected by the CSRF middleware.
-CSRF_FAILURE_VIEW = "django.views.csrf.csrf_failure"
+CSRF_FAILURE_VIEW: str = ...
 
 # Settings for CSRF cookie.
-CSRF_COOKIE_NAME = "csrftoken"
-CSRF_COOKIE_AGE = 60 * 60 * 24 * 7 * 52
-CSRF_COOKIE_DOMAIN = None
-CSRF_COOKIE_PATH = "/"
-CSRF_COOKIE_SECURE = False
-CSRF_COOKIE_HTTPONLY = False
+CSRF_COOKIE_NAME: str = ...
+CSRF_COOKIE_AGE: int = ...
+CSRF_COOKIE_DOMAIN: Optional[str] = ...
+CSRF_COOKIE_PATH: str = ...
+CSRF_COOKIE_SECURE: bool = ...
+CSRF_COOKIE_HTTPONLY: bool = ...
 CSRF_COOKIE_SAMESITE: Optional[str] = ...
-CSRF_HEADER_NAME = "HTTP_X_CSRFTOKEN"
+CSRF_HEADER_NAME: str = ...
 CSRF_TRUSTED_ORIGINS: List[str] = ...
-CSRF_USE_SESSIONS = False
+CSRF_USE_SESSIONS: bool = ...
 
 ############
 # MESSAGES #
 ############
 
 # Class to use as messages backend
-MESSAGE_STORAGE = "django.contrib.messages.storage.fallback.FallbackStorage"
+MESSAGE_STORAGE: str = ...
 
 # Default values of MESSAGE_LEVEL and MESSAGE_TAGS are defined within
 # django.contrib.messages to avoid imports in this settings file.
@@ -433,21 +429,21 @@ MESSAGE_STORAGE = "django.contrib.messages.storage.fallback.FallbackStorage"
 ###########
 
 # The callable to use to configure logging
-LOGGING_CONFIG = "logging.config.dictConfig"
+LOGGING_CONFIG: str = ...
 
 # Custom logging configuration.
 LOGGING: Dict[str, Any] = ...
 
 # Default exception reporter filter class used in case none has been
 # specifically assigned to the HttpRequest instance.
-DEFAULT_EXCEPTION_REPORTER_FILTER = "django.views.debug.SafeExceptionReporterFilter"
+DEFAULT_EXCEPTION_REPORTER_FILTER: str = ...
 
 ###########
 # TESTING #
 ###########
 
 # The name of the class to use to run the test suite
-TEST_RUNNER = "django.test.runner.DiscoverRunner"
+TEST_RUNNER: str = ...
 
 # Apps that don't need to be serialized at test database creation time
 # (only apps with migrations are to start with)
@@ -494,11 +490,11 @@ SILENCED_SYSTEM_CHECKS: List[str] = ...
 #######################
 # SECURITY MIDDLEWARE #
 #######################
-SECURE_BROWSER_XSS_FILTER = False
-SECURE_CONTENT_TYPE_NOSNIFF = False
-SECURE_HSTS_INCLUDE_SUBDOMAINS = False
-SECURE_HSTS_PRELOAD = False
-SECURE_HSTS_SECONDS = 0
+SECURE_BROWSER_XSS_FILTER: bool = ...
+SECURE_CONTENT_TYPE_NOSNIFF: bool = ...
+SECURE_HSTS_INCLUDE_SUBDOMAINS: bool = ...
+SECURE_HSTS_PRELOAD: bool = ...
+SECURE_HSTS_SECONDS: int = ...
 SECURE_REDIRECT_EXEMPT: List[str] = ...
-SECURE_SSL_HOST = None
-SECURE_SSL_REDIRECT = False
+SECURE_SSL_HOST: Optional[str] = ...
+SECURE_SSL_REDIRECT: bool = ...

django-stubs/conf/urls/__init__.pyi

@@ -3,6 +3,7 @@ from typing import Any, Callable, Dict, Optional, Sequence, Tuple, Union, overlo
 
 from django.http.response import HttpResponse, HttpResponseBase
 from django.urls import URLPattern, URLResolver
+from django.urls import include as include
 
 handler400: Union[str, Callable[..., HttpResponse]] = ...
 handler403: Union[str, Callable[..., HttpResponse]] = ...
@@ -11,14 +12,19 @@ handler500: Union[str, Callable[..., HttpResponse]] = ...
 
 IncludedURLConf = Tuple[Sequence[Union[URLResolver, URLPattern]], Optional[str], Optional[str]]
 
-def include(arg: Any, namespace: str = ..., app_name: str = ...) -> IncludedURLConf: ...
+# Deprecated
 @overload
 def url(
-    regex: str, view: Callable[..., HttpResponseBase], kwargs: Dict[str, Any] = ..., name: str = ...
+    regex: str, view: Callable[..., HttpResponseBase], kwargs: Optional[Dict[str, Any]] = ..., name: Optional[str] = ...
 ) -> URLPattern: ...
 @overload
-def url(regex: str, view: IncludedURLConf, kwargs: Dict[str, Any] = ..., name: str = ...) -> URLResolver: ...
+def url(
+    regex: str, view: IncludedURLConf, kwargs: Optional[Dict[str, Any]] = ..., name: Optional[str] = ...
+) -> URLResolver: ...
 @overload
 def url(
-    regex: str, view: Sequence[Union[URLResolver, str]], kwargs: Dict[str, Any] = ..., name: str = ...
+    regex: str,
+    view: Sequence[Union[URLResolver, str]],
+    kwargs: Optional[Dict[str, Any]] = ...,
+    name: Optional[str] = ...,
 ) -> URLResolver: ...

django-stubs/conf/urls/i18n.pyi

@@ -1,8 +1,10 @@
-from typing import Any, Callable, List, Tuple
+from typing import Callable, List, Tuple, Union
 
-from django.urls.resolvers import URLPattern
+from django.urls.resolvers import URLPattern, URLResolver
 
-def i18n_patterns(*urls: Any, prefix_default_language: bool = ...) -> List[List[URLPattern]]: ...
+def i18n_patterns(
+    *urls: Union[URLPattern, URLResolver], prefix_default_language: bool = ...
+) -> List[Union[URLPattern, URLResolver]]: ...
 def is_language_prefix_patterns_used(urlconf: str) -> Tuple[bool, bool]: ...
 
 urlpatterns: List[Callable]

django-stubs/contrib/admin/__init__.pyi

@@ -12,7 +12,6 @@ from .filters import ListFilter as ListFilter
 from .filters import RelatedFieldListFilter as RelatedFieldListFilter
 from .filters import RelatedOnlyFieldListFilter as RelatedOnlyFieldListFilter
 from .filters import SimpleListFilter as SimpleListFilter
-from .helpers import ACTION_CHECKBOX_NAME as ACTION_CHECKBOX_NAME
 from .options import HORIZONTAL as HORIZONTAL
 from .options import VERTICAL as VERTICAL
 from .options import ModelAdmin as ModelAdmin

django-stubs/contrib/admin/actions.pyi

@@ -1,8 +1,8 @@
 from typing import Optional
 
 from django.contrib.admin.options import ModelAdmin
-from django.core.handlers.wsgi import WSGIRequest
 from django.db.models.query import QuerySet
+from django.http.request import HttpRequest
 from django.template.response import TemplateResponse
 
-def delete_selected(modeladmin: ModelAdmin, request: WSGIRequest, queryset: QuerySet) -> Optional[TemplateResponse]: ...
+def delete_selected(modeladmin: ModelAdmin, request: HttpRequest, queryset: QuerySet) -> Optional[TemplateResponse]: ...

django-stubs/contrib/admin/checks.pyi

@@ -1,18 +1,21 @@
-from typing import Any, List, Optional, Sequence
+from typing import Any, 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) -> List[Error]: ...
-def check_dependencies(app_configs: Optional[Sequence[AppConfig]] = ..., **kwargs: Any) -> List[Error]: ...
+def check_admin_app(app_configs: Optional[Sequence[AppConfig]], **kwargs: Any) -> Sequence[CheckMessage]: ...
+def check_dependencies(**kwargs: Any) -> Sequence[CheckMessage]: ...
 
 class BaseModelAdminChecks:
-    def check(self, admin_obj: BaseModelAdmin, **kwargs: Any) -> List[CheckMessage]: ...
+    def check(self, admin_obj: BaseModelAdmin, **kwargs: Any) -> Sequence[CheckMessage]: ...
 
-class ModelAdminChecks(BaseModelAdminChecks): ...
-class InlineModelAdminChecks(BaseModelAdminChecks): ...
+class ModelAdminChecks(BaseModelAdminChecks):
+    def check(self, admin_obj: BaseModelAdmin, **kwargs: Any) -> Sequence[CheckMessage]: ...
+
+class InlineModelAdminChecks(BaseModelAdminChecks):
+    def check(self, inline_obj: BaseModelAdmin, **kwargs: Any) -> Sequence[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, model: Any, obj: Any, id: Any): ...
+def refer_to_missing_field(field: Any, option: Any, obj: Any, id: Any): ...