Skip to content

[3.11] GH-98363: Update batched() recipe in docs to match 3.12 #100323

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
merged 2 commits into from
Dec 18, 2022
Merged

[3.11] GH-98363: Update batched() recipe in docs to match 3.12 #100323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcb1dce
Update batched() recipe in docs to match 3.12
rhettinger Dec 17, 2022
af8ad77
Fix unbalanced bracket
rhettinger Dec 17, 2022
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
22 changes: 11 additions & 11 deletions Doc/library/itertools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -881,12 +881,12 @@ which incur interpreter overhead.
raise ValueError('Expected fill, strict, or ignore')

def batched(iterable, n):
"Batch data into lists of length n. The last batch may be shorter."
"Batch data into tuples of length n. The last batch may be shorter."
# batched('ABCDEFG', 3) --> ABC DEF G
if n < 1:
raise ValueError('n must be at least one')
it = iter(iterable)
while (batch := list(islice(it, n))):
while (batch := tuple(islice(it, n))):
yield batch

def triplewise(iterable):
Expand Down Expand Up @@ -1248,25 +1248,25 @@ which incur interpreter overhead.
[('a', 'b', 'c'), ('d', 'e', 'f')]

>>> list(batched('ABCDEFG', 3))
[['A', 'B', 'C'], ['D', 'E', 'F'], ['G']]
[('A', 'B', 'C'), ('D', 'E', 'F'), ('G',)]
>>> list(batched('ABCDEF', 3))
[['A', 'B', 'C'], ['D', 'E', 'F']]
[('A', 'B', 'C'), ('D', 'E', 'F')]
>>> list(batched('ABCDE', 3))
[['A', 'B', 'C'], ['D', 'E']]
[('A', 'B', 'C'), ('D', 'E')]
>>> list(batched('ABCD', 3))
[['A', 'B', 'C'], ['D']]
[('A', 'B', 'C'), ('D',)]
>>> list(batched('ABC', 3))
[['A', 'B', 'C']]
[('A', 'B', 'C')]
>>> list(batched('AB', 3))
[['A', 'B']]
[('A', 'B')]
>>> list(batched('A', 3))
[['A']]
[('A',)]
>>> list(batched('', 3))
[]
>>> list(batched('ABCDEFG', 2))
[['A', 'B'], ['C', 'D'], ['E', 'F'], ['G']]
[('A', 'B'), ('C', 'D'), ('E', 'F'), ('G',)]
>>> list(batched('ABCDEFG', 1))
[['A'], ['B'], ['C'], ['D'], ['E'], ['F'], ['G']]
[('A',), ('B',), ('C',), ('D',), ('E',), ('F',), ('G',)]
>>> s = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
>>> all(list(flatten(batched(s[:n], 5))) == list(s[:n]) for n in range(len(s)))
True
Expand Down