mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-02 11:08:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

Document the rest of zlib.compressobj()'s arguments.

Browse source 
Original patch by Jim Jewett; see issue 14684.
This commit is contained in:
Nadeem Vawda 2012-06-22 01:40:49 +02:00
parent cf5e1d82e3
commit 2180c97a00
3 changed files with 36 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

22
Doc/library/zlib.rst
View file

@ -58,14 +58,28 @@ The available exception and functions in this module are:
exception if any error occurs. exception if any error occurs.
.. function:: compressobj([level[, method[, wbits[, memlevel[, strategy[, zdict]]]]]]) .. function:: compressobj(level=-1, method=DEFLATED, wbits=15, memlevel=8, strategy=Z_DEFAULT_STRATEGY, [zdict])
Returns a compression object, to be used for compressing data streams that won't Returns a compression object, to be used for compressing data streams that won't
fit into memory at once. fit into memory at once.
*level* is an integer from ``1`` to ``9`` controlling the level of *level* is the compression level -- an integer from ``1`` to ``9``. A value
compression; ``1`` is fastest and produces the least compression, ``9`` is of ``1`` is fastest and produces the least compression, while a value of
slowest and produces the most. The default value is ``6``. ``9`` is slowest and produces the most. The default value is ``6``.
*method* is the compression algorithm. Currently, the only supported value is
``DEFLATED``.
*wbits* is the base two logarithm of the size of the window buffer. This
should be an integer from ``8`` to ``15``. Higher values give better
compression, but use more memory.
*memlevel* controls the amount of memory used for internal compression state.
Valid values range from ``1`` to ``9``. Higher values using more memory,
but are faster and produce smaller output.
*strategy* is used to tune the compression algorithm. Possible values are
``Z_DEFAULT_STRATEGY``, ``Z_FILTERED``, and ``Z_HUFFMAN_ONLY``.
*zdict* is a predefined compression dictionary. This is a sequence of bytes *zdict* is a predefined compression dictionary. This is a sequence of bytes
(such as a :class:`bytes` object) containing subsequences that are expected (such as a :class:`bytes` object) containing subsequences that are expected

1
Misc/ACKS
View file

@ -503,6 +503,7 @@ Julien Jehannet
Drew Jenkins Drew Jenkins
Flemming Kjær Jensen Flemming Kjær Jensen
MunSic Jeong MunSic Jeong
Jim Jewett
Orjan Johansen Orjan Johansen
Fredrik Johansson Fredrik Johansson
Gregory K. Johnson Gregory K. Johnson

21
Modules/zlibmodule.c
View file

@ -81,13 +81,26 @@ zlib_error(z_stream zst, int err, char *msg)
} }
PyDoc_STRVAR(compressobj__doc__, PyDoc_STRVAR(compressobj__doc__,
"compressobj([level[, method[, wbits[, memlevel[, strategy[, zdict]]]]]])\n" "compressobj(level=-1, method=DEFLATED, wbits=15, memlevel=8,\n"
" strategy=Z_DEFAULT_STRATEGY[, zdict])\n"
" -- Return a compressor object.\n" " -- Return a compressor object.\n"
"\n" "\n"
"Optional arg level is the compression level, in 1-9.\n" "level is the compression level (an integer in the range 0-9; default is 6).\n"
"Higher compression levels are slower, but produce smaller results.\n"
"\n" "\n"
"Optional arg zdict is the predefined compression dictionary - a sequence of\n" "method is the compression algorithm. If given, this must be DEFLATED.\n"
"bytes containing subsequences that are likely to occur in the input data."); "\n"
"wbits is the base two logarithm of the window size (range: 8..15).\n"
"\n"
"memlevel controls the amount of memory used for internal compression state.\n"
"Valid values range from 1 to 9. Higher values result in higher memory usage,\n"
"faster compression, and smaller output.\n"
"\n"
"strategy is used to tune the compression algorithm. Possible values are\n"
"Z_DEFAULT_STRATEGY, Z_FILTERED, and Z_HUFFMAN_ONLY.\n"
"\n"
"zdict is the predefined compression dictionary - a sequence of bytes\n"
"containing subsequences that are likely to occur in the input data.");
PyDoc_STRVAR(decompressobj__doc__, PyDoc_STRVAR(decompressobj__doc__,
"decompressobj([wbits[, zdict]]) -- Return a decompressor object.\n" "decompressobj([wbits[, zdict]]) -- Return a decompressor object.\n"