Flask-SocketIO: annotate free-function signatures to match SocketIO methods#16009
Merged
srittau merged 1 commit intoJul 12, 2026
Merged
Conversation
Contributor
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
srittau
approved these changes
Jul 12, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The module-level free functions emit, join_room, leave_room, and close_room in flask_socketio/init.pyi had unannotated event/room parameters, while the equivalent SocketIO class methods already had these typed as str.
These free functions are thin wrappers around the corresponding SocketIO methods, so the types should match. Confirmed against usage examples in the upstream python-socketio documentation and existing str-typed params in namespace.pyi.