NotificationsYou must be signed in to change notification settings
Fork33.7k
Star70.4k

gh-124565: Document 'name' and 'mode' attributes for io buffered and text classes#142753

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Open

killeer7002-wq wants to merge3 commits intopython:main

base:main

Choose a base branch

fromkilleer7002-wq:io_branch

Open

gh-124565: Document 'name' and 'mode' attributes for io buffered and text classes#142753

killeer7002-wq wants to merge3 commits intopython:mainfromkilleer7002-wq:io_branch

Conversation

Copy link

killeer7002-wq commentedDec 15, 2025•
edited by github-actionsbot
Loading

Context:
As noted ingh-124565, thename andmode attributes are frequently used on file objects returned byopen() (which are typically instances ofio.TextIOWrapper or buffered readers/writers). However, the documentation previously only listed these attributes forio.FileIO.

Changes:
This PR updates the documentation forio.TextIOWrapper,io.BufferedReader, andio.BufferedWriter to explicitly state that they possessname andmode attributes. 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/