diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-10-21 23:27:41 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-21 23:27:41 (GMT) |
| commit | c835b97c5f9f057fd6346b661be32ff0b2c060e7 (patch) | |
| tree | aa0d2dc61da0809d211828be2c315ce31a39c730 | |
| parent | 68f25e261e8df51e357dc0b6660ca771eac1e87f (diff) | |
| download | cpython-c835b97c5f9f057fd6346b661be32ff0b2c060e7.zip cpython-c835b97c5f9f057fd6346b661be32ff0b2c060e7.tar.gz cpython-c835b97c5f9f057fd6346b661be32ff0b2c060e7.tar.bz2 | |
gh-51511: Note that codecs.open()'s encoding parameter affects automatic conversion to binary mode (GH-94370)
(cherry picked from commit d9407b174c81fda33e6c09a6f988c9a7cb8368af)
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
| -rw-r--r-- | Doc/library/codecs.rst | 3 | ||||
| -rw-r--r-- | Lib/codecs.py | 3 | ||||
| -rw-r--r-- | Lib/test/test_codecs.py | 3 |
3 files changed, 6 insertions, 3 deletions
diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst index 4a665f2..8225236 100644 --- a/Doc/library/codecs.rst +++ b/Doc/library/codecs.rst @@ -189,7 +189,8 @@ wider range of codecs when working with binary files: .. note:: - Underlying encoded files are always opened in binary mode. + If *encoding* is not ``None``, then the + underlying encoded files are always opened in binary mode. No automatic conversion of ``'\n'`` is done on reading and writing. The *mode* argument may be any binary mode acceptable to the built-in :func:`open` function; the ``'b'`` is automatically added. diff --git a/Lib/codecs.py b/Lib/codecs.py index e6ad6e3..3b173b6 100644 --- a/Lib/codecs.py +++ b/Lib/codecs.py @@ -878,7 +878,8 @@ def open(filename, mode='r', encoding=None, errors='strict', buffering=-1): codecs. Output is also codec dependent and will usually be Unicode as well. - Underlying encoded files are always opened in binary mode. + If encoding is not None, then the + underlying encoded files are always opened in binary mode. The default file mode is 'r', meaning to open the file in read mode. encoding specifies the encoding which is to be used for the diff --git a/Lib/test/test_codecs.py b/Lib/test/test_codecs.py index 42c600d..7cabe6a 100644 --- a/Lib/test/test_codecs.py +++ b/Lib/test/test_codecs.py @@ -709,7 +709,8 @@ class UTF16Test(ReadTest, unittest.TestCase): "spamspam", self.spambe) def test_bug691291(self): - # Files are always opened in binary mode, even if no binary mode was + # If encoding is not None, then + # files are always opened in binary mode, even if no binary mode was # specified. This means that no automatic conversion of '\n' is done # on reading and writing. s1 = 'Hello\r\nworld\r\n' |