summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2009-10-01 16:27:13 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2009-10-01 16:27:13 (GMT)
commitbd2a68d98396795dfffaa19f4e08f5fdf25aa981 (patch)
tree5ac6bbbcb957c475adac84b0c6129cc147a0cf5d /Doc
parent00f858516b02a700004903f2c20d1105e43fb2dc (diff)
downloadcpython-bd2a68d98396795dfffaa19f4e08f5fdf25aa981.zip
cpython-bd2a68d98396795dfffaa19f4e08f5fdf25aa981.tar.gz
cpython-bd2a68d98396795dfffaa19f4e08f5fdf25aa981.tar.bz2
Merged revisions 75168 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r75168 | antoine.pitrou | 2009-10-01 18:24:45 +0200 (jeu., 01 oct. 2009) | 3 lines Issue #7022: clarification of RawIOBase.read(), suggested by Pascal Chambon. ........
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/io.rst13
1 files changed, 8 insertions, 5 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 6432d99..5188b51 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()