Add type_check_only, TODO comment, and constrain django-stubs version

Author: huynguyengl99

stubs/channels/METADATA.toml

@@ -1,7 +1,7 @@
 version = "4.*"
 upstream_repository = "https://github.com/django/channels"
-requires = ["django-stubs", "asgiref"]
+requires = ["django-stubs>=4.2,<5.3", "asgiref"]
 
 [tool.stubtest]
-skip = true  # due to the need of django mypy plugin config, it should be skipped.
+skip = true  # TODO: enable stubtest once Django mypy plugin config is supported
 stubtest_requirements = ["daphne"]

stubs/channels/channels/routing.pyi

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, type_check_only
 
 from asgiref.typing import ASGIReceiveCallable, ASGISendCallable
 from django.urls.resolvers import URLPattern
@@ -14,6 +14,7 @@ class ProtocolTypeRouter:
     def __init__(self, application_mapping: dict[str, Any]) -> None: ...
     async def __call__(self, scope: _ChannelScope, receive: ASGIReceiveCallable, send: ASGISendCallable) -> None: ...
 
+@type_check_only
 class _ExtendedURLPattern(URLPattern):
     callback: _ASGIApplicationProtocol | URLRouter
 

stubs/channels/channels/testing/http.pyi

@@ -1,5 +1,5 @@
 from collections.abc import Iterable
-from typing import Literal, TypedDict
+from typing import Literal, TypedDict, type_check_only
 
 from channels.testing.application import ApplicationCommunicator
 from channels.utils import _ChannelApplication
@@ -10,6 +10,7 @@ class _HTTPTestResponse(TypedDict, total=False):
     headers: Iterable[tuple[bytes, bytes]]
     body: bytes
 
+@type_check_only
 class _HTTPTestScope(TypedDict, total=False):
     type: Literal["http"]
     http_version: str

stubs/channels/channels/testing/live.pyi

@@ -10,7 +10,7 @@ from django.db.backends.sqlite3.base import DatabaseWrapper
 from django.test.testcases import TransactionTestCase
 from django.test.utils import modify_settings
 
-DaphneProcess: TypeAlias = Any
+DaphneProcess: TypeAlias = Any  # TODO: temporary hack for daphne.testing.DaphneProcess; remove once daphne provides types
 
 _StaticWrapper: TypeAlias = Callable[[ProtocolTypeRouter], _ChannelApplication]
 

stubs/channels/channels/testing/websocket.pyi

@@ -1,11 +1,12 @@
 from collections.abc import Iterable
-from typing import Any, Literal, TypedDict, overload
+from typing import Any, Literal, TypedDict, overload, type_check_only
 from typing_extensions import NotRequired, TypeAlias
 
 from asgiref.typing import ASGIVersions
 from channels.testing.application import ApplicationCommunicator
 from channels.utils import _ChannelApplication
 
+@type_check_only
 class _WebsocketTestScope(TypedDict, total=False):
     spec_version: int
     type: Literal["websocket"]

stubs/channels/channels/utils.pyi

@@ -1,5 +1,5 @@
 from collections.abc import Awaitable, Callable
-from typing import Any, Protocol
+from typing import Any, Protocol, type_check_only
 from typing_extensions import TypeAlias
 
 from asgiref.typing import ASGIApplication, ASGIReceiveCallable
@@ -8,7 +8,7 @@ def name_that_thing(thing: Any) -> str: ...
 async def await_many_dispatch(
     consumer_callables: list[Callable[[], Awaitable[ASGIReceiveCallable]]], dispatch: Callable[[dict[str, Any]], Awaitable[None]]
 ) -> None: ...
-
+@type_check_only
 class _MiddlewareProtocol(Protocol):
     def __init__(self, *args: Any, **kwargs: Any) -> None: ...
     async def __call__(self, scope: Any, receive: Any, send: Any) -> Any: ...