Shouldn't the return type of `__reversed__` be an `Iterable[T]` instead of `Iterator[T]`?
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 35/100
Direção de pesquisa
Comece pela definição de Reversible em stdlib/typing.pyi nas linhas vinculadas e, em seguida, compare os dois exemplos do mypy Playground na issue. Determine uma assinatura que aceite a implementação reversed mostrada, mantendo a verificação de tipos de reversed(my_iter); considera-se concluído quando ambos os erros relatados forem resolvidos sem enfraquecer o comportamento de tipagem não relacionado.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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)
- Linguagem predominante
- Python
- Estrelas
- 5.1k
- Forks
- 2.1k
- Merge médio
- 1d 19h
- PRs com merge (30d)
- 82
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de python/typeshed
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
-
project: infrastructure
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
-
stubs: improvement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Todas as issues de python/typeshed
Issues semelhantes
-
area/auth bug comp/agent P3 platform/discord type/security
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
NousResearch/hermes-agent#117848 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
bancolombia/sentinel#23 ·
-
test md AbertaCI
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100