Skip to content

Misc improvement to the docs for itertools #119529

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 16 commits into from
May 24, 2024
Merged

Misc improvement to the docs for itertools #119529

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
ed59bc4
Simplify takewhile()
rhettinger May 23, 2024
acd55be
Tighter sentence
rhettinger May 23, 2024
376b376
Remove redundant batched() example. Improve variable name.
rhettinger May 23, 2024
ac27f16
Grammar nits.
rhettinger May 23, 2024
ded2660
Grammar nits.
rhettinger May 23, 2024
2a53903
Improve comress() text and code equivalent.
rhettinger May 23, 2024
83a4c37
Improve dropwhile() example with unique data elements
rhettinger May 23, 2024
a1a864e
Improve filterfalse() example with clearer predicate
rhettinger May 23, 2024
8fc899c
Clearer generator version of the rough code equivalent
rhettinger May 23, 2024
9724d5e
Better argument ordering in islice() equivalent
rhettinger May 23, 2024
3b8195b
Improve clarity of takewhile() example using unique inputs
rhettinger May 23, 2024
19de882
.
rhettinger May 23, 2024
743d5c2
Use map() to build the list of iterators
rhettinger May 23, 2024
163428a
.
rhettinger May 24, 2024
0b19fb6
.
rhettinger May 24, 2024
f297933
Sync the filterfalse() example with the dropwhile() example
rhettinger May 24, 2024
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
Prev Previous commit
Next Next commit
Improve clarity of takewhile() example using unique inputs
  • Loading branch information
@rhettinger
rhettinger committed May 23, 2024
commit 3b8195b6d4b9ad0f7f0b3eb36f0573aaa712e294
7 changes: 4 additions & 3 deletions Doc/library/itertools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,14 +544,15 @@ loops that truncate the stream.
the output tuples will be produced in sorted order.

Elements are treated as unique based on their position, not on their
value. So if the input elements are unique, there will be no repeated
value. So, if the input elements are unique, there will be no repeated
values within a permutation.

Roughly equivalent to::

def permutations(iterable, r=None):
# permutations('ABCD', 2) → AB AC AD BA BC BD CA CB CD DA DB DC
# permutations(range(3)) → 012 021 102 120 201 210

pool = tuple(iterable)
n = len(pool)
r = n if r is None else r
Expand All @@ -575,7 +576,7 @@ loops that truncate the stream.
return

The code for :func:`permutations` can be also expressed as a subsequence of
:func:`product`, filtered to exclude entries with repeated elements (those
:func:`product` filtered to exclude entries with repeated elements (those
from the same position in the input pool)::

def permutations(iterable, r=None):
Expand Down Expand Up @@ -669,7 +670,7 @@ loops that truncate the stream.
predicate is true. Roughly equivalent to::

def takewhile(predicate, iterable):
# takewhile(lambda x: x<5, [1,4,6,4,1]) → 1 4
# takewhile(lambda x: x<5, [1,4,6,3,8]) → 1 4
for x in iterable:
if not predicate(x):
break
Expand Down