Skip to content

Commit

Permalink
GH-95880: Clarify StringIO append/overwrite behavior. (GH-96104) (GH-…
Browse files Browse the repository at this point in the history
  • Loading branch information
miss-islington committed Aug 21, 2022
1 parent 21c46f3 commit 58e1fe2
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions Doc/library/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1052,8 +1052,12 @@ Text I/O

The initial value of the buffer can be set by providing *initial_value*.
If newline translation is enabled, newlines will be encoded as if by
:meth:`~TextIOBase.write`. The stream is positioned at the start of
the buffer.
:meth:`~TextIOBase.write`. The stream is positioned at the start of the
buffer which emulates opening an existing file in a `w+` mode, making it
ready for an immediate write from the beginning or for a write that
would overwrite the initial value. To emulate opening a file in an `a+`
mode ready for appending, use `f.seek(0, io.SEEK_END)` to reposition the
stream at the end of the buffer.

The *newline* argument works like that of :class:`TextIOWrapper`,
except that when writing output to the stream, if *newline* is ``None``,
Expand Down

0 comments on commit 58e1fe2

Please sign in to comment.