plugin.api: implement WebsocketClient #4153
Merged
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
- bump websocket-client requirement to >=1.2.1,<2.0 - avoid circular import by importing HTTPSession in session directly - implement a common WebsocketClient based on the WebSocketApp API of websocket-client, so that plugins don't have to re-implement basic boilerplate code - automatically apply User-Agent header - automatically apply proxy settings - set websocket log level (globally) - add tests
This was referenced Nov 6, 2021
Billy2011
added a commit
to Billy2011/streamlink-27
that referenced
this pull request
Nov 9, 2021
- avoid circular import by importing HTTPSession in session directly - implement a common WebsocketClient based on the WebSocketApp API of websocket-client, so that plugins don't have to re-implement basic boilerplate code - automatically apply User-Agent header - automatically apply proxy settings - set websocket log level (globally) - add tests Update websocket.py
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.
websocket-client, so that plugins don't have to re-implement basic
boilerplate code
This is a simple wrapper for
websocket-client'sWebSocketAppclass, which sets the HTTP header of the initialization request and which sets the HTTP proxy options from the session instance. The tests therefore don't test any actual websocket functionality, only the correct usage of theWebSocketAppAPI.Another important change is the update of the
websocket-clientversion requirement from>=0.58.0to>=1.2.1,<2.0. Their 1.0.0 release dropped support for py2, so this won't affect Streamlink, but some parameters were added between 1.0.0 and 1.2.1, so I had to bump the requirement.There are three plugins which are currently implementing websockets:
nicolive- via the high levelWebSocketAppAPIRetrieves the HLS URL from the websocket connection and needs to send custom pong/keep-alive responses
bastimeyer:plugin/api/websocket...bastimeyer:plugins/nicolive/rewrite
twitcasting- via high levelWebSocketAppAPIStream data is served via the websocket connection
bastimeyer:plugin/api/websocket...bastimeyer:plugins/twitcasting/websocket
ustreamtv- via the low levelcreate_connectionAPIRetrieves stream segment URLs from the websocket connection
This PR does not update the plugins. I will do this in separate PRs. I've already finished nicolive (complete rewrite) and twitcasting (websocket and custom stream class replacement). ustreamtv requires a complete rewrite as well and I'm still working on it (see #4040). I'm opening this PR now because I'm quite confident that ustreamtv won't require any further changes in the
WebsocketClient.