Issue #7022: clarification of RawIOBase.read(), suggested by Pascal Chambon.

This commit is contained in:
Antoine Pitrou 2009-10-01 16:24:45 +00:00
parent 56e0966afa
commit 78ddbe69af
1 changed files with 8 additions and 5 deletions

View File

@ -326,11 +326,14 @@ I/O Base Classes
.. method:: read(n=-1)
Read and return up to *n* bytes from the stream. As a convenience, if
*n* is unspecified or -1, :meth:`readall` is called. Otherwise,
only one system call is ever made. An empty bytes object is returned
on EOF; ``None`` is returned if the object is set not to block and has
no data to read.
Read up to *n* bytes from the object and return them. As a convenience,
if *n* is unspecified or -1, :meth:`readall` is called. Otherwise,
only one system call is ever made. Fewer than *n* bytes may be
returned if the operating system call returns fewer than *n* bytes.
If 0 bytes are returned, and *n* was not 0, this indicates end of file.
If the object is in non-blocking mode and no bytes are available,
``None`` is returned.
.. method:: readall()