gh-101100: Fix sphinx reference warnings around I/O #139592
Open
+7
−7
Conversation
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
Resolves 7 warnings. Generally: "file object" -> IOBase; "binary"/`byte` read/write -> BufferedIOBase, "text"/`str` read/write -> TextIOBase Specific cases: - `EOFError` is for `input` builtin function which reads a `str`, so `TextIOBase` - `os.read` and `os.write` speak bytes but the sentence is about `sys.stdin` and `sys.stdout` which are `TextIOBase`; use the function that gets called by `sys.stdout.write`. - `os.exec`: `flush` is talking about files generally, so `IOBase` - `email.parser` is talking about binary files / `bytes` so `BufferedIOBase`
cmaloney
changed the title
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.
Resolves 7 warnings.
Generally: "file object" -> IOBase; "binary"/
byteread/write ->BufferedIOBase, "text"/strread/write ->TextIOBaseMy reasoning for specific cases (happy to change):
EOFErroris forinputbuiltin function which reads astr, soTextIOBaseos.readandos.writespeak bytes but the sentence is aboutsys.stdinandsys.stdoutwhich areTextIOBase; use the function that gets called bysys.stdout.write(TextIOBase.write).os.exec:flushis talking about files generally, soIOBaseemail.parseris talking about binary files /bytessoBufferedIOBase📚 Documentation preview 📚: https://cpython-previews--139592.org.readthedocs.build/