gh-111356: Add missing documented objects to io.__all__ - #111370
Merged
methane merged 2 commits intoNov 10, 2023
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
methane
approved these changes
Oct 30, 2023
methane
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
LGTM. Would you add NEWS entry?
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
Apologies, I thought that would not be necessary. Done now. |
Sorry, something went wrong.
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 10, 2023
…thonGH-111370) Add DEFAULT_BUFFER_SIZE, text_encoding, and IncrementalNewlineDecoder. (cherry picked from commit baeb771) Co-authored-by: Nicolas Tessore <n.tessore@ucl.ac.uk>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 10, 2023
…thonGH-111370) Add DEFAULT_BUFFER_SIZE, text_encoding, and IncrementalNewlineDecoder. (cherry picked from commit baeb771) Co-authored-by: Nicolas Tessore <n.tessore@ucl.ac.uk>
Copy link
Copy Markdown
|
GH-111935 is a backport of this pull request to the 3.12 branch. |
Sorry, something went wrong.
Copy link
Copy Markdown
|
GH-111936 is a backport of this pull request to the 3.11 branch. |
Sorry, something went wrong.
methane
pushed a commit
that referenced
this pull request
Nov 10, 2023
methane
pushed a commit
that referenced
this pull request
Nov 10, 2023
aisk
pushed a commit
to aisk/cpython
that referenced
this pull request
Feb 11, 2024
…thon#111370) Add DEFAULT_BUFFER_SIZE, text_encoding, and IncrementalNewlineDecoder.
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this pull request
Sep 2, 2024
…thon#111370) Add DEFAULT_BUFFER_SIZE, text_encoding, and IncrementalNewlineDecoder.
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
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.
This change updates io.__all__ with three missing public and documented entries: text_encoding(), DEFAULT_BUFFER_SIZE, and IncrementalNewlineDecoder.
As suggested by @AlexWaygood, I have also updated the tests to check __all__ using test.support.check__all__(). As a matter of fact, there already was test__all__() in MiscIOTest, which ostensibly checked that all exported symbols existed. It seems like the test was also designed to check some properties of the exported objects; however, these existing checks failed for me.
I have removed the existing checks and replaced them with the suggest check__all__(). I am using a few new attributes to tailor the test to CMiscIOTest and PyMiscIOTest, respectively.
Since I don't understand why existing tests would fail, some extra attention might be warranted here. There is also another detail of possible interest: IncrementalNewlineDecoder was not added to io.__all__, but was added to all_members in the test setup. This could indicate an intentional omission (albeit 15 years ago).