mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 02:39:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Issue #15624: clarify newline documentation for open and io.TextIOWrapper

Browse source 
Thanks to Chris Jerdonek
This commit is contained in:
Andrew Svetlov 2012-08-13 12:58:02 +03:00
parent 1ef9caa2a1
commit ecd78feb78
2 changed files with 28 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Doc/library/functions.rst
View file

@ -878,18 +878,21 @@ are always available. They are listed here in alphabetical order.
mode). It can be ``None``, ``''``, ``'\n'``, ``'\r'``, and ``'\r\n'``. It mode). It can be ``None``, ``''``, ``'\n'``, ``'\r'``, and ``'\r\n'``. It
works as follows: works as follows:
* On input, if *newline* is ``None``, universal newlines mode is enabled. * When reading input from the stream, if *newline* is ``None``,
Lines in the input can end in ``'\n'``, ``'\r'``, or ``'\r\n'``, and these universal newlines mode is enabled. Lines in the input can end
are translated into ``'\n'`` before being returned to the caller. If it is in ``'\n'``, ``'\r'``, or ``'\r\n'``, and these are translated
``''``, universal newline mode is enabled, but line endings are returned to into ``'\n'`` before being returned to the caller. If it is
the caller untranslated. If it has any of the other legal values, input ``''``, universal newline mode is enabled, but line endings are
lines are only terminated by the given string, and the line ending is returned to the caller untranslated. If it has any of the other
returned to the caller untranslated. legal values, input lines are only terminated by the given
string, and the line ending is returned to the caller
untranslated.
* On output, if *newline* is ``None``, any ``'\n'`` characters written are * When writing output to the stream, if *newline* is ``None``, any
translated to the system default line separator, :data:`os.linesep`. If ``'\n'`` characters written are translated to the system default
*newline* is ``''`` or ``'\n'``, no translation takes place. If *newline* line separator, :data:`os.linesep`. If *newline* is ``''`` or
is any of the other legal values, any ``'\n'`` characters written are ``'\n'``, no translation takes place. If *newline* is any of the
other legal values, any ``'\n'`` characters written are
translated to the given string. translated to the given string.
If *closefd* is ``False`` and a file descriptor rather than a filename was If *closefd* is ``False`` and a file descriptor rather than a filename was

25
Doc/library/io.rst
View file

@ -760,18 +760,21 @@ Text I/O
*newline* controls how line endings are handled. It can be ``None``, *newline* controls how line endings are handled. It can be ``None``,
``''``, ``'\n'``, ``'\r'``, and ``'\r\n'``. It works as follows: ``''``, ``'\n'``, ``'\r'``, and ``'\r\n'``. It works as follows:
* On input, if *newline* is ``None``, universal newlines mode is enabled. * When reading input from the stream, if *newline* is ``None``,
Lines in the input can end in ``'\n'``, ``'\r'``, or ``'\r\n'``, and these universal newlines mode is enabled. Lines in the input can end
are translated into ``'\n'`` before being returned to the caller. If it is in ``'\n'``, ``'\r'``, or ``'\r\n'``, and these are translated
``''``, universal newline mode is enabled, but line endings are returned to into ``'\n'`` before being returned to the caller. If it is
the caller untranslated. If it has any of the other legal values, input ``''``, universal newline mode is enabled, but line endings are
lines are only terminated by the given string, and the line ending is returned to the caller untranslated. If it has any of the other
returned to the caller untranslated. legal values, input lines are only terminated by the given
string, and the line ending is returned to the caller
untranslated.
* On output, if *newline* is ``None``, any ``'\n'`` characters written are * When writing output to the stream, if *newline* is ``None``, any
translated to the system default line separator, :data:`os.linesep`. If ``'\n'`` characters written are translated to the system default
*newline* is ``''`` or ``'\n'``, no translation takes place. If *newline* line separator, :data:`os.linesep`. If *newline* is ``''`` or
is any of the other legal values, any ``'\n'`` characters written are ``'\n'``, no translation takes place. If *newline* is any of the
other legal values, any ``'\n'`` characters written are
translated to the given string. translated to the given string.
If *line_buffering* is ``True``, :meth:`flush` is implied when a call to If *line_buffering* is ``True``, :meth:`flush` is implied when a call to