Skip to content

bpo-34764: improve docs example of iter() with sentinel value #11222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rhettinger merged 9 commits into from
Dec 24, 2018
Merged

bpo-34764: improve docs example of iter() with sentinel value #11222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d96a399
improve example of iter() with 2nd arg
chris-rands Dec 18, 2018
f6f0860
change example
chris-rands Dec 23, 2018
289716f
fix missing arg in example
chris-rands Dec 23, 2018
fc05a24
do not make example doctest
chris-rands Dec 23, 2018
e15c552
match style of original example
chris-rands Dec 23, 2018
ab611eb
improve English
chris-rands Dec 23, 2018
747ee53
fix indentation
chris-rands Dec 23, 2018
b01f506
make example binary; fix indentation
chris-rands Dec 23, 2018
2e13d89
📜🤖 Added by blurb_it.
blurb-it[bot] Dec 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions Doc/library/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -810,13 +810,14 @@ are always available. They are listed here in alphabetical order.

See also :ref:`typeiter`.

One useful application of the second form of :func:`iter` is to read lines of
a file until a certain line is reached. The following example reads a file
until the :meth:`~io.TextIOBase.readline` method returns an empty string::

with open('mydata.txt') as fp:
for line in iter(fp.readline, ''):
process_line(line)
One useful application of the second form of :func:`iter` is to build a
block-reader. For example, reading fixed-width blocks from a binary
database file until the end of file is reached::

from functools import partial
with open('mydata.db', 'rb') as f:
for block in iter(partial(f.read, 64), ''):
process_block(block)


.. function:: len(s)
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2018-12-23-23-52-31.bpo-34764.DwOGeT.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve example of iter() with 2nd sentinel argument.