Simplify Traversable.open() signature #10934
Merged
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
This is necessary so that implentors can reasonanbly implement this method. For example `zipfile.Path.open()` (which is considered a `Traversable`) only supports this subset.
|
Closes: #10930 |
stdlib/importlib/abc.pyi
Outdated
| encoding: str | None = None, | ||
| errors: str | None = None, | ||
| newline: str | None = None, | ||
| ) -> IO[str]: ... |
There was a problem hiding this comment.
I wonder if we can make the return type a Protocol with a few common methods like read. To get the exact signature, could look at how importlib uses Traversable internally.
There was a problem hiding this comment.
This was my long term plan (to get rid of IO). But I don't want to look into this at this moment. Partly to keep this change small, partly because of laziness.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
The argument is named differently in both `pathlib.Path` and `zipfile.Path`.
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
|
After one or two short revisions, this is now working. |
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.
This is necessary so that implentors can reasonably implement this method. For example
zipfile.Path.open()(which is considered aTraversable) only supports this subset.Closes #10930