Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Django channels stubs#13939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
huynguyengl99 wants to merge10 commits intopython:main
base:main
Choose a base branch
Loading
fromhuynguyengl99:feature/channels-stubs

Conversation

huynguyengl99
Copy link
Contributor

@huynguyengl99huynguyengl99 commentedMay 4, 2025•
edited
Loading

Tatsh, collinanderson, and deronnax reacted with thumbs up emoji
@github-actionsGitHub Actions

This comment has been minimized.

1 similar comment
@github-actionsGitHub Actions

This comment has been minimized.

@github-actionsGitHub Actions

This comment has been minimized.

1 similar comment
@github-actionsGitHub Actions

This comment has been minimized.

@huynguyengl99
Copy link
ContributorAuthor

Hi@sobolevn,
I’ve created stubs to add type hint support for django-channels. Sorry for the tag, but if you have some time, could you please take a look and share any feedback or suggestions? I’d really appreciate your input!

@github-actionsGitHub Actions

This comment has been minimized.

Copy link
Member

@sobolevnsobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I havesome concerns about addingdjango-channels totypeshed. I would like to discuss them in detail here:

  1. Sincedjango-stubs does not supportpyright and other type checkers - what will be the result of adding these types here, wherepyright andpytype are also included in the CI?
  2. What about different django versions? Doesdjango-channels have any difference between them? We (django-stubs) only support the latest django version
  3. Doesdjango-channels need any extra features? Would it benefit from a custom mypy plugin?

@Tatsh
Copy link
Contributor

Tatsh commentedMay 4, 2025•
edited
Loading

There is a very good example of usage of Channelshere.

I havesome concerns about addingdjango-channels totypeshed. I would like to discuss them in detail here:

  1. Sincedjango-stubs does not supportpyright and other type checkers - what will be the result of adding these types here, wherepyright andpytype are also included in the CI?

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.

  1. What about different django versions? Doesdjango-channels have any difference between them? We (django-stubs) only support the latest django version

They only check forDjango>=4.2.

  1. Doesdjango-channels need any extra features? Would it benefit from a custom mypy plugin?

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.

Copy link
Member

@sobolevnsobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

(not a full review)

@huynguyengl99
Copy link
ContributorAuthor

@sobolevn

  1. Sincedjango-stubs does not supportpyright and other type checkers — what will be the result of adding these types here, wherepyright andpytype are also included in the CI?

I agree with@Tatsh, and I am creating an extension package for Channels. It looks likedjango-stubs partially supports Pyright, rather than having no support at all. So for the Channels stubs themselves, it should work fine because they don’t currently require the mypy plugin — meaning the other type checkers should handle it well.

  1. What about different Django versions? Doesdjango-channels have any differences between them? We (django-stubs) only support the latest Django version.

As I mentioned in your code feedback, I think there’s no significant difference between versions because Channels only relies on some stable Django imports. I will check and aim to support at least Django 4.2 if possible. For that, I think requiringdjango-stubs >=4.2 would be the best for compatibility. Is it right or should I just use the latest 5.2 for django stubs?

  1. Doesdjango-channels need any extra features? Would it benefit from a custom mypy plugin?

I think not. However, one useful addition to the maindjango-channels package could be something likeChannelScope, which defines additional keys that can be accessed. This way, if users want to extend the scope, they can extend that type and annotate it in their code.

@Tatsh, I used to think about adding type annotations directly to Channels instead of creating a stubs package, but there’sa comment from carltongibson mentioning that type hints have been rejected in Django. So, Channels will likely follow that approach — that’s the main reason for creating the stubs.

Tatsh reacted with thumbs up emoji

@github-actionsGitHub Actions

This comment has been minimized.

@github-actionsGitHub Actions

This comment has been minimized.

@github-actionsGitHub Actions

This comment has been minimized.

@github-actionsGitHub Actions

This comment has been minimized.

Copy link
Member

@sobolevnsobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

(not a full review)

@srittausrittau linked an issueMay 12, 2025 that may beclosed by this pull request
@github-actionsGitHub Actions

This comment has been minimized.

@huynguyengl99
Copy link
ContributorAuthor

Hi@sobolevn, I have updated the code following your suggestions and left a small question related to the dispatch function in my above comment. I hope you can have a quick look at that to see if it's okay or not.

@github-actionsGitHub Actions

This comment has been minimized.

@github-actionsGitHub Actions

This comment has been minimized.

@huynguyengl99
Copy link
ContributorAuthor

Hi@sobolevn and@carltongibson, after implementing the fixes based on your feedback, do you think the code is ready to merge now, or should it be reviewed more carefully?

@github-actionsGitHub Actions
Copy link
Contributor

Diff frommypy_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]+ ...:137: 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]

@huynguyengl99
Copy link
ContributorAuthor

Hi@srittau, since there hasn’t been any additional feedback for a while and the previous comments have been addressed, do you think it’s okay to merge this now? I’m happy to make updates to this stub repo if any related issues come up in the future.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@carltongibsoncarltongibsoncarltongibson left review comments

@TatshTatshTatsh left review comments

@sobolevnsobolevnsobolevn left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Stubs package for Django Channels
4 participants
@huynguyengl99@Tatsh@carltongibson@sobolevn
[8]ページ先頭
©2009-2025 Movatter.jp