gh-124565: Document 'name' and 'mode' attributes for io buffered and text classes#142753
Open
killeer7002-wq wants to merge 3 commits intopython:mainfrom
Open
gh-124565: Document 'name' and 'mode' attributes for io buffered and text classes#142753killeer7002-wq wants to merge 3 commits intopython:mainfrom
killeer7002-wq wants to merge 3 commits intopython:mainfrom
Conversation
|
All commit authors signed the Contributor License Agreement. |
Member
|
Hi, according to the devguide, document changes don't need a news entry. |
killeer7002-wq
force-pushed
the
io_branch
branch
from
14b229e to
8ddf419
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Context:
As noted in gh-124565, the
nameandmodeattributes are frequently used on file objects returned byopen()(which are typically instances ofio.TextIOWrapperor buffered readers/writers). However, the documentation previously only listed these attributes forio.FileIO.Changes:
This PR updates the documentation for
io.TextIOWrapper,io.BufferedReader, andio.BufferedWriterto explicitly state that they possessnameandmodeattributes. These attributes are delegated to the underlying stream, which is behavior users rely on but wasn't clearly documented.Link:
#124565
📚 Documentation preview 📚: https://cpython-previews--142753.org.readthedocs.build/