Commit d378b1f8 authored by Chris Rands's avatar Chris Rands Committed by Raymond Hettinger

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

parent 8874f511
......@@ -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)
......
Improve example of iter() with 2nd sentinel argument.
\ No newline at end of file
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