FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-138703: clarify data buffer requirement of `asyncio.StreamWriter.write` by kumaraditya303 · Pull Request #139564 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

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
kumaraditya303 merged 3 commits into from
Oct 4, 2025
Conversation 14 Commits 3 Checks 47 Files changed
Merged

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

Show file tree
Hide file tree
Changes from all commits
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 .py  (1) .rst  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
5 changes: 3 additions & 2 deletions Doc/library/asyncio-stream.rst
Show comments
View file
Open in desktop
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
Show hidden characters
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
Comment thread
kumaraditya303 marked this conversation as resolved.
memoryview object.
Comment thread
kumaraditya303 marked this conversation as resolved.

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
4 changes: 2 additions & 2 deletions Lib/asyncio/selector_events.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -1050,8 +1050,8 @@ def _read_ready__on_eof(self):

def write(self, data):
if not isinstance(data, (bytes, bytearray, memoryview)):
raise TypeError(f'data argument must be a bytes-like object, '
f'not {type(data).__name__!r}')
raise TypeError(f'data argument must be a bytes, bytearray, or memoryview '
f'object, not {type(data).__name__!r}')
if self._eof:
raise RuntimeError('Cannot call write() after write_eof()')
if self._empty_waiter is not None:
Expand Down
Loading
Back | FazBrowse Home | New Git URL