mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 00:48:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Issue #15677: Document that zlib and gzip accept a compression level of 0 to mean 'no compression'.

Browse source 
Patch by Brian Brazil.
This commit is contained in:
Nadeem Vawda 2012-11-11 14:04:14 +01:00
parent 12489d98e6
commit 19e568d254
5 changed files with 22 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Lib/gzip.py
View file

@ -137,9 +137,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
@ -573,7 +574,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: