Skip to content

gh-85864: Add missing position-only parameters #91950

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
JelleZijlstra merged 2 commits into from
Apr 30, 2022
Merged

gh-85864: Add missing position-only parameters #91950

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72bf798
Added missing position-only parameters
slateny Apr 26, 2022
e808a28
Replace square brackets with default
slateny Apr 30, 2022
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
Prev Previous commit
Replace square brackets with default
  • Loading branch information
@slateny
slateny committed Apr 30, 2022
commit e808a286a7cc858c5f82f0497bf026768fa3d344
12 changes: 6 additions & 6 deletions Doc/library/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ I/O Base Classes
A :exc:`BlockingIOError` is raised if the underlying raw stream is in
non blocking-mode, and has no data available at the moment.

.. method:: read1([size], /)
.. method:: read1(size=-1, /)

Read and return up to *size* bytes, with at most one call to the
underlying raw stream's :meth:`~RawIOBase.read` (or
Expand Down Expand Up @@ -692,7 +692,7 @@ Buffered Streams
Buffered I/O streams provide a higher-level interface to an I/O device
than raw I/O does.

.. class:: BytesIO([initial_bytes])
.. class:: BytesIO(initial_bytes=b'')

A binary stream using an in-memory bytes buffer. It inherits
:class:`BufferedIOBase`. The buffer is discarded when the
Expand Down Expand Up @@ -727,7 +727,7 @@ than raw I/O does.
Return :class:`bytes` containing the entire contents of the buffer.


.. method:: read1([size], /)
.. method:: read1(size=-1, /)

In :class:`BytesIO`, this is the same as :meth:`~BufferedIOBase.read`.

Expand Down Expand Up @@ -757,18 +757,18 @@ than raw I/O does.
:class:`BufferedReader` provides or overrides these methods in addition to
those from :class:`BufferedIOBase` and :class:`IOBase`:

.. method:: peek([size], /)
.. method:: peek(size=0, /)

Return bytes from the stream without advancing the position. At most one
single read on the raw stream is done to satisfy the call. The number of
bytes returned may be less or more than requested.

.. method:: read([size], /)
.. method:: read(size=-1, /)

Read and return *size* bytes, or if *size* is not given or negative, until
EOF or if the read call would block in non-blocking mode.

.. method:: read1([size], /)
.. method:: read1(size=-1, /)

Read and return up to *size* bytes with only one call on the raw stream.
If at least one byte is buffered, only buffered bytes are returned.
Expand Down