mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

GH-100101: Clarify documentation of zip's strict option (GH-100103)

Browse source
This commit is contained in:
JustAnotherArchivist 2022-12-28 21:24:50 +00:00 • committed by GitHub
parent c4c5790120
commit cf1c098180
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Doc/library/functions.rst
View file

@ -1923,14 +1923,24 @@ are always available. They are listed here in alphabetical order.
>>> list(zip(('a', 'b', 'c'), (1, 2, 3), strict=True))
[('a', 1), ('b', 2), ('c', 3)]
Unlike the default behavior, it checks that the lengths of iterables are
identical, raising a :exc:`ValueError` if they aren't:
Unlike the default behavior, it raises a :exc:`ValueError` if one iterable
is exhausted before the others:
>>> list(zip(range(3), ['fee', 'fi', 'fo', 'fum'], strict=True))
>>> for item in zip(range(3), ['fee', 'fi', 'fo', 'fum'], strict=True): # doctest: +SKIP
... print(item)
...
(0, 'fee')
(1, 'fi')
(2, 'fo')
Traceback (most recent call last):
...
ValueError: zip() argument 2 is longer than argument 1
..
This doctest is disabled because doctest does not support capturing
output and exceptions in the same code unit.
https://github.com/python/cpython/issues/65382
Without the ``strict=True`` argument, any bug that results in iterables of
different lengths will be silenced, possibly manifesting as a hard-to-find
bug in another part of the program.