mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-26 13:22:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Merge: #13989: Document that GzipFile does not support text mode.

Browse source
This commit is contained in:
Nadeem Vawda 2012-02-11 23:54:51 +02:00
commit d1a107132c
3 changed files with 15 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Lib/gzip.py
View file

@ -93,6 +93,9 @@ class GzipFile(io.BufferedIOBase):
"""The GzipFile class simulates most of the methods of a file object with
the exception of the readinto() and truncate() methods.
This class only supports opening files in binary mode. If you need to open a
compressed file in text mode, wrap your GzipFile with an io.TextIOWrapper.
"""
myfileobj = None
@ -119,8 +122,8 @@ class GzipFile(io.BufferedIOBase):
The mode argument can be any of 'r', 'rb', 'a', 'ab', 'w', or 'wb',
depending on whether the file will be read or written. The default
is the mode of fileobj if discernible; otherwise, the default is 'rb'.
Be aware that only the 'rb', 'ab', and 'wb' values should be used
for cross-platform portability.
A mode of 'r' is equivalent to one of 'rb', and similarly for 'w' and
'wb', and 'a' and 'ab'.
The compresslevel argument is an integer from 1 to 9 controlling the
level of compression; 1 is fastest and produces the least compression,
@ -137,8 +140,8 @@ class GzipFile(io.BufferedIOBase):
"""
# guarantee the file is opened in binary mode on platforms
# that care about that sort of thing
if mode and ('t' in mode or 'U' in mode):
raise IOError("Mode " + mode + " not supported")
if mode and 'b' not in mode:
mode += 'b'
if fileobj is None: