Skip to content

bpo-32236: Issue RuntimeWarning if buffering=1 for open() in binary mode #4842

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 12 commits into from
Oct 20, 2018
Merged

bpo-32236: Issue RuntimeWarning if buffering=1 for open() in binary mode #4842

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2b0a0d8
bpo-32236: Don't allow buffering=1 in open() for binary mode
Dec 12, 2017
888ee4d
bpo-32236: Issue RuntimeWarning instead of raising ValueError
Dec 18, 2017
0deefe1
Clarify warning message
Sep 11, 2018
42a43c1
Remove RuntimeWarning test from test_io.py
Sep 11, 2018
164470a
Fix check for warning message
Sep 11, 2018
54c12b2
Check that no warning is emitted when buffering != 1
Sep 11, 2018
3fe49c4
Add NEWS entry
Sep 11, 2018
aff54cf
Fix warning message check in test_subprocess.py
Sep 11, 2018
cec8cd7
Update docs for codecs.open()
Sep 11, 2018
64dfd42
Fix check_no_warnings() docs to reflect what it actually does
Sep 12, 2018
2538bde
Clarify warning message
Oct 18, 2018
250adb4
Clarify a comment
Oct 18, 2018
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
Update docs for codecs.open()
  • Loading branch information
Alexey Izbyshev committed Sep 11, 2018
commit cec8cd7b3efdce65ef35acfec869d47ed18dfdba
6 changes: 3 additions & 3 deletions Doc/library/codecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ recommended approach for working with encoded text files, this module
provides additional utility functions and classes that allow the use of a
wider range of codecs when working with binary files:

.. function:: open(filename, mode='r', encoding=None, errors='strict', buffering=1)
.. function:: open(filename, mode='r', encoding=None, errors='strict', buffering=-1)

Open an encoded file using the given *mode* and return an instance of
:class:`StreamReaderWriter`, providing transparent encoding/decoding.
Expand All @@ -194,8 +194,8 @@ wider range of codecs when working with binary files:
*errors* may be given to define the error handling. It defaults to ``'strict'``
which causes a :exc:`ValueError` to be raised in case an encoding error occurs.

*buffering* has the same meaning as for the built-in :func:`open` function. It
defaults to line buffered.
*buffering* has the same meaning as for the built-in :func:`open` function.
It defaults to -1 which means that the default buffer size will be used.


.. function:: EncodedFile(file, data_encoding, file_encoding=None, errors='strict')
Expand Down
3 changes: 2 additions & 1 deletion Lib/codecs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -883,7 +883,8 @@ def open(filename, mode='r', encoding=None, errors='strict', buffering=-1):
encoding error occurs.

buffering has the same meaning as for the builtin open() API.
It defaults to line buffered.
It defaults to -1 which means that the default buffer size will
be used.

The returned wrapped file object provides an extra attribute
.encoding which allows querying the used encoding. This
Expand Down