Move JsonRPCServer.start_io to high-level asyncio API
#506
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 commit introduces a new module `pygls.io_` which contains the aspects of running a message processing loop that is common to both client and servers. It contains a few protocol definitions `Reader` and `AsyncReader` which capture the expectations pygls will have when it tries to read messages from a source. It also provides `run` and `run_async` functions, both of which are modelled on the old `aio_readline` method from the `pygls.server` module. As their names suggest, these functions are responsible for running a message processing loop synchronously or asynchronously. Lastly the new `pygls.io_` module provides a `StdinAsyncReader` which allows messages to be read from stdin asynchronously, by executing the reads in a threadpool. (Just like the original `aio_readline` function) This commit also refactors the `JsonRPCServer` to make use of the new `run_async` function in its `start_io` method, removing one use of the lower-level asyncio API
alcarney
changed the title
JsonRPCServer to high-level asyncio API for start_ioJsonRPCServer.start_io to high-level asyncio API
tombh
approved these changes
Oct 26, 2024
|
Thanks! :) |
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.
Description (e.g. "Related to ...", etc.)
Now that we have end-to-end tests around all 3 supported transports (stdio, tcp, websockets). This PR starts the process of migrating the
JsonRPCServerside of pygls over to the high-level asyncio APIs.A new
pygls.io_module has been introduced to hold the I/O code that's common between the client and server sides of pygls, includingrunandrun_asyncfunctions, which host the main sync/async message processing loopStdinAsyncReaderwhich allows a server to read from stdin asynchronouslyReaderandAsyncReadertyping protocols which capture the expected shape of the message source.The client's
start_ioandstart_tcpas well as the server'sstart_iomethods have also been migrated to use the newrun_asyncfunction.Code review checklist (for code reviewer to complete)
Automated linters
You can run the lints that are run on CI locally with: