Skip to content
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.

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

[3.12] Modernize roundrobin() recipe and improve variable names (gh-116710) #116711

Merged
merged 1 commit into from
Mar 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 14 additions & 17 deletions Doc/library/itertools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -924,31 +924,25 @@ which incur interpreter overhead.
# grouper('ABCDEFG', 3, fillvalue='x') --> ABC DEF Gxx
# grouper('ABCDEFG', 3, incomplete='strict') --> ABC DEF ValueError
# grouper('ABCDEFG', 3, incomplete='ignore') --> ABC DEF
args = [iter(iterable)] * n
iterators = [iter(iterable)] * n
match incomplete:
case 'fill':
return zip_longest(*args, fillvalue=fillvalue)
return zip_longest(*iterators, fillvalue=fillvalue)
case 'strict':
return zip(*args, strict=True)
return zip(*iterators, strict=True)
case 'ignore':
return zip(*args)
return zip(*iterators)
case _:
raise ValueError('Expected fill, strict, or ignore')

def roundrobin(*iterables):
"Visit input iterables in a cycle until each is exhausted."
# roundrobin('ABC', 'D', 'EF') --> A D E B F C
# Recipe credited to George Sakkis
num_active = len(iterables)
nexts = cycle(iter(it).__next__ for it in iterables)
while num_active:
try:
for next in nexts:
yield next()
except StopIteration:
# Remove the iterator we just exhausted from the cycle.
num_active -= 1
nexts = cycle(islice(nexts, num_active))
# Algorithm credited to George Sakkis
iterators = map(iter, iterables)
for num_active in range(len(iterables), 0, -1):
iterators = cycle(islice(iterators, num_active))
yield from map(next, iterators)

def partition(predicate, iterable):
"""Partition entries into false entries and true entries.
Expand Down Expand Up @@ -989,10 +983,10 @@ The following recipes have a more mathematical flavor:
s = list(iterable)
return chain.from_iterable(combinations(s, r) for r in range(len(s)+1))

def sum_of_squares(it):
def sum_of_squares(iterable):
"Add up the squares of the input values."
# sum_of_squares([10, 20, 30]) --> 1400
return math.sumprod(*tee(it))
return math.sumprod(*tee(iterable))

def reshape(matrix, cols):
"Reshape a 2-D matrix to have a given number of columns."
Expand Down Expand Up @@ -1558,6 +1552,9 @@ The following recipes have a more mathematical flavor:

>>> list(roundrobin('abc', 'd', 'ef'))
['a', 'd', 'e', 'b', 'f', 'c']
>>> ranges = [range(5, 1000), range(4, 3000), range(0), range(3, 2000), range(2, 5000), range(1, 3500)]
>>> collections.Counter(roundrobin(ranges)) == collections.Counter(ranges)
True

>>> def is_odd(x):
... return x % 2 == 1
Expand Down