Changing return type of __iter__ to Iterator.
#99
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johanols
requested review from
siboehm,
mlondschien,
xhochy and
fjetter
as code owners
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #99 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 32 32
Lines 1993 1993
=====================================
Misses 1993 1993 ☔ View full report in Codecov by Sentry. |
The previous return type of `Iterable` is incorrect as can be seen in this example: https://docs.python.org/3/library/typing.html#nominal-vs-structural-subtyping Also this documentation mentions that `__iter__` returns the iterator object itself: https://docs.python.org/3/library/stdtypes.html#iterator.__iter__ The incorrect `Iterable` type causes numerous of error when analyzed by a static type checker such as `mypy`. The switch to `Iterator` solves these issues.
johanols
force-pushed
the
changing-iterator-typing
branch
from
9393b24 to
104ad9f
Compare
xhochy
approved these changes
Nov 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The previous return type of
Iterableis incorrect as can be seen in this example:https://docs.python.org/3/library/typing.html#nominal-vs-structural-subtyping
Also this documentation mentions that
__iter__returns the iterator object itself:https://docs.python.org/3/library/stdtypes.html#iterator.__iter__
The incorrect
Iterabletype causes numerous of error when analyzed by a static type checker such asmypy. The switch toIteratorsolves these issues.Checklist
docs/changes.rstentry