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

Merged revisions 76896 via svnmerge from 

svn+ssh://pythondev@svn.python.org/python/trunk

........
  r76896 | antoine.pitrou | 2009-12-19 22:01:10 +0100 (sam., 19 déc. 2009) | 3 lines

  Issue #7545: improve documentation of the `buffering` argument in io.open().
........
This commit is contained in:
Antoine Pitrou 2009-12-19 21:03:36 +00:00
parent 44894ed2f7
commit b976726b85
2 changed files with 28 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doc/library/io.rst
View File

@ -94,10 +94,20 @@ Module Interface
strings, the bytes having been first decoded using a platform-dependent strings, the bytes having been first decoded using a platform-dependent
encoding or using the specified *encoding* if given. encoding or using the specified *encoding* if given.
*buffering* is an optional integer used to set the buffering policy. By *buffering* is an optional integer used to set the buffering policy.
default full buffering is on. Pass 0 to switch buffering off (only allowed Pass 0 to switch buffering off (only allowed in binary mode), 1 to select
in binary mode), 1 to set line buffering, and an integer > 1 to indicate the line buffering (only usable in text mode), and an integer > 1 to indicate
size of the buffer. the size of a fixed-size chunk buffer. When no *buffering* argument is
given, the default buffering policy works as follows:
* Binary files are buffered in fixed-size chunks; the size of the buffer
is chosen using a heuristic trying to determine the underlying device's
"block size" and falling back on :attr:`DEFAULT_BUFFER_SIZE`.
On many systems, the buffer will typically be 4096 or 8192 bytes long.
* "Interactive" text files (files for which :meth:`isatty` returns True)
use line buffering. Other text files use the policy described above
for binary files.
*encoding* is the name of the encoding used to decode or encode the file. *encoding* is the name of the encoding used to decode or encode the file.
This should only be used in text mode. The default encoding is platform This should only be used in text mode. The default encoding is platform

18
Lib/io.py
View File

@ -124,10 +124,20 @@ def open(file, mode="r", buffering=None, encoding=None, errors=None,
returned as strings, the bytes having been first decoded using a returned as strings, the bytes having been first decoded using a
platform-dependent encoding or using the specified encoding if given. platform-dependent encoding or using the specified encoding if given.
buffering is an optional integer used to set the buffering policy. By buffering is an optional integer used to set the buffering policy.
default full buffering is on. Pass 0 to switch buffering off (only Pass 0 to switch buffering off (only allowed in binary mode), 1 to select
allowed in binary mode), 1 to set line buffering, and an integer > 1 line buffering (only usable in text mode), and an integer > 1 to indicate
for full buffering. the size of a fixed-size chunk buffer. When no buffering argument is
given, the default buffering policy works as follows:
* Binary files are buffered in fixed-size chunks; the size of the buffer
is chosen using a heuristic trying to determine the underlying device's
"block size" and falling back on `io.DEFAULT_BUFFER_SIZE`.
On many systems, the buffer will typically be 4096 or 8192 bytes long.
* "Interactive" text files (files for which isatty() returns True)
use line buffering. Other text files use the policy described above
for binary files.
encoding is the name of the encoding used to decode or encode the encoding is the name of the encoding used to decode or encode the
file. This should only be used in text mode. The default encoding is file. This should only be used in text mode. The default encoding is