various annotation improvements (#258)

dev-requirements.txt

@@ -1,7 +1,7 @@
 black
 pytest-mypy-plugins==1.1.0
 psycopg2
-flake8==3.7.8
+flake8==3.7.9
 flake8-pyi==19.3.0
 isort==4.3.21
 gitpython==3.0.5

django-stubs/contrib/admin/checks.pyi

@@ -1,11 +1,13 @@
-from typing import Any, List, Union
+from typing import Any, List, Union, Iterable, Optional
 
 from django.contrib.admin.options import BaseModelAdmin
 from django.core.checks.messages import Error
 
+from django.apps.config import AppConfig
+
 _CheckError = Union[str, Error]
 
-def check_admin_app(app_configs: None, **kwargs: Any) -> List[_CheckError]: ...
+def check_admin_app(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[_CheckError]: ...
 def check_dependencies(**kwargs: Any) -> List[_CheckError]: ...
 
 class BaseModelAdminChecks:

django-stubs/contrib/admin/sites.pyi

@@ -8,6 +8,8 @@ from django.template.response import TemplateResponse
 from django.urls.resolvers import URLResolver
 from django.utils.functional import LazyObject
 
+from django.apps.config import AppConfig
+
 all_sites: Any
 
 class AlreadyRegistered(Exception): ...
@@ -28,7 +30,7 @@ class AdminSite:
     name: str = ...
     _registry: Dict[Type[Model], ModelAdmin]
     def __init__(self, name: str = ...) -> None: ...
-    def check(self, app_configs: None) -> List[Any]: ...
+    def check(self, app_configs: Optional[Iterable[AppConfig]]) -> List[Any]: ...
     def register(
         self,
         model_or_iterable: Union[Type[Model], Iterable[Type[Model]]],
@@ -37,7 +39,7 @@ class AdminSite:
     ) -> None: ...
     def unregister(self, model_or_iterable: Union[Type[Model], Iterable[Type[Model]]]) -> None: ...
     def is_registered(self, model: Type[Model]) -> bool: ...
-    def add_action(self, action: Callable, name: None = ...) -> None: ...
+    def add_action(self, action: Callable, name: Optional[str] = ...) -> None: ...
     def disable_action(self, name: str) -> None: ...
     def get_action(self, name: str) -> Callable: ...
     @property
@@ -52,14 +54,20 @@ class AdminSite:
     @property
     def urls(self) -> Tuple[List[URLResolver], str, str]: ...
     def each_context(self, request: Any): ...
-    def password_change(self, request: WSGIRequest, extra_context: Dict[str, str] = ...) -> TemplateResponse: ...
-    def password_change_done(self, request: WSGIRequest, extra_context: None = ...) -> TemplateResponse: ...
+    def password_change(
+        self, request: WSGIRequest, extra_context: Optional[Dict[str, Any]] = ...
+    ) -> TemplateResponse: ...
+    def password_change_done(
+        self, request: WSGIRequest, extra_context: Optional[Dict[str, Any]] = ...
+    ) -> TemplateResponse: ...
     def i18n_javascript(self, request: WSGIRequest, extra_context: Optional[Dict[Any, Any]] = ...) -> HttpResponse: ...
-    def logout(self, request: WSGIRequest, extra_context: None = ...) -> TemplateResponse: ...
-    def login(self, request: WSGIRequest, extra_context: None = ...) -> HttpResponse: ...
+    def logout(self, request: WSGIRequest, extra_context: Optional[Dict[str, Any]] = ...) -> TemplateResponse: ...
+    def login(self, request: WSGIRequest, extra_context: Optional[Dict[str, Any]] = ...) -> HttpResponse: ...
     def get_app_list(self, request: WSGIRequest) -> List[Any]: ...
-    def index(self, request: WSGIRequest, extra_context: Optional[Dict[str, str]] = ...) -> TemplateResponse: ...
-    def app_index(self, request: WSGIRequest, app_label: str, extra_context: None = ...) -> TemplateResponse: ...
+    def index(self, request: WSGIRequest, extra_context: Optional[Dict[str, Any]] = ...) -> TemplateResponse: ...
+    def app_index(
+        self, request: WSGIRequest, app_label: str, extra_context: Optional[Dict[str, Any]] = ...
+    ) -> TemplateResponse: ...
 
 class DefaultAdminSite(LazyObject): ...
 

django-stubs/contrib/admin/utils.pyi

@@ -9,12 +9,10 @@ from django.contrib.auth.forms import AdminPasswordChangeForm
 from django.core.handlers.wsgi import WSGIRequest
 from django.db.models.base import Model
 from django.db.models.deletion import Collector
-from django.db.models.fields.mixins import FieldCacheMixin
 from django.db.models.fields.reverse_related import ManyToOneRel
 from django.db.models.options import Options
 from django.db.models.query import QuerySet
 from django.forms.forms import BaseForm
-from django.utils.safestring import SafeText
 
 from django.db.models.fields import Field, reverse_related
 
@@ -27,7 +25,7 @@ def unquote(s: str) -> str: ...
 def flatten(fields: Any) -> List[Union[Callable, str]]: ...
 def flatten_fieldsets(fieldsets: Any) -> List[Union[Callable, str]]: ...
 def get_deleted_objects(
-    objs: QuerySet, request: WSGIRequest, admin_site: AdminSite
+    objs: Sequence[Optional[Model]], request: WSGIRequest, admin_site: AdminSite
 ) -> Tuple[List[Any], Dict[Any, Any], Set[Any], List[Any]]: ...
 
 class NestedObjects(Collector):
@@ -41,22 +39,14 @@ class NestedObjects(Collector):
     model_objs: Any = ...
     def __init__(self, *args: Any, **kwargs: Any) -> None: ...
     def add_edge(self, source: Optional[Model], target: Model) -> None: ...
-    def collect(
-        self,
-        objs: Union[Sequence[Optional[Model]], QuerySet],
-        source: Optional[Type[Model]] = ...,
-        source_attr: Optional[str] = ...,
-        **kwargs: Any
-    ) -> None: ...
-    def related_objects(self, related: ManyToOneRel, objs: List[Model]) -> QuerySet: ...
-    def nested(self, format_callback: Callable = ...) -> Union[List[SafeText], List[int]]: ...
-    def can_fast_delete(self, *args: Any, **kwargs: Any) -> bool: ...
+    def related_objects(self, related: ManyToOneRel, objs: Sequence[Optional[Model]]) -> QuerySet: ...
+    def nested(self, format_callback: Callable = ...) -> List[Any]: ...
 
 def model_format_dict(obj: Any): ...
 def model_ngettext(obj: Union[Options, QuerySet], n: Optional[int] = ...) -> str: ...
 def lookup_field(
     name: Union[Callable, str], obj: Model, model_admin: BaseModelAdmin = ...
-) -> Tuple[Optional[Field], Callable, Callable]: ...
+) -> Tuple[Optional[Field], Any, Any]: ...
 def label_for_field(
     name: Union[Callable, str],
     model: Type[Model],
@@ -65,16 +55,14 @@ def label_for_field(
     form: Optional[BaseForm] = ...,
 ) -> Union[Tuple[Optional[str], Union[Callable, Type[str]]], str]: ...
 def help_text_for_field(name: str, model: Type[Model]) -> str: ...
-def display_for_field(
-    value: Any, field: Union[Field, reverse_related.OneToOneRel], empty_value_display: str
-) -> str: ...
+def display_for_field(value: Any, field: Field, empty_value_display: str) -> str: ...
 def display_for_value(value: Any, empty_value_display: str, boolean: bool = ...) -> str: ...
 
 class NotRelationField(Exception): ...
 
 def get_model_from_relation(field: Union[Field, reverse_related.ForeignObjectRel]) -> Type[Model]: ...
 def reverse_field_path(model: Type[Model], path: str) -> Tuple[Type[Model], str]: ...
-def get_fields_from_path(model: Type[Model], path: str) -> List[Union[Field, FieldCacheMixin]]: ...
+def get_fields_from_path(model: Type[Model], path: str) -> List[Field]: ...
 def construct_change_message(
     form: AdminPasswordChangeForm, formsets: None, add: bool
 ) -> List[Dict[str, Dict[str, List[str]]]]: ...

django-stubs/contrib/auth/base_user.pyi

@@ -13,11 +13,10 @@ class BaseUserManager(models.Manager[_T]):
     def get_by_natural_key(self, username: Optional[str]) -> _T: ...
 
 class AbstractBaseUser(models.Model):
+    REQUIRED_FIELDS: List[str] = ...
+
     password = models.CharField(max_length=128)
     last_login = models.DateTimeField(blank=True, null=True)
-
-    REQUIRED_FIELDS: List[str] = ...
-    class Meta: ...
     def get_username(self) -> str: ...
     def natural_key(self) -> Tuple[str]: ...
     @property

django-stubs/contrib/auth/checks.pyi

@@ -1,6 +1,8 @@
-from typing import Any, List
+from typing import Any, List, Iterable, Optional
 
 from django.core.checks.messages import CheckMessage
 
-def check_user_model(app_configs: None = ..., **kwargs: Any) -> List[CheckMessage]: ...
-def check_models_permissions(app_configs: None = ..., **kwargs: Any) -> List[Any]: ...
+from django.apps.config import AppConfig
+
+def check_user_model(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[CheckMessage]: ...
+def check_models_permissions(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[Any]: ...

django-stubs/contrib/contenttypes/checks.pyi

@@ -1,4 +1,6 @@
-from typing import Any, List
+from typing import Any, List, Iterable, Optional
 
-def check_generic_foreign_keys(app_configs: None = ..., **kwargs: Any) -> List[Any]: ...
-def check_model_name_lengths(app_configs: None = ..., **kwargs: Any) -> List[Any]: ...
+from django.apps.config import AppConfig
+
+def check_generic_foreign_keys(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[Any]: ...
+def check_model_name_lengths(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[Any]: ...

django-stubs/contrib/sites/management.pyi

@@ -1,10 +1,10 @@
 from typing import Any
 
+from django.apps.config import AppConfig
 from django.apps.registry import Apps
-from django.contrib.sites.apps import SitesConfig
 
 def create_default_site(
-    app_config: SitesConfig,
+    app_config: AppConfig,
     verbosity: int = ...,
     interactive: bool = ...,
     using: str = ...,

django-stubs/contrib/staticfiles/checks.pyi

@@ -1,5 +1,7 @@
-from typing import Any, List
+from typing import Any, List, Iterable, Optional
 
 from django.core.checks.messages import Error
 
-def check_finders(app_configs: None = ..., **kwargs: Any) -> List[Error]: ...
+from django.apps.config import AppConfig
+
+def check_finders(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[Error]: ...

django-stubs/core/checks/caches.pyi

@@ -1,7 +1,9 @@
-from typing import Any, List
+from typing import Any, List, Iterable, Optional
 
 from django.core.checks.messages import Error
 
+from django.apps.config import AppConfig
+
 E001: Any
 
-def check_default_cache_is_configured(app_configs: None, **kwargs: Any) -> List[Error]: ...
+def check_default_cache_is_configured(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Error]: ...

django-stubs/core/checks/model_checks.pyi

@@ -1,6 +1,8 @@
-from typing import Any, List
+from typing import Any, List, Iterable, Optional
 
 from django.core.checks.messages import Warning
 
-def check_all_models(app_configs: None = ..., **kwargs: Any) -> List[Warning]: ...
-def check_lazy_references(app_configs: None = ..., **kwargs: Any) -> List[Any]: ...
+from django.apps.config import AppConfig
+
+def check_all_models(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[Warning]: ...
+def check_lazy_references(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[Any]: ...

django-stubs/core/checks/security/base.pyi

@@ -1,7 +1,9 @@
-from typing import Any, List
+from typing import Any, List, Iterable, Optional
 
 from django.core.checks.messages import Warning
 
+from django.apps.config import AppConfig
+
 SECRET_KEY_MIN_LENGTH: int
 SECRET_KEY_MIN_UNIQUE_CHARACTERS: int
 W001: Any
@@ -17,15 +19,15 @@ W019: Any
 W020: Any
 W021: Any
 
-def check_security_middleware(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_xframe_options_middleware(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_sts(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_sts_include_subdomains(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_sts_preload(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_content_type_nosniff(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_xss_filter(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_ssl_redirect(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_secret_key(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_debug(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_xframe_deny(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_allowed_hosts(app_configs: None, **kwargs: Any) -> List[Warning]: ...
+def check_security_middleware(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_xframe_options_middleware(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_sts(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_sts_include_subdomains(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_sts_preload(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_content_type_nosniff(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_xss_filter(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_ssl_redirect(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_secret_key(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_debug(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_xframe_deny(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_allowed_hosts(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...

django-stubs/core/checks/security/csrf.pyi

@@ -1,9 +1,11 @@
-from typing import Any, List
+from typing import Any, List, Iterable, Optional
 
 from django.core.checks.messages import Warning
 
+from django.apps.config import AppConfig
+
 W003: Any
 W016: Any
 
-def check_csrf_middleware(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_csrf_cookie_secure(app_configs: None, **kwargs: Any) -> List[Warning]: ...
+def check_csrf_middleware(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_csrf_cookie_secure(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...

django-stubs/core/checks/security/sessions.pyi

@@ -1,7 +1,9 @@
-from typing import Any, List
+from typing import Any, List, Iterable, Optional
 
 from django.core.checks.messages import Warning
 
+from django.apps.config import AppConfig
+
 def add_session_cookie_message(message: Any): ...
 
 W010: Any
@@ -14,5 +16,5 @@ W013: Any
 W014: Any
 W015: Any
 
-def check_session_cookie_secure(app_configs: None, **kwargs: Any) -> List[Warning]: ...
-def check_session_cookie_httponly(app_configs: None, **kwargs: Any) -> List[Warning]: ...
+def check_session_cookie_secure(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
+def check_session_cookie_httponly(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...

django-stubs/core/checks/templates.pyi

@@ -1,9 +1,11 @@
-from typing import Any, List
+from typing import Any, List, Iterable, Optional
 
 from django.core.checks.messages import Error
 
+from django.apps.config import AppConfig
+
 E001: Any
 E002: Any
 
-def check_setting_app_dirs_loaders(app_configs: None, **kwargs: Any) -> List[Error]: ...
-def check_string_if_invalid_is_string(app_configs: None, **kwargs: Any) -> List[Error]: ...
+def check_setting_app_dirs_loaders(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Error]: ...
+def check_string_if_invalid_is_string(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Error]: ...

django-stubs/core/checks/urls.pyi

@@ -1,11 +1,13 @@
-from typing import Any, Callable, List, Tuple, Union
+from typing import Any, Callable, List, Tuple, Union, Iterable, Optional
 
 from django.core.checks.messages import CheckMessage, Error, Warning
 from django.urls.resolvers import URLPattern, URLResolver
 
-def check_url_config(app_configs: None, **kwargs: Any) -> List[CheckMessage]: ...
+from django.apps.config import AppConfig
+
+def check_url_config(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[CheckMessage]: ...
 def check_resolver(resolver: Union[Tuple[str, Callable], URLPattern, URLResolver]) -> List[CheckMessage]: ...
-def check_url_namespaces_unique(app_configs: None, **kwargs: Any) -> List[Warning]: ...
+def check_url_namespaces_unique(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Warning]: ...
 def get_warning_for_invalid_pattern(pattern: Any) -> List[Error]: ...
-def check_url_settings(app_configs: None, **kwargs: Any) -> List[Error]: ...
+def check_url_settings(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[Error]: ...
 def E006(name: str) -> Error: ...

django-stubs/core/serializers/base.pyi

@@ -1,6 +1,6 @@
 from datetime import date
 from io import BufferedReader, StringIO, TextIOWrapper
-from typing import Any, Dict, Iterable, List, Mapping, Optional, Type, Union
+from typing import Any, Dict, Iterable, List, Mapping, Optional, Type, Union, Collection
 from uuid import UUID
 
 from django.core.management.base import OutputWrapper
@@ -35,18 +35,18 @@ class Serializer:
     internal_use_only: bool = ...
     progress_class: Any = ...
     stream_class: Any = ...
-    options: Any = ...
+    options: Dict[str, Any] = ...
     stream: Any = ...
-    selected_fields: Any = ...
-    use_natural_foreign_keys: Any = ...
-    use_natural_primary_keys: Any = ...
+    selected_fields: Optional[Collection[str]] = ...
+    use_natural_foreign_keys: bool = ...
+    use_natural_primary_keys: bool = ...
     first: bool = ...
     def serialize(
         self,
         queryset: Iterable[Model],
         *,
         stream: Optional[Any] = ...,
-        fields: Optional[Any] = ...,
+        fields: Optional[Collection[str]] = ...,
         use_natural_foreign_keys: bool = ...,
         use_natural_primary_keys: bool = ...,
         progress_output: Optional[Any] = ...,
@@ -63,7 +63,7 @@ class Serializer:
     def getvalue(self) -> Optional[Union[bytes, str]]: ...
 
 class Deserializer:
-    options: Any = ...
+    options: Dict[str, Any] = ...
     stream: Any = ...
     def __init__(self, stream_or_string: Union[BufferedReader, TextIOWrapper, str], **options: Any) -> None: ...
     def __iter__(self) -> Deserializer: ...