Used _ContextKeys for context like dicts (#1298)

* Used _ContextKeys for context like dicts

* Updated context like dicts to dict[_ContextKeys, Any].

* Update imports

* Fix Test

* Updated Imports

* [pre-commit.ci] auto fixes from pre-commit.com hooks

* Revert "Fix Test"

This reverts commit a4b26af.

* Updated dict to Mapping

* [pre-commit.ci] auto fixes from pre-commit.com hooks

* Removed test

* Fixed flake8 errors

* Imported Any

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: smithdc1

django-stubs/contrib/admin/options.pyi

@@ -28,6 +28,7 @@ from django.forms.models import (
 from django.forms.widgets import Media
 from django.http.request import HttpRequest
 from django.http.response import HttpResponse, HttpResponseRedirect
+from django.template.context import _ContextKeys
 from django.template.response import _TemplateForResponseT
 from django.urls.resolvers import URLPattern
 from django.utils.datastructures import _ListOrTuple
@@ -231,7 +232,7 @@ class ModelAdmin(BaseModelAdmin[_ModelT]):
     def render_change_form(
         self,
         request: HttpRequest,
-        context: dict[str, Any],
+        context: Mapping[_ContextKeys, Any],
         add: bool = ...,
         change: bool = ...,
         form_url: str = ...,
@@ -244,7 +245,7 @@ class ModelAdmin(BaseModelAdmin[_ModelT]):
     # Probably FileResponse cannot come from ModelAdmin views
     def response_action(self, request: HttpRequest, queryset: QuerySet) -> HttpResponse | None: ...
     def response_delete(self, request: HttpRequest, obj_display: str, obj_id: int) -> HttpResponse: ...
-    def render_delete_form(self, request: HttpRequest, context: dict[str, Any]) -> HttpResponse: ...
+    def render_delete_form(self, request: HttpRequest, context: Mapping[_ContextKeys, Any]) -> HttpResponse: ...
     def get_inline_formsets(
         self, request: HttpRequest, formsets: list[Any], inline_instances: list[Any], obj: _ModelT | None = ...
     ) -> list[Any]: ...
@@ -254,23 +255,29 @@ class ModelAdmin(BaseModelAdmin[_ModelT]):
         request: HttpRequest,
         object_id: str | None = ...,
         form_url: str = ...,
-        extra_context: dict[str, Any] | None = ...,
+        extra_context: Mapping[_ContextKeys, Any] | None = ...,
     ) -> HttpResponse: ...
     def add_view(
-        self, request: HttpRequest, form_url: str = ..., extra_context: dict[str, Any] | None = ...
+        self, request: HttpRequest, form_url: str = ..., extra_context: Mapping[_ContextKeys, Any] | None = ...
     ) -> HttpResponse: ...
     def change_view(
-        self, request: HttpRequest, object_id: str, form_url: str = ..., extra_context: dict[str, Any] | None = ...
+        self,
+        request: HttpRequest,
+        object_id: str,
+        form_url: str = ...,
+        extra_context: Mapping[_ContextKeys, Any] | None = ...,
+    ) -> HttpResponse: ...
+    def changelist_view(
+        self, request: HttpRequest, extra_context: Mapping[_ContextKeys, Any] | None = ...
     ) -> HttpResponse: ...
-    def changelist_view(self, request: HttpRequest, extra_context: dict[str, Any] | None = ...) -> HttpResponse: ...
     def get_deleted_objects(
         self, objs: Sequence[_ModelT] | QuerySet[_ModelT], request: HttpRequest
     ) -> tuple[list[Model], dict[str, int], set[str], list[str]]: ...
     def delete_view(
-        self, request: HttpRequest, object_id: str, extra_context: dict[str, Any] | None = ...
+        self, request: HttpRequest, object_id: str, extra_context: Mapping[_ContextKeys, Any] | None = ...
     ) -> HttpResponse: ...
     def history_view(
-        self, request: HttpRequest, object_id: str, extra_context: dict[str, Any] | None = ...
+        self, request: HttpRequest, object_id: str, extra_context: Mapping[_ContextKeys, Any] | None = ...
     ) -> HttpResponse: ...
 
 _ChildModelT = TypeVar("_ChildModelT", bound=Model)

django-stubs/contrib/admin/sites.pyi

@@ -1,5 +1,5 @@
 import sys
-from collections.abc import Callable, Iterable
+from collections.abc import Callable, Iterable, Mapping
 from typing import Any
 
 from django.apps.config import AppConfig
@@ -10,6 +10,7 @@ from django.db.models.base import Model
 from django.db.models.query import QuerySet
 from django.http.request import HttpRequest
 from django.http.response import HttpResponse
+from django.template.context import _ContextKeys
 from django.template.response import TemplateResponse
 from django.urls import URLPattern, URLResolver
 from django.utils.functional import LazyObject, _StrOrPromise
@@ -70,18 +71,26 @@ class AdminSite:
     @property
     def urls(self) -> tuple[list[URLResolver | URLPattern], str, str]: ...
     def each_context(self, request: HttpRequest) -> dict[str, Any]: ...
-    def password_change(self, request: HttpRequest, extra_context: dict[str, Any] | None = ...) -> TemplateResponse: ...
+    def password_change(
+        self, request: HttpRequest, extra_context: Mapping[_ContextKeys, Any] | None = ...
+    ) -> TemplateResponse: ...
     def password_change_done(
-        self, request: HttpRequest, extra_context: dict[str, Any] | None = ...
+        self, request: HttpRequest, extra_context: Mapping[_ContextKeys, Any] | None = ...
+    ) -> TemplateResponse: ...
+    def i18n_javascript(
+        self, request: HttpRequest, extra_context: Mapping[_ContextKeys, Any] | None = ...
+    ) -> HttpResponse: ...
+    def logout(
+        self, request: HttpRequest, extra_context: Mapping[_ContextKeys, Any] | None = ...
     ) -> TemplateResponse: ...
-    def i18n_javascript(self, request: HttpRequest, extra_context: dict[str, Any] | None = ...) -> HttpResponse: ...
-    def logout(self, request: HttpRequest, extra_context: dict[str, Any] | None = ...) -> TemplateResponse: ...
-    def login(self, request: HttpRequest, extra_context: dict[str, Any] | None = ...) -> HttpResponse: ...
+    def login(self, request: HttpRequest, extra_context: Mapping[_ContextKeys, Any] | None = ...) -> HttpResponse: ...
     def _build_app_dict(self, request: HttpRequest, label: _StrOrPromise | None = ...) -> dict[str, Any]: ...
     def get_app_list(self, request: HttpRequest) -> list[Any]: ...
-    def index(self, request: HttpRequest, extra_context: dict[str, Any] | None = ...) -> TemplateResponse: ...
+    def index(
+        self, request: HttpRequest, extra_context: Mapping[_ContextKeys, Any] | None = ...
+    ) -> TemplateResponse: ...
     def app_index(
-        self, request: HttpRequest, app_label: str, extra_context: dict[str, Any] | None = ...
+        self, request: HttpRequest, app_label: str, extra_context: Mapping[_ContextKeys, Any] | None = ...
     ) -> TemplateResponse: ...
     def autocomplete_view(self, request: HttpRequest) -> HttpResponse: ...
     def catch_all_view(self, request: HttpRequest, url: str) -> HttpResponse: ...

django-stubs/forms/renderers.pyi

@@ -1,16 +1,20 @@
+from collections.abc import Mapping
 from typing import Any
 
 from django.http import HttpRequest
 from django.template.backends.base import BaseEngine
 from django.template.backends.django import DjangoTemplates as DjangoTemplatesR
 from django.template.backends.jinja2 import Jinja2 as Jinja2R
 from django.template.base import Template
+from django.template.context import _ContextKeys
 
 def get_default_renderer() -> BaseRenderer: ...
 
 class BaseRenderer:
     def get_template(self, template_name: str) -> Any: ...
-    def render(self, template_name: str, context: dict[str, Any], request: HttpRequest | None = ...) -> str: ...
+    def render(
+        self, template_name: str, context: Mapping[_ContextKeys, Any], request: HttpRequest | None = ...
+    ) -> str: ...
 
 class EngineMixin:
     def get_template(self, template_name: str) -> Any: ...

django-stubs/shortcuts.pyi

@@ -7,12 +7,13 @@ from django.http import HttpRequest
 from django.http.response import HttpResponse as HttpResponse
 from django.http.response import HttpResponsePermanentRedirect as HttpResponsePermanentRedirect
 from django.http.response import HttpResponseRedirect as HttpResponseRedirect
+from django.template.context import _ContextKeys
 from typing_extensions import Literal
 
 def render(
     request: HttpRequest,
     template_name: str | Sequence[str],
-    context: Mapping[str, Any] | None = ...,
+    context: Mapping[_ContextKeys, Any] | None = ...,
     content_type: str | None = ...,
     status: int | None = ...,
     using: str | None = ...,

django-stubs/template/backends/base.pyi

@@ -4,6 +4,7 @@ from typing import Any, Protocol
 from django.http.request import HttpRequest
 from django.template import TemplateDoesNotExist
 from django.template.base import Context
+from django.template.context import _ContextKeys
 from django.utils.safestring import SafeString
 
 class BaseEngine:
@@ -22,6 +23,6 @@ class BaseEngine:
 class _EngineTemplate(Protocol):
     def render(
         self,
-        context: Context | dict[str, Any] | None = ...,
+        context: Context | Mapping[_ContextKeys, Any] | None = ...,
         request: HttpRequest | None = ...,
     ) -> SafeString: ...

django-stubs/template/backends/dummy.pyi

@@ -1,7 +1,9 @@
 import string
+from collections.abc import Mapping
 from typing import Any
 
 from django.http.request import HttpRequest
+from django.template.context import _ContextKeys
 
 from .base import BaseEngine
 
@@ -11,4 +13,4 @@ class TemplateStrings(BaseEngine):
 
 class Template(string.Template):
     template: str
-    def render(self, context: dict[str, str] | None = ..., request: HttpRequest | None = ...) -> str: ...
+    def render(self, context: Mapping[_ContextKeys, Any] | None = ..., request: HttpRequest | None = ...) -> str: ...

django-stubs/template/base.pyi

@@ -5,6 +5,7 @@ from re import Pattern
 from typing import Any
 
 from django.template.context import Context as Context
+from django.template.context import _ContextKeys
 from django.template.engine import Engine
 from django.template.library import Library
 from django.template.loaders.base import Loader
@@ -59,7 +60,7 @@ class Template:
         engine: Engine | None = ...,
     ) -> None: ...
     def __iter__(self) -> Iterator[Node]: ...
-    def render(self, context: Context | dict[str, Any] | None) -> SafeString: ...
+    def render(self, context: Context | Mapping[_ContextKeys, Any] | None) -> SafeString: ...
     def compile_nodelist(self) -> NodeList: ...
     def get_exception_info(self, exception: Exception, token: Token) -> dict[str, Any]: ...
 
@@ -138,7 +139,7 @@ class Variable:
     translate: bool
     message_context: str | None
     def __init__(self, var: dict[Any, Any] | str) -> None: ...
-    def resolve(self, context: Mapping[str, Mapping[str, Any]] | Context | int | str) -> Any: ...
+    def resolve(self, context: Mapping[_ContextKeys, Any] | Context | int | str) -> Any: ...
 
 class Node:
     must_be_first: bool

django-stubs/template/context.pyi

@@ -1,4 +1,4 @@
-from collections.abc import Callable, Iterable, Iterator
+from collections.abc import Callable, Iterable, Iterator, Mapping
 from contextlib import contextmanager
 from types import TracebackType
 from typing import Any, TypeVar
@@ -40,7 +40,7 @@ class BaseContext(Iterable[Any]):
     def get(self, key: _ContextKeys, otherwise: Any | None = ...) -> Any | None: ...
     def setdefault(self, key: _ContextKeys, default: list[Origin] | int | None = ...) -> list[Origin] | int | None: ...
     def new(self, values: _ContextValues | None = ...) -> Context: ...
-    def flatten(self) -> dict[_ContextKeys, dict[_ContextKeys, type[Any] | str] | int | str | None]: ...
+    def flatten(self) -> Mapping[_ContextKeys, Any]: ...
 
 class Context(BaseContext):
     dicts: Any
@@ -55,7 +55,7 @@ class Context(BaseContext):
     ) -> None: ...
     @contextmanager
     def bind_template(self, template: Template) -> Iterator[None]: ...
-    def update(self, other_dict: dict[str, Any] | Context) -> ContextDict: ...
+    def update(self, other_dict: Mapping[_ContextKeys, Any] | Context) -> ContextDict: ...
 
 class RenderContext(BaseContext):
     dicts: list[dict[IncludeNode | str, str]]

django-stubs/template/defaulttags.pyi

@@ -1,5 +1,5 @@
 from collections import namedtuple
-from collections.abc import Iterator, Sequence
+from collections.abc import Iterator, Mapping, Sequence
 from datetime import date as real_date
 from typing import Any
 
@@ -8,6 +8,7 @@ from django.template.context import Context
 from django.utils.safestring import SafeString
 
 from .base import Node, NodeList
+from .context import _ContextKeys
 from .library import Library
 from .smartif import IfParser, Literal
 
@@ -154,13 +155,13 @@ class WidthRatioNode(Node):
 
 class WithNode(Node):
     nodelist: NodeList
-    extra_context: dict[str, Any]
+    extra_context: Mapping[_ContextKeys, Any]
     def __init__(
         self,
         var: str | None,
         name: str | None,
         nodelist: NodeList | Sequence[Node],
-        extra_context: dict[str, Any] | None = ...,
+        extra_context: Mapping[_ContextKeys, Any] | None = ...,
     ) -> None: ...
 
 def autoescape(parser: Parser, token: Token) -> AutoEscapeControlNode: ...

django-stubs/template/engine.pyi

@@ -1,4 +1,4 @@
-from collections.abc import Callable, Sequence
+from collections.abc import Callable, Mapping, Sequence
 from typing import Any
 
 from django.template.base import Origin
@@ -8,6 +8,7 @@ from django.utils.safestring import SafeString
 from typing_extensions import TypeAlias
 
 from .base import Template
+from .context import _ContextKeys
 
 _Loader: TypeAlias = Any
 
@@ -53,5 +54,5 @@ class Engine:
     ) -> tuple[Template, Origin]: ...
     def from_string(self, template_code: str) -> Template: ...
     def get_template(self, template_name: str) -> Template: ...
-    def render_to_string(self, template_name: str, context: dict[str, Any] | None = ...) -> SafeString: ...
+    def render_to_string(self, template_name: str, context: Mapping[_ContextKeys, Any] | None = ...) -> SafeString: ...
     def select_template(self, template_name_list: list[str]) -> Template: ...

django-stubs/template/loader.pyi

@@ -7,12 +7,13 @@ from django.utils.safestring import SafeString
 
 from . import engines as engines  # noqa: F401
 from .backends.base import _EngineTemplate
+from .context import _ContextKeys
 
 def get_template(template_name: str, using: str | None = ...) -> _EngineTemplate: ...
 def select_template(template_name_list: Sequence[str] | str, using: str | None = ...) -> Any: ...
 def render_to_string(
     template_name: Sequence[str] | str,
-    context: Mapping[str, Any] | None = ...,
+    context: Mapping[_ContextKeys, Any] | None = ...,
     request: HttpRequest | None = ...,
     using: str | None = ...,
 ) -> SafeString: ...

django-stubs/template/response.pyi

@@ -1,13 +1,13 @@
 import functools
-from collections.abc import Callable, Iterator, Sequence
+from collections.abc import Callable, Iterator, Mapping, Sequence
 from http.cookies import SimpleCookie
 from typing import Any, Union  # noqa: Y037   # https://github.com/python/mypy/issues/12211
 
 from django.core.handlers.wsgi import WSGIRequest
 from django.http import HttpResponse
 from django.http.request import HttpRequest
 from django.template.base import Template
-from django.template.context import RequestContext
+from django.template.context import RequestContext, _ContextKeys
 from django.test.client import Client
 from django.utils.datastructures import _ListOrTuple
 from typing_extensions import TypeAlias
@@ -24,20 +24,20 @@ class SimpleTemplateResponse(HttpResponse):
     status_code: int
     rendering_attrs: Any
     template_name: _TemplateForResponseT
-    context_data: dict[str, Any] | None
+    context_data: Mapping[_ContextKeys, Any] | None
     using: str | None
     def __init__(
         self,
         template: _TemplateForResponseT,
-        context: dict[str, Any] | None = ...,
+        context: Mapping[_ContextKeys, Any] | None = ...,
         content_type: str | None = ...,
         status: int | None = ...,
         charset: str | None = ...,
         using: str | None = ...,
         headers: dict[str, Any] | None = ...,
     ) -> None: ...
     def resolve_template(self, template: Sequence[str] | Template | str) -> Template: ...
-    def resolve_context(self, context: dict[str, Any] | None) -> dict[str, Any] | None: ...
+    def resolve_context(self, context: Mapping[_ContextKeys, Any] | None) -> Mapping[_ContextKeys, Any] | None: ...
     @property
     def rendered_content(self) -> str: ...
     def add_post_render_callback(self, callback: Callable) -> None: ...
@@ -50,7 +50,7 @@ class TemplateResponse(SimpleTemplateResponse):
     client: Client
     closed: bool
     context: RequestContext
-    context_data: dict[str, Any] | None
+    context_data: Mapping[_ContextKeys, Any] | None
     cookies: SimpleCookie[str]
     csrf_cookie_set: bool
     json: functools.partial
@@ -65,7 +65,7 @@ class TemplateResponse(SimpleTemplateResponse):
         self,
         request: HttpRequest,
         template: _TemplateForResponseT,
-        context: dict[str, Any] | None = ...,
+        context: Mapping[_ContextKeys, Any] | None = ...,
         content_type: str | None = ...,
         status: int | None = ...,
         charset: str | None = ...,

tests/typecheck/test_shortcuts.yml

@@ -37,18 +37,6 @@
                 class MyUser(models.Model):
                     pass
 
--   case: check_render_function_arguments_annotations
-    main: |
-        from typing import Any
-        from typing_extensions import TypedDict
-        from django.shortcuts import render
-        from django.http.request import HttpRequest
-
-        TestContext = TypedDict("TestContext", {"user": Any})
-        test_context: TestContext = {"user": "test"}
-        reveal_type(test_context) # N: Revealed type is "TypedDict('main.TestContext', {'user': Any})"
-        reveal_type(render(HttpRequest(), '', test_context)) # N: Revealed type is "django.http.response.HttpResponse"
-
 -   case: check_redirect_return_annotation
     main: |
         from django.shortcuts import redirect