From: Antoine Pitrou Date: Thu, 1 Oct 2009 16:24:45 +0000 (+0000) Subject: Issue #7022: clarification of RawIOBase.read(), suggested by Pascal Chambon. X-Git-Tag: v3.2a1~2464 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=78ddbe69af968f1161a20a27bc40dfac7a5f63db;p=thirdparty%2FPython%2Fcpython.git Issue #7022: clarification of RawIOBase.read(), suggested by Pascal Chambon. --- diff --git a/Doc/library/io.rst b/Doc/library/io.rst index 6432d99751b6..5188b51b6add 100644 --- a/Doc/library/io.rst +++ b/Doc/library/io.rst @@ -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()