Improve typing of view decorators

A new type variable is defined, matching (async) callables
taking a request and returning a response.

Some decorators are defined as views to comply with pyright

Author: Viicos

django-stubs/views/decorators/__init__.pyi

@@ -0,0 +1,5 @@
+from typing import TypeVar
+
+from django.utils.deprecation import _AsyncGetResponseCallable, _GetResponseCallable
+
+_ViewFuncT = TypeVar("_ViewFuncT", bound=_AsyncGetResponseCallable | _GetResponseCallable)  # noqa: PYI018

django-stubs/views/decorators/cache.pyi

@@ -1,10 +1,10 @@
 from collections.abc import Callable
-from typing import Any, TypeVar
+from typing import Any
 
-_F = TypeVar("_F", bound=Callable[..., Any])
+from . import _ViewFuncT
 
 def cache_page(
     timeout: float | None, *, cache: Any | None = ..., key_prefix: Any | None = ...
-) -> Callable[[_F], _F]: ...
-def cache_control(**kwargs: Any) -> Callable[[_F], _F]: ...
-def never_cache(view_func: _F) -> _F: ...
+) -> Callable[[_ViewFuncT], _ViewFuncT]: ...
+def cache_control(**kwargs: Any) -> Callable[[_ViewFuncT], _ViewFuncT]: ...
+def never_cache(view_func: _ViewFuncT, /) -> _ViewFuncT: ...

django-stubs/views/decorators/clickjacking.pyi

@@ -1,8 +1,5 @@
-from collections.abc import Callable
-from typing import Any, TypeVar
+from . import _ViewFuncT
 
-_F = TypeVar("_F", bound=Callable[..., Any])
-
-def xframe_options_deny(view_func: _F) -> _F: ...
-def xframe_options_sameorigin(view_func: _F) -> _F: ...
-def xframe_options_exempt(view_func: _F) -> _F: ...
+def xframe_options_deny(view_func: _ViewFuncT, /) -> _ViewFuncT: ...
+def xframe_options_sameorigin(view_func: _ViewFuncT, /) -> _ViewFuncT: ...
+def xframe_options_exempt(view_func: _ViewFuncT, /) -> _ViewFuncT: ...

django-stubs/views/decorators/common.pyi

@@ -1,6 +1,3 @@
-from collections.abc import Callable
-from typing import Any, TypeVar
+from . import _ViewFuncT
 
-_C = TypeVar("_C", bound=Callable[..., Any])
-
-def no_append_slash(view_func: _C) -> _C: ...
+def no_append_slash(view_func: _ViewFuncT, /) -> _ViewFuncT: ...

django-stubs/views/decorators/csrf.pyi

@@ -1,18 +1,14 @@
-from collections.abc import Callable
-from typing import Any, TypeVar
-
 from django.middleware.csrf import CsrfViewMiddleware
 
-csrf_protect: Callable[[_F], _F]
+from . import _ViewFuncT
+
+def csrf_protect(view_func: _ViewFuncT, /) -> _ViewFuncT: ...
 
 class _EnsureCsrfToken(CsrfViewMiddleware): ...
 
-requires_csrf_token: Callable[[_F], _F]
+def requires_csrf_token(view_func: _ViewFuncT, /) -> _ViewFuncT: ...
 
 class _EnsureCsrfCookie(CsrfViewMiddleware): ...
 
-ensure_csrf_cookie: Callable[[_F], _F]
-
-_F = TypeVar("_F", bound=Callable[..., Any])
-
-def csrf_exempt(view_func: _F) -> _F: ...
+def ensure_csrf_cookie(view_func: _ViewFuncT, /) -> _ViewFuncT: ...
+def csrf_exempt(view_func: _ViewFuncT, /) -> _ViewFuncT: ...

django-stubs/views/decorators/debug.pyi

@@ -1,9 +1,9 @@
 from collections.abc import Callable
-from typing import Any, Literal, TypeVar
+from typing import Literal
 
-_F = TypeVar("_F", bound=Callable[..., Any])
+from . import _ViewFuncT
 
 coroutine_functions_to_sensitive_variables: dict[int, Literal["__ALL__"] | tuple[str, ...]]
 
-def sensitive_variables(*variables: str) -> Callable[[_F], _F]: ...
-def sensitive_post_parameters(*parameters: str) -> Callable[[_F], _F]: ...
+def sensitive_variables(*variables: str) -> Callable[[_ViewFuncT], _ViewFuncT]: ...
+def sensitive_post_parameters(*parameters: str) -> Callable[[_ViewFuncT], _ViewFuncT]: ...

django-stubs/views/decorators/gzip.pyi

@@ -1,6 +1,3 @@
-from collections.abc import Callable
-from typing import Any, TypeVar
+from . import _ViewFuncT
 
-_C = TypeVar("_C", bound=Callable[..., Any])
-
-gzip_page: Callable[[_C], _C]
+def gzip_page(view_func: _ViewFuncT, /) -> _ViewFuncT: ...

django-stubs/views/decorators/http.pyi

@@ -1,19 +1,15 @@
 from collections.abc import Callable, Container
 from datetime import datetime
-from typing import Any, TypeVar
 
-_F = TypeVar("_F", bound=Callable[..., Any])
-
-conditional_page: Callable[[_F], _F]
-
-def require_http_methods(request_method_list: Container[str]) -> Callable[[_F], _F]: ...
-
-require_GET: Callable[[_F], _F]
-require_POST: Callable[[_F], _F]
-require_safe: Callable[[_F], _F]
+from . import _ViewFuncT
 
+def conditional_page(view_func: _ViewFuncT, /) -> _ViewFuncT: ...
+def require_http_methods(request_method_list: Container[str]) -> Callable[[_ViewFuncT], _ViewFuncT]: ...
+def require_GET(func: _ViewFuncT, /) -> _ViewFuncT: ...
+def require_POST(func: _ViewFuncT, /) -> _ViewFuncT: ...
+def require_safe(func: _ViewFuncT, /) -> _ViewFuncT: ...
 def condition(
     etag_func: Callable[..., str | None] | None = ..., last_modified_func: Callable[..., datetime | None] | None = ...
-) -> Callable[[_F], _F]: ...
-def etag(etag_func: Callable[..., str | None]) -> Callable[[_F], _F]: ...
-def last_modified(last_modified_func: Callable[..., datetime | None]) -> Callable[[_F], _F]: ...
+) -> Callable[[_ViewFuncT], _ViewFuncT]: ...
+def etag(etag_func: Callable[..., str | None]) -> Callable[[_ViewFuncT], _ViewFuncT]: ...
+def last_modified(last_modified_func: Callable[..., datetime | None]) -> Callable[[_ViewFuncT], _ViewFuncT]: ...

django-stubs/views/decorators/vary.pyi

@@ -1,7 +1,6 @@
 from collections.abc import Callable
-from typing import Any, TypeVar
 
-_F = TypeVar("_F", bound=Callable[..., Any])
+from . import _ViewFuncT
 
-def vary_on_headers(*headers: str) -> Callable[[_F], _F]: ...
-def vary_on_cookie(func: _F) -> _F: ...
+def vary_on_headers(*headers: str) -> Callable[[_ViewFuncT], _ViewFuncT]: ...
+def vary_on_cookie(func: _ViewFuncT, /) -> _ViewFuncT: ...