8000 Turn TextIOWrapper(buffer) into a protocol by srittau · Pull Request #11420 · python/typeshed · GitHub
[go: up one dir, main page]
Skip to content

Turn TextIOWrapper(buffer) into a protocol #11420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Feb 14, 2024
Merged

Turn TextIOWrapper(buffer) into a protocol #11420

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
9ea524b
Turn TextIOWrapper.__init__(buffer) into a protocol
srittau Feb 14, 2024
b2b7077
Add missing self arguments
srittau Feb 14, 2024
789b965
Add a todo item
srittau Feb 14, 2024
fdb4aa7
seek() is less powerful than usual
srittau Feb 14, 2024
7650976
Add a test, use properties
srittau Feb 14, 2024
6768aa3
Use more standard seek definition
srittau Feb 14, 2024
fb3ab4e
Use int for whence for now
srittau Feb 14, 2024
4325219
Add test case __init__.py files to suppress mypy error
srittau Feb 14, 2024
45478e2
Allow __init__.py files in test case directories
srittau Feb 14, 2024
ffbcde3
Work around regression test problems in a different way
srittau Feb 14, 2024
ad8461f
Make FileIO compatible
srittau Feb 14, 2024
2580cb7
Apply suggestions from code review
srittau Feb 14, 2024
36226c9
name -> Any
srittau Feb 14, 2024
de9c18d
Add a comment to the buffer attribute
srittau Feb 14, 2024
4c12b2d
Use ReadableBuffer
srittau Feb 14, 2024
7c9d035
Add detach()
srittau Feb 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Use ReadableBuffer
  • Loading branch information
@srittau
srittau committed Feb 14, 2024
commit 4c12b2db6ac271ebdf64bf07263f7bdf854c5fc2
4 changes: 2 additions & 2 deletions stdlib/io.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ class _WrappedBuffer(Protocol):
def name(self) -> Any: ...
@property
def closed(self) -> bool: ...
def read(self, size: int = ..., /) -> bytes: ...
# Optional: def read1(self, size: int, /) -> bytes: ...
def read(self, size: int = ..., /) -> ReadableBuffer: ...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
def read(self, size: int = ..., /) -> ReadableBuffer: ...
def read(self, size: int, /) -> ReadableBuffer: ...

It always calls read with an argument. Note this change makes the protocol more permissive.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to desc 8E0F ribe this comment to others. Learn more.

Unfortunately that's not true: https://github.com/python/cpython/blob/81e140d10b77f0a41a5581412e3f3471cc77981f/Modules/_io/textio.c#L1977.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a comment linking to that line in the source code?

# Optional: def read1(self, size: int, /) -> ReadableBuffer: ...
def write(self, b: bytes, /) -> object: ...
def flush(self) -> object: ...
def close(self) -> object: ...
Expand Down
0