diff options
| author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-02-11 21:45:10 (GMT) |
|---|---|---|
| committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-02-11 21:45:10 (GMT) |
| commit | 30d94b7aea69440605cc7d65e06ac374c25c74c1 (patch) | |
| tree | 1f32bbd25dcd469fa0ee843e98a6eaa5bfebe616 /Doc/library/gzip.rst | |
| parent | efe7c9d4d7afef1895c2da72f4a40d934a6f8fee (diff) | |
| download | cpython-30d94b7aea69440605cc7d65e06ac374c25c74c1.zip cpython-30d94b7aea69440605cc7d65e06ac374c25c74c1.tar.gz cpython-30d94b7aea69440605cc7d65e06ac374c25c74c1.tar.bz2 | |
Issue #13989: Document that GzipFile does not support text mode.
Also, give a more helpful error message when opened with an invalid mode string.
Diffstat (limited to 'Doc/library/gzip.rst')
| -rw-r--r-- | Doc/library/gzip.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index 8aca2dd..9422ea9 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -44,9 +44,11 @@ The module defines the following items: 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'``. If - not given, the 'b' flag will be added to the mode to ensure the file is opened - in binary mode for cross-platform portability. + is the mode of *fileobj* if discernible; otherwise, the default is ``'rb'``. + + Note that the file is always opened in binary mode; text mode is not + supported. If you need to read a compressed file in text mode, wrap your + :class:`GzipFile` with an :class:`io.TextIOWrapper`. The *compresslevel* argument is an integer from ``1`` to ``9`` controlling the level of compression; ``1`` is fastest and produces the least compression, and |