Skip to content

Commit 5101d97

Browse files
authored
bpo-30718: Add information about text buffering (GH-32351)
1 parent 26f2e68 commit 5101d97

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Doc/library/functions.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1165,7 +1165,11 @@ are always available. They are listed here in alphabetical order.
11651165
*buffering* is an optional integer used to set the buffering policy. Pass 0
11661166
to switch buffering off (only allowed in binary mode), 1 to select line
11671167
buffering (only usable in text mode), and an integer > 1 to indicate the size
1168-
in bytes of a fixed-size chunk buffer. When no *buffering* argument is
1168+
in bytes of a fixed-size chunk buffer. Note that specifying a buffer size this
1169+
way applies for binary buffered I/O, but ``TextIOWrapper`` (i.e., files opened
1170+
with ``mode='r+'``) would have another buffering. To disable buffering in
1171+
``TextIOWrapper``, consider using the ``write_through`` flag for
1172+
:func:`io.TextIOWrapper.reconfigure`. When no *buffering* argument is
11691173
given, the default buffering policy works as follows:
11701174

11711175
* Binary files are buffered in fixed-size chunks; the size of the buffer is

0 commit comments

Comments
 (0)