Add await writer.drain() after writer.write() for proper flow control #126
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.
Summary
This PR adds
await writer.drain()
afterwriter.write()
calls to ensure proper flow control and prevent potential data loss or write buffer overflows when interacting withasyncio
streams.Rationale
According to the Python asyncio documentation,
writer.write()
only queues data, and it’s necessary to call awaitwriter.drain()
to ensure the data is properly written when the internal buffer is full. Thedrain()
method blocks when the buffer is full, preventing overflows and ensuring all data is transmitted before continuing execution. Without this, there is a risk of data not being fully sent or written.This change ensures the write buffer is correctly managed, especially in cases of high-volume or rapid write operations, maintaining stream reliability and preventing potential issues in production environments.