Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions CHANGES/13686.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Corrected the documented signature of :py:meth:`~aiohttp.StreamReader.readuntil`, which
showed a ``str`` separator although the method takes ``bytes``, and documented its
keyword-only ``max_size`` argument -- by :user:`hxperl`.
1 change: 1 addition & 0 deletions CONTRIBUTORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ Gary Leung
Gary Wilson Jr.
Gene Hoffman
Gennady Andreyev
Geonseok Lee
George Fifth
Georges Dubus
goingforstudying-ctrl
Expand Down
6 changes: 5 additions & 1 deletion docs/streams.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Reading Attributes and Methods

:return bytes: the given line

.. method:: StreamReader.readuntil(separator="\n")
.. method:: StreamReader.readuntil(separator=b"\n", *, max_size=None)
:async:

Read until separator, where `separator` is a sequence of bytes.
Expand All @@ -92,6 +92,10 @@ Reading Attributes and Methods

.. versionadded:: 3.8

:param int max_size: maximum number of bytes to buffer while searching for
*separator*; exceeding it raises ``LineTooLong``. ``None``, the default,
uses the stream's high-water limit.

:return bytes: the given data

.. method:: StreamReader.readchunk()
Expand Down
Loading