Flask-socketio 5.5 + add type of kwargs #13271
Merged
+30
−4
Conversation
This file contains 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.
| @@ -35,7 +61,7 @@ class SocketIO: | |||
| channel: str = "flask-socketio", | |||
| path: str = "socket.io", | |||
| resource: str = "socket.io", | |||
| **kwargs, # TODO: Socket.IO server options, Engine.IO server config | |||
| **kwargs: _SocketIOKwargs, | |||
|
|
||
| class _EngineIOServerConfig(TypedDict, total=False): | ||
| async_mode: Literal["threading", "eventlet", "gevent", "gevent_uwsgi"] | ||
| ping_interval: int # seconds |
There was a problem hiding this comment.
This can also be a two-tuple "For advanced control, a two element tuple can be given, where the first number is the ping interval and the second is a grace period added by the server."
I also suspect it can be a float instead of an int but haven't verified.
There was a problem hiding this comment.
Yeah, I think it can be float based on the test cases.
This comment has been minimized.
This comment has been minimized.
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
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.
closes #13268
The new member is a type alias for something in python-socketio (untyped) by the same author, so I don't think I can add an annotation for it.
That class's constructor has a TODO for typing the kwargs, so I added types for those. There's two groups of configs so I defined two separate typed dicts.
SocketIO options
https://github.com/miguelgrinberg/Flask-SocketIO/blob/main/src/flask_socketio/__init__.py#L82
EngineIO options
https://github.com/miguelgrinberg/Flask-SocketIO/blob/main/src/flask_socketio/__init__.py#L114