mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-23 07:02:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

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
Doc/library/gzip.rst
View file

@ -50,9 +50,10 @@ The module defines the following items:
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
``9`` is slowest and produces the most compression. The default is ``9``.
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. ``0``
is no compression. The default is ``9``.
The *mtime* argument is an optional numeric timestamp to be written to
the stream when compressing. All :program:`gzip` compressed streams are

15
Doc/library/zlib.rst
View file

@ -51,19 +51,20 @@ The available exception and functions in this module are:
.. function:: compress(data[, level])
Compresses the bytes in *data*, returning a bytes object containing compressed data.
*level* is an integer from ``1`` to ``9`` controlling the level of compression;
``1`` is fastest and produces the least compression, ``9`` is slowest and
produces the most. The default value is ``6``. Raises the :exc:`error`
exception if any error occurs.
Compresses the bytes in *data*, returning a bytes object containing
compressed data. *level* is an integer from ``0`` to ``9`` controlling the
level of compression; ``1`` is fastest and produces the least compression,
``9`` is slowest and produces the most. ``0`` is no compression. The default
value is ``6``. Raises the :exc:`error` exception if any error occurs.
.. function:: compressobj([level])
Returns a compression object, to be used for compressing data streams that won't
fit into memory at once. *level* is an integer from ``1`` to ``9`` controlling
fit into memory at once. *level* is an integer from ``0`` to ``9`` controlling
the level of compression; ``1`` is fastest and produces the least compression,
``9`` is slowest and produces the most. The default value is ``6``.
``9`` is slowest and produces the most. ``0`` is no compression. The default
value is ``6``.
.. function:: crc32(data[, value])