diff options
| author | Antoine Pitrou <solipsis@pitrou.net> | 2009-12-19 21:09:58 (GMT) |
|---|---|---|
| committer | Antoine Pitrou <solipsis@pitrou.net> | 2009-12-19 21:09:58 (GMT) |
| commit | 45a437269edb8c9d5bee135c1f57ba2f637909e1 (patch) | |
| tree | 7691fa8045e6c7d77c0317151032b484741a849f /Lib | |
| parent | b1a1810ece6abedf9b218c76820cc78c367d2715 (diff) | |
| download | cpython-45a437269edb8c9d5bee135c1f57ba2f637909e1.zip cpython-45a437269edb8c9d5bee135c1f57ba2f637909e1.tar.gz cpython-45a437269edb8c9d5bee135c1f57ba2f637909e1.tar.bz2 | |
Merged revisions 76900 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k
................
r76900 | antoine.pitrou | 2009-12-19 22:08:31 +0100 (sam., 19 déc. 2009) | 13 lines
Merged revisions 76896,76898 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().
........
r76898 | antoine.pitrou | 2009-12-19 22:06:36 +0100 (sam., 19 déc. 2009) | 3 lines
Remove superfetatory paragraph (left there by mistake).
........
................
Diffstat (limited to 'Lib')
| -rw-r--r-- | Lib/_pyio.py | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/Lib/_pyio.py b/Lib/_pyio.py index 5458f99..2458e40 100644 --- a/Lib/_pyio.py +++ b/Lib/_pyio.py @@ -82,10 +82,20 @@ def open(file: (str, bytes), mode: str = "r", buffering: int = None, returned as strings, the bytes having been first decoded using a platform-dependent encoding or using the specified encoding if given. - buffering is an optional integer used to set the buffering policy. By - default full buffering is on. Pass 0 to switch buffering off (only - allowed in binary mode), 1 to set line buffering, and an integer > 1 - for full buffering. + buffering is an optional integer used to set the buffering policy. + Pass 0 to switch buffering off (only allowed in binary mode), 1 to select + line buffering (only usable in text mode), and an integer > 1 to indicate + 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 file. This should only be used in text mode. The default encoding is |