maximum arity of itertools.product() is hardcoded to 10. document, increase, or print a warning?
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 5.1k
- 派生
- 2.1k
- 平均合并
- 1 天 19 小时
- 30 天内合并 PR
- 82
描述
Hi,
for reasons that I can't control, I have to support a software that calls itertools.product() with an arity greater than 10. I use mypy (currently 1.15.0) and python 3.13.1, but the problem is largely independent from the software versions.
It took me a couple of days to realize that this case is not supported, because the maximum arity for itertools.product() is controlled by 10 manually written overloads, one for each arity.
For example, the overload for product()/10 is here:
The problem I faced is that the type checker (mypy 1.14.x and 1.15.x in my case), instead of clearly asserting that it could not work with arities greater than 10, spit out wrong deductions (see the example later on).
The obvious desiderata here would be not having to rely on any hardcoded overloads and support functions of arbitrary arity. I suppose this requires a more powerful type system, or checker, or both. In each case I do not expect it to happen in a short time, right?
However, it took me a couple of days to realize the existence of this limitation in the type deduction of itertools.product(), because I kept trying to find a bug in the code I have to maintain; I'd like to spare this suffering to future users.
Do you think at least one of the following is possible?
- find a way to cause a warning in the type checkers, so that users know that they are experiencing a limitation in the stubs/type checker and not in their code
- increment the number of supported overloads for
itertools.product()from 10 to 15, so that the limitation is hit more rarely. I have manually altereditertools.pyiin my venv, and it makes mypy happy (and cause misery to the idealists among us) - document the limitation on the maximum arity of
itertools.product(), for example in https://typing.readthedocs.io/
If 2. is acceptable, I am willing to submit a PR. With enough hand holding, I could also contribute point 3, if it helps.
Thank you very much.
Example of a program that breaks badly when iterable_11 is uncommented:
from itertools import product
from typing import Literal
def f(
iterable_01: tuple[Literal["one"]] | list[int],
iterable_02: list[Literal[2]],
iterable_03: list[Literal[3]],
iterable_04: list[Literal[4]],
iterable_05: list[Literal[5]],
iterable_06: list[Literal[6]],
iterable_07: list[Literal[7]],
iterable_08: list[Literal[8]],
iterable_09: list[Literal[9]],
iterable_10: list[Literal[10]] | tuple[None, Literal[10]],
# iterable_11: list[Literal[11]],
) -> None:
for (
elem_01,
elem_02,
elem_03,
elem_04,
elem_05,
elem_06,
elem_07,
elem_08,
elem_09,
elem_10,
# elem_11,
) in product(
iterable_01,
iterable_02,
iterable_03,
iterable_04,
iterable_05,
iterable_06,
iterable_07,
iterable_08,
iterable_09,
iterable_10,
# iterable_11,
):
reveal_type(elem_01)
reveal_type(elem_02)
reveal_type(elem_03)
reveal_type(elem_04)
reveal_type(elem_05)
reveal_type(elem_06)
reveal_type(elem_07)
reveal_type(elem_08)
reveal_type(elem_09)
reveal_type(elem_10)
Type checking with 10 arguments and correct type deduction:
$ mypy itertools_product.py
itertools_product.py:43: note: Revealed type is "Literal['one']"
itertools_product.py:44: note: Revealed type is "Literal[2]"
itertools_product.py:45: note: Revealed type is "Literal[3]"
itertools_product.py:46: note: Revealed type is "Literal[4]"
itertools_product.py:47: note: Revealed type is "Literal[5]"
itertools_product.py:48: note: Revealed type is "Literal[6]"
itertools_product.py:49: note: Revealed type is "Literal[7]"
itertools_product.py:50: note: Revealed type is "Literal[8]"
itertools_product.py:51: note: Revealed type is "Literal[9]"
itertools_product.py:52: note: Revealed type is "Union[Literal[10], None]"
Success: no issues found in 1 source file
Type checkng with 11 arguments and incorrect type deduction (this is random: sometimes mypy writes builtins.object, instead):
$ mypy itertools_product.py
itertools_product.py:43: note: Revealed type is "Union[Literal['one'], builtins.int, None]" <-- wider, but wrong
itertools_product.py:44: note: Revealed type is "Union[Literal['one'], builtins.int, None]" <-- completely wrong
itertools_product.py:45: note: Revealed type is "Union[Literal['one'], builtins.int, None]" [...]
itertools_product.py:46: note: Revealed type is "Union[Literal['one'], builtins.int, None]" [...]
itertools_product.py:47: note: Revealed type is "Union[Literal['one'], builtins.int, None]" [...]
itertools_product.py:48: note: Revealed type is "Union[Literal['one'], builtins.int, None]" [...]
itertools_product.py:49: note: Revealed type is "Union[Literal['one'], builtins.int, None]" [...]
itertools_product.py:50: note: Revealed type is "Union[Literal['one'], builtins.int, None]" [...]
itertools_product.py:51: note: Revealed type is "Union[Literal['one'], builtins.int, None]" [...]
itertools_product.py:52: note: Revealed type is "Union[Literal['one'], builtins.int, None]" <-- completely wrong
Success: no issues found in 1 source file
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 issue 中链接的 product() 重载附近的 stdlib/itertools.pyi 开始,然后使用 mypy 运行提供的十参数和十一参数示例,以重现推导差异。在决定贡献应扩展重载、记录该限制还是寻求警告之前,查看提到的 typing.readthedocs.io 位置和讨论;完成意味着已就所选方案达成一致,并演示了其行为。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- tooling
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100