Skip to content

gh-138703: clarify data buffer requirement of asyncio.StreamWriter.write #139564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 4, 2025
Merged

gh-138703: clarify data buffer requirement of asyncio.StreamWriter.write #139564

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3568f2a
further clarify docs
kumaraditya303 Oct 4, 2025
cac6d40
improve err msg
kumaraditya303 Oct 4, 2025
f7b2433
Update Lib/asyncio/selector_events.py
kumaraditya303 Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Doc/library/asyncio-stream.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,13 +316,14 @@ StreamWriter
If that fails, the data is queued in an internal write buffer until it can be
sent.

The *data* buffer should be a bytes, bytearray, or C-contiguous one-dimensional
memoryview object.

The method should be used along with the ``drain()`` method::

stream.write(data)
await stream.drain()

.. note::
The *data* buffer should be a C contiguous one-dimensional :term:`bytes-like object <bytes-like object>`.

.. method:: writelines(data)

Expand Down
Loading