Commit 05c35a6a authored by R David Murray's avatar R David Murray

#15554: clarify splitlines/split differences.

Patch by Chris Jerdonek.
parent 9b000e7a
...@@ -1327,16 +1327,19 @@ functions based on regular expressions. ...@@ -1327,16 +1327,19 @@ functions based on regular expressions.
.. method:: str.splitlines([keepends]) .. method:: str.splitlines([keepends])
Return a list of the lines in the string, breaking at line boundaries. Line Return a list of the lines in the string, breaking at line boundaries.
breaks are not included in the resulting list unless *keepends* is given and This method uses the universal newlines approach to splitting lines.
true. This method uses the universal newlines approach to splitting lines. Line breaks are not included in the resulting list unless *keepends* is
Unlike :meth:`~str.split`, if the string ends with line boundary characters given and true.
the returned list does ``not`` have an empty last element.
For example, ``'ab c\n\nde fg\rkl\r\n'.splitlines()`` returns For example, ``'ab c\n\nde fg\rkl\r\n'.splitlines()`` returns
``['ab c', '', 'de fg', 'kl']``, while the same call with ``splitlines(True)`` ``['ab c', '', 'de fg', 'kl']``, while the same call with ``splitlines(True)``
returns ``['ab c\n', '\n, 'de fg\r', 'kl\r\n']``. returns ``['ab c\n', '\n, 'de fg\r', 'kl\r\n']``.
Unlike :meth:`~str.split` when a delimiter string *sep* is given, this
method returns an empty list for the empty string, and a terminal line
break does not result in an extra line.
.. method:: str.startswith(prefix[, start[, end]]) .. method:: str.startswith(prefix[, start[, end]])
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment