Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Correct documentation for <file>.read(); Python makes a serious 

best-effort to return 'size' bytes.  Point out that this may mean
multiple fread() calls.  Reported by Anders Hammarquist
<iko@iko.pp.se> via the Debian crew.
This commit is contained in:
Fred Drake 1999-04-14 14:31:53 +00:00
parent e79f5c1d2b
commit f4cbada3f9
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Doc/lib/libstdtypes.tex
View File

@ -753,12 +753,14 @@ descriptors, e.g. module \module{fcntl} or \function{os.read()} and friends.
\begin{methoddesc}[file]{read}{\optional{size}}
Read at most \var{size} bytes from the file (less if the read hits
\EOF{} or no more data is immediately available on a pipe, tty or
similar device). If the \var{size} argument is negative or omitted,
read all data until \EOF{} is reached. The bytes are returned as a string
object. An empty string is returned when \EOF{} is encountered
immediately. (For certain files, like ttys, it makes sense to
continue reading after an \EOF{} is hit.)
\EOF{} before obtaining \var{size} bytes). If the \var{size}
argument is negative or omitted, read all data until \EOF{} is
reached. The bytes are returned as a string object. An empty
string is returned when \EOF{} is encountered immediately. (For
certain files, like ttys, it makes sense to continue reading after
an \EOF{} is hit.) Note that this method may call the underlying
C function \cfunction{fread()} more than once in an effort to
acquire as close to \var{size} bytes as possible.
\end{methoddesc}
\begin{methoddesc}[file]{readline}{\optional{size}}