Tighten TextIOWrapper buffer types #10266
Closed
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 matches the documentation, which says: > A buffered text stream providing higher-level access to a BufferedIOBase > buffered binary stream. Cf python#10229
|
Also, the current annotations are unsound. You can pass in any |
|
Diff from mypy_primer, showing the effect of this PR on open source code: pytest (https://github.com/pytest-dev/pytest)
+ src/_pytest/capture.py:174: error: Returning Any from function declared to return "str" [no-any-return]
+ src/_pytest/capture.py:174: error: "BufferedIOBase" has no attribute "mode" [attr-defined]
+ src/_pytest/capture.py:466: error: Argument 1 to "EncodedFile" has incompatible type "IO[bytes]"; expected "BufferedIOBase" [arg-type]
+ testing/test_capture.py:1635: error: Argument 1 to "EncodedFile" has incompatible type "BinaryIO"; expected "BufferedIOBase" [arg-type]
rich (https://github.com/Textualize/rich)
+ rich/progress.py:1363: error: Argument 1 to "TextIOWrapper" has incompatible type "_Reader"; expected "BufferedIOBase" [arg-type]
urllib3 (https://github.com/urllib3/urllib3)
+ src/urllib3/util/ssltransport.py:165: error: Argument 1 to "TextIOWrapper" has incompatible type "BinaryIO"; expected "BufferedIOBase" [arg-type]
streamlit (https://github.com/streamlit/streamlit)
- lib/tests/streamlit/web/server/component_request_handler_test.py:161:38: error: Argument 1 to "TextIOWrapper" has incompatible type "str"; expected "IO[bytes]" [arg-type]
+ lib/tests/streamlit/web/server/component_request_handler_test.py:161:38: error: Argument 1 to "TextIOWrapper" has incompatible type "str"; expected "BufferedIOBase" [arg-type]
black (https://github.com/psf/black)
+ src/black/__init__.py:844:17: error: Argument 1 to "TextIOWrapper" has incompatible type "BinaryIO"; expected "BufferedIOBase" [arg-type]
+ src/black/__init__.py:888:13: error: Argument 1 to "TextIOWrapper" has incompatible type "BinaryIO"; expected "BufferedIOBase" [arg-type]
cwltool (https://github.com/common-workflow-language/cwltool)
+ cwltool/main.py:55: note: In module imported here:
+ cwltool/cwlprov/writablebagfile.py: note: In function "write_bag_file":
+ cwltool/cwlprov/writablebagfile.py:119:30: error: Argument 1 to "TextIOWrapper" has incompatible type "BinaryIO"; expected "BufferedIOBase" [arg-type]
+ cwltool/main.py: note: In function "main":
+ cwltool/main.py:965:43: error: Argument 1 to "TextIOWrapper" has incompatible type "BinaryIO"; expected "BufferedIOBase" [arg-type]
|
|
I'd be interested to see the mypy_primer results if we tried making it generic. It might be very disruptive, but it also might not. |
|
Ok, not sure why I replicated @JelleZijlstra's issue #10229. I tried to actually address one of the suggestions I made in there, but accidentally replicated it mostly. Although this PR is a little but more extensive, as it also adds |
|
I suggest we merge the two other PRs first, rerun the tests here and then I'll also do a test with a generic |
srittau
added a commit
to JelleZijlstra/typeshed
that referenced
this pull request
Jun 6, 2023
Incorporates changes from python#10266, so we don't have two PRs open.
|
I merged the additional changes into #10229, closing this here. |
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 matches the documentation, which says:
Cf #10229