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

django-stubs/views/debug.pyi

@@ -1,58 +1,60 @@
 from importlib.abc import SourceLoader
+from pathlib import Path
 from types import TracebackType
-from typing import Any, Callable, Dict, List, MutableMapping, Optional, Type, Union
+from typing import Any, Callable, Dict, Iterator, List, Optional, Type, Union
 
 from django.http.request import HttpRequest, QueryDict
 from django.http.response import Http404, HttpResponse
-from django.utils.safestring import SafeText
+from django.utils.safestring import SafeString
 
-DEBUG_ENGINE: Any
-HIDDEN_SETTINGS: Any
 CLEANSED_SUBSTITUTE: str
-CURRENT_DIR: Any
+CURRENT_DIR: Path
 
 class CallableSettingWrapper:
     def __init__(self, callable_setting: Union[Callable, Type[Any]]) -> None: ...
 
-def cleanse_setting(key: Union[int, str], value: Any) -> Any: ...
-def get_safe_settings() -> Dict[str, Any]: ...
 def technical_500_response(request: Any, exc_type: Any, exc_value: Any, tb: Any, status_code: int = ...): ...
-def get_default_exception_reporter_filter() -> ExceptionReporterFilter: ...
-def get_exception_reporter_filter(request: Optional[HttpRequest]) -> ExceptionReporterFilter: ...
+def get_default_exception_reporter_filter() -> SafeExceptionReporterFilter: ...
+def get_exception_reporter_filter(request: Optional[HttpRequest]) -> SafeExceptionReporterFilter: ...
 
-class ExceptionReporterFilter:
-    def get_post_parameters(self, request: Any): ...
-    def get_traceback_frame_variables(self, request: Any, tb_frame: Any): ...
-
-class SafeExceptionReporterFilter(ExceptionReporterFilter):
+class SafeExceptionReporterFilter:
+    def cleanse_setting(self, key: Union[int, str], value: Any) -> Any: ...
+    def get_safe_settings(self) -> Dict[str, Any]: ...
     def is_active(self, request: Optional[HttpRequest]) -> bool: ...
     def get_cleansed_multivaluedict(self, request: HttpRequest, multivaluedict: QueryDict) -> QueryDict: ...
-    def get_post_parameters(self, request: Optional[HttpRequest]) -> MutableMapping[str, Any]: ...
+    def get_post_parameters(self, request: Optional[HttpRequest]) -> Dict[str, Any]: ...
     def cleanse_special_types(self, request: Optional[HttpRequest], value: Any) -> Any: ...
     def get_traceback_frame_variables(self, request: Any, tb_frame: Any): ...
 
 class ExceptionReporter:
     request: Optional[HttpRequest] = ...
-    filter: ExceptionReporterFilter = ...
+    filter: SafeExceptionReporterFilter = ...
     exc_type: Optional[Type[BaseException]] = ...
-    exc_value: Optional[str] = ...
+    exc_value: Optional[BaseException] = ...
     tb: Optional[TracebackType] = ...
     is_email: bool = ...
-    template_info: None = ...
+    template_info: Optional[Any] = ...
     template_does_not_exist: bool = ...
-    postmortem: None = ...
+    postmortem: Optional[Any] = ...
+    @property
+    def html_template_path(self) -> Path: ...
+    @property
+    def text_template_path(self) -> Path: ...
     def __init__(
         self,
         request: Optional[HttpRequest],
         exc_type: Optional[Type[BaseException]],
-        exc_value: Optional[Union[str, BaseException]],
+        exc_value: Optional[BaseException],
         tb: Optional[TracebackType],
         is_email: bool = ...,
     ) -> None: ...
     def get_traceback_data(self) -> Dict[str, Any]: ...
-    def get_traceback_html(self) -> SafeText: ...
-    def get_traceback_text(self) -> SafeText: ...
+    def get_traceback_html(self) -> SafeString: ...
+    def get_traceback_text(self) -> SafeString: ...
     def get_traceback_frames(self) -> List[Any]: ...
+    def get_exception_traceback_frames(
+        self, exc_value: Optional[BaseException], tb: Optional[TracebackType]
+    ) -> Iterator[Dict[str, Any]]: ...
     def _get_lines_from_file(
         self,
         filename: str,