8000 gh-127647: Add typing.Reader and Writer protocols by srittau · Pull Request #127648 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-127647: Add typing.Reader and Writer protocols #127648

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 37 commits into from
Mar 6, 2025
Merged

gh-127647: Add typing.Reader and Writer protocols #127648

Changes from 1 commit
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
b45fec0
Add typing.Reader and Writer protocols
srittau Dec 5, 2024
1525e05
Add a note about Iterable
srittau Dec 5, 2024
7867ec1
Fix docs formatting
srittau Dec 5, 2024
6a22a02
Small wording improvements
srittau Dec 5, 2024
5d632a3
Simplify the docs/improve formatting
srittau Dec 5, 2024
4d50c2e
Explicitly document the methods
srittau Dec 5, 2024
1e1ea41
Mark protocol members as abstract
srittau Dec 6, 2024
56a38a0
Add .. versionadded
srittau Dec 6, 2024
f2c331b
Added slashes to documented signatures
srittau Dec 6, 2024
6764b6a
Fix overindentation
srittau Dec 6, 2024
022acaa
Fix documentation of Reader.__iter__()
srittau Dec 6, 2024
b86073d
Remove the @runtime_checkable flags
srittau Dec 6, 2024
65eb040
Merge branch 'main' into typing-readable-writable
srittau Jan 6, 2025
2b9159d
Merge branch 'main' into typing-readable-writable
srittau Feb 25, 2025
1f42b21
Remove Reader.__iter__() and readline()
srittau Feb 25, 2025
0325f5a
Move protocols to io
srittau Feb 25, 2025
632511a
Update whatsnew
srittau Feb 25, 2025
3b384f9
Update NEWS file
srittau Feb 25, 2025
5bdb4cc
Fix abstractmethod import
srittau Feb 25, 2025
35dcaf4
Fix runtime_checkable link in docs
srittau Feb 25, 2025
5584a57
Add Reader and Writer to proto allowlist
srittau Feb 25, 2025
af81301
Import Reader and Writer into _pyio
srittau Feb 25, 2025
5a8b915
Import _collections_abc dynamically
srittau Feb 25, 2025
b1593fa
Merge branch 'main' into typing-readable-writable
srittau Feb 25, 2025
577b893
Use metaclass instead of deriving from `ABC`
srittau Feb 25, 2025
cedfa42
Use __class_getitem__ instead of making the class generic
srittau Feb 25, 2025
a0b9e47
Remove type annotations
srittau Feb 25, 2025
53a2250
Move import back to top level
srittau Feb 25, 2025
03aa3a2
Merge branch 'main' into typing-readable-writable
srittau Feb 27, 2025
ca72c19
Fix doc reference to decorator
srittau Feb 27, 2025
3b5975e
Fix references in docs
srittau Feb 27, 2025
96080fe
Split signature
srittau Feb 27, 2025
3723370
Document that Reader and Writer are generic
srittau Feb 27, 2025
76003a8
Add tests
srittau Feb 27, 2025
43e23f0
Add missing import
srittau Feb 27, 2025
c644770
Doc fixes
srittau Feb 27, 2025
bfab2fd
Merge branch 'main' into typing-readable-writable
srittau Mar 6, 2025
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
Added slashes to documented signatures
  • Loading branch information
@srittau
srittau committed Dec 6, 2024
commit f2c331b2103f014b72bcce386383ba19e901b581
6 changes: 3 additions & 3 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2825,12 +2825,12 @@ decorated with :func:`@runtime_checkable <runtime_checkable>`.

.. versionadded:: next

.. method:: read(size=...)
.. method:: read(size=..., /)

Read data from the input stream and return it. If ``size`` is
specified, at most ``size`` items (bytes/characters) will be read.

.. method:: readline(size=...)
.. method:: readline(size=..., /)

Read a line of data from the input stream and return it. If ``size`` is
specified, at most ``size`` items (bytes/characters) will be read.
Expand All @@ -2852,7 +2852,7 @@ decorated with :func:`@runtime_checkable <runtime_checkable>`.

.. versionadded:: next

.. method:: write(data)
.. method:: write(data, /)

Write data to the output stream and return number of items
(bytes/characters) written.
Expand Down
0