Shouldn't the return type of `__reversed__` be an `Iterable[T]` instead of `Iterator[T]`?
还没有人认领这个 Issue。
评估
调研方向
先从链接行中的 stdlib/typing.pyi 里的 Reversible 定义开始,然后比较 issue 中的两个 mypy Playground 示例。确定一个既能接受所示 reversed 实现、又能保持 reversed(my_iter) 类型检查的签名;当两个报告的错误都得到解决,且没有削弱无关的类型行为时,即视为完成。
由索引模型根据 Issue 内容生成。
描述
Currently the return type of Reversible.__reversed__ is typed as Iterator[T], which suggests that the returned instance must have both an __next__ and an __iter__ method.
However, the following code seems to work fine at runtime:
from dataclasses import dataclass
from typing import Iterator, Iterable
@dataclass
class MyIter:
_values: list[int]
def __iter__(self) -> Iterator[int]:
return iter(self._values)
def __reversed__(self) -> Iterator[int]:
return MyIter(self._values[::-1])
my_iter = MyIter([1, 2, 3])
for x in my_iter:
print(x)
for x in reversed(my_iter):
print(x)
Note that __reversed__ here returns a MyIter instance, which has an __iter__ method, but no __next__, i.e., it is an Iterable but not an Iterator. The Python interpreter seems to deal with that fine at runtime, i.e., it doesn't actually seem to need the __next__ method. This is slightly surprising, because the docs specify:
It should return a new iterator object that iterates over all the objects in the container in reverse order.
I.e., it doesn't use the word "iterable object".
Unfortunately, the current signature of __reversed__ means that this example does not type check: Obviously the type checker has to complain about the return MyIter(...) line, because MyIter is indeed only an Iterable (example on mypy playground):
main.py:13: error: Incompatible return value type (got "MyIter", expected "Iterator[int]") [return-value]
main.py:13: note: "MyIter" is missing following "Iterator" protocol member:
main.py:13: note: __next__
Found 1 error in 1 file (checked 1 source file)
Now I'm wondering if the signature should actually be def __reversed__(self) -> Iterable[int] to lessen the requirement and match the runtime behavior?
Note that simply changing the return type to Iterable on user side means that the return statement now type checks, but then all usages (reversed(my_iter)) stop to type check because the type checker will no longer consider MyIter as a valid Reversible (modified example on mypy playground):
main.py:18: error: No overload variant of "reversed" matches argument type "MyIter" [call-overload]
main.py:18: note: Possible overload variants:
main.py:18: note: def [_T] __new__(cls, Reversible[_T], /) -> reversed[_T]
main.py:18: note: def [_T] __new__(cls, SupportsLenAndGetItem[_T], /) -> reversed[_T]
Found 1 error in 1 file (checked 1 source file)
- 主要语言
- Python
- 星标
- 5.1k
- 派生
- 2.1k
- 平均合并
- 1 天 13 小时
- 30 天内合并 PR
- 73
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
python/typeshed 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 76/100
-
project: infrastructure
难度 2/5 1-3 小时 新手友好度 68/100
-
stubs: improvement
难度 2/5 1-3 小时 新手友好度 72/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
qgis/QGIS-Documentation#11275 ·
-
bug priority:normal ready-for-dev
难度 2/5 1-3 小时 新手友好度 88/100
OpenHands/extensions#626 · 1 条评论 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
CSCfi/sd-search-api#39 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
-
难度 2/5 1-3 小时 新手友好度 68/100
StevenBlack/hosts#3255 ·