diff options
author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-11-11 13:14:47 (GMT) |
---|---|---|
committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-11-11 13:14:47 (GMT) |
commit | 6ff262e18f7178b22b3cc6300d05a8cb008865d2 (patch) | |
tree | a536473c275798144982da06e42654c9fd7d3f13 /Lib | |
parent | c8ac03d936fd9fa7b48c0aaac01b66e8d8fcf766 (diff) | |
parent | 19e568d254bea8202703302d0ada9bc93f99331a (diff) | |
download | cpython-6ff262e18f7178b22b3cc6300d05a8cb008865d2.zip cpython-6ff262e18f7178b22b3cc6300d05a8cb008865d2.tar.gz cpython-6ff262e18f7178b22b3cc6300d05a8cb008865d2.tar.bz2 |
Issue #15677: Document that zlib and gzip accept a compression level of 0 to mean 'no compression'.
Patch by Brian Brazil.
Diffstat (limited to 'Lib')
-rw-r--r-- | Lib/gzip.py | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Lib/gzip.py b/Lib/gzip.py index d8abffd..998a8e5 100644 --- a/Lib/gzip.py +++ b/Lib/gzip.py @@ -160,9 +160,10 @@ class GzipFile(io.BufferedIOBase): 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 + The compresslevel argument is an integer from 0 to 9 controlling the level of compression; 1 is fastest and produces the least compression, - and 9 is slowest and produces the most compression. The default is 9. + and 9 is slowest and produces the most compression. 0 is no compression + at all. The default is 9. The mtime argument is an optional numeric timestamp to be written to the stream when compressing. All gzip compressed streams @@ -622,7 +623,7 @@ class GzipFile(io.BufferedIOBase): def compress(data, compresslevel=9): """Compress data in one shot and return the compressed string. - Optional argument is the compression level, in range of 1-9. + Optional argument is the compression level, in range of 0-9. """ buf = io.BytesIO() with GzipFile(fileobj=buf, mode='wb', compresslevel=compresslevel) as f: |