Django channels stubs #13939
Open
Django channels stubs #13939
+617
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
huynguyengl99
force-pushed
the
feature/channels-stubs
branch
from
040b12e to
2edbaf3
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Hi @sobolevn, |
|
Diff from mypy_primer, showing the effect of this PR on open source code: strawberry (https://github.com/strawberry-graphql/strawberry)
- strawberry/channels/handlers/base.py:14: error: Cannot find implementation or library stub for module named "channels.consumer" [import-not-found]
- strawberry/channels/handlers/base.py:15: error: Cannot find implementation or library stub for module named "channels.generic.websocket" [import-not-found]
+ note: "__init_subclass__" of "object" defined here
+ strawberry/channels/handlers/base.py:57: error: Incompatible types in assignment (expression has type "ChannelsLayer | None", base class "AsyncConsumer" defined the type as "BaseChannelLayer") [assignment]
+ strawberry/channels/handlers/base.py:66: error: Argument 1 of "dispatch" is incompatible with supertype "AsyncConsumer"; supertype defines the argument type as "dict[str, Any]" [override]
+ strawberry/channels/handlers/base.py:66: note: This violates the Liskov substitution principle
+ strawberry/channels/handlers/base.py:66: note: See https://mypy.readthedocs.io/en/stable/common_issues.html#incompatible-overrides
+ strawberry/channels/handlers/base.py:77: error: Argument 1 to "dispatch" of "AsyncConsumer" has incompatible type "ChannelsMessage"; expected "dict[str, Any]" [arg-type]
+ strawberry/channels/handlers/base.py:209: error: Definition of "channel_layer" in base class "ChannelsConsumer" is incompatible with definition in base class "AsyncWebsocketConsumer" [misc]
- strawberry/channels/testing.py:13: error: Cannot find implementation or library stub for module named "channels.testing.websocket" [import-not-found]
+ strawberry/channels/testing.py:101: error: Incompatible types in assignment (expression has type "dict[str, Any]", variable has type "ConnectionAckMessage") [assignment]
+ strawberry/channels/testing.py:109: error: Incompatible types in assignment (expression has type "dict[str, Any]", variable has type "ConnectionAckMessage") [assignment]
+ strawberry/channels/testing.py:146: error: Incompatible types in assignment (expression has type "dict[str, Any]", variable has type "ConnectionInitMessage | ConnectionAckMessage | PingMessage | PongMessage | SubscribeMessage | NextMessage | ErrorMessage | CompleteMessage") [assignment]
+ strawberry/channels/handlers/ws_handler.py:69: error: Definition of "channel_layer" in base class "ChannelsConsumer" is incompatible with definition in base class "AsyncWebsocketConsumer" [misc]
+ strawberry/channels/handlers/ws_handler.py:133: error: Argument 1 to "run" of "AsyncBaseHTTPView" has incompatible type "GraphQLWSConsumer[Context, RootValue]"; expected "GraphQLWSConsumer[None, None]" [arg-type]
- strawberry/channels/handlers/http_handler.py:22: error: Cannot find implementation or library stub for module named "channels.db" [import-not-found]
- strawberry/channels/handlers/http_handler.py:23: error: Cannot find implementation or library stub for module named "channels.generic.http" [import-not-found]
+ strawberry/channels/handlers/http_handler.py:200: error: "BaseGraphQLHTTPConsumer" has no attribute "run" [attr-defined]
+ strawberry/channels/handlers/http_handler.py:207: error: Argument "headers" to "send_headers" of "AsyncHttpConsumer" has incompatible type "dict[bytes, bytes]"; expected "Iterable[tuple[bytes, bytes]] | None" [arg-type]
+ strawberry/channels/handlers/http_handler.py:360: error: Return type "Coroutine[Any, Any, ChannelsResponse | MultipartChannelsResponse]" of "run" incompatible with return type "ChannelsResponse" in supertype "SyncBaseHTTPView" [override]
- strawberry/channels/router.py:14: error: Cannot find implementation or library stub for module named "channels.routing" [import-not-found]
|
sobolevn
reviewed
May 4, 2025
There was a problem hiding this comment.
I have some concerns about adding django-channels to typeshed. I would like to discuss them in detail here:
- Since
django-stubsdoes not supportpyrightand other type checkers - what will be the result of adding these types here, wherepyrightandpytypeare also included in the CI? - What about different django versions? Does
django-channelshave any difference between them? We (django-stubs) only support the latest django version - Does
django-channelsneed any extra features? Would it benefit from a custom mypy plugin?
|
There is a very good example of usage of Channels here.
From the way I've been using Channels, it will not pull in anything that will not work properly with Pyright such as an app's models.
They only check for
I do not believe so. It is a somewhat active project so I think the typing should go in the project itself rather than here. |
sobolevn
reviewed
May 4, 2025
| @@ -0,0 +1,7 @@ | |||
| version = "4.*" | |||
| upstream_repository = "https://github.com/django/channels" | |||
| requires = ["django-stubs", "asgiref"] | |||
There was a problem hiding this comment.
Suggested change
| requires = ["django-stubs", "asgiref"] | |
| requires = ["django-stubs>=5.2,<5.3", "asgiref"] |
There was a problem hiding this comment.
Should I specify it as >=5.1 instead? It looks like Django Channels supports Django 4.2+, so I guess we can use a broader range for Django stubs to cover more versions (since Django stub 5.1 has partial support for Django 4.2). I haven’t tested it on older Django versions yet, but I guess the interface should be the same for those as well.
| requires = ["django-stubs", "asgiref"] | ||
|
|
||
| [tool.stubtest] | ||
| skip = true # due to the need of django mypy plugin config, it should be skipped. |
There was a problem hiding this comment.
please, add a # TODO: comment here
| from channels.utils import _ChannelApplication | ||
|
|
||
| # HTTP test-specific response type | ||
| class _HTTPTestResponse(TypedDict, total=False): |
There was a problem hiding this comment.
I propose adding this to new type-check only features:
Suggested change
| class _HTTPTestResponse(TypedDict, total=False): | |
| @type_check_only | |
| class _HTTPTestResponse(TypedDict, total=False): |
| from django.test.testcases import TransactionTestCase | ||
| from django.test.utils import modify_settings | ||
|
|
||
| DaphneProcess: TypeAlias = Any |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.