This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author Jim.Jewett
Recipients Jim.Jewett, Sam.Rushing, eric.araujo, jcea, nadeem.vawda, python-dev
Date 2012-06-21.15:24:38
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1340292280.86.0.0366771541179.issue14684@psf.upfronthosting.co.za>
In-reply-to
Content
Just saw this on the checkins list; where are the other options documented? 

"""
  PyDoc_STRVAR(compressobj__doc__,
-"compressobj([level]) -- Return a compressor object.\n"
+"compressobj([level[, method[, wbits[, memlevel[, strategy[, zdict]]]]]])\n"
+" -- Return a compressor object.\n"
 "\n"
-"Optional arg level is the compression level, in 1-9.");
+"Optional arg level is the compression level, in 1-9.\n"
+"\n"
+"Optional arg zdict is the predefined compression dictionary - a sequence of\n"
+"bytes containing subsequences that are likely to occur in the input data.");
"""

I'm honestly not certain what they should be, but the following is my best guess:

"""
 PyDoc_STRVAR(compressobj__doc__,
 "compressobj([level[, method[, wbits[, memlevel[, strategy[, zdict]]]]]])\n"
 " -- Return a compressor object.\n"
 "\n"
-"Optional arg level is the compression level, in 1-9.\n"
+"Optional arg level (1-9) is the compression level.\n"
+"Larger numbers take longer, but produce smaller results.\n"
 "\n"
+"Optional arg method is the compression method.\n"
+"The only currently supported method is zlib.DEFLATED.\n"
+"\n"
+"Optional arg wbits determines the window buffer size.\n"
+"Normal values are 8 (least memory) to 15 (best compression).\n"
+"\n"
+"Optional arg memlevel (1-9) controls working memory size.\n"
+"Larger numbers use more memory, but produce smaller results more quickly.\n"
+"\n"
+"Optional arg strategy tunes the compression algorithm.\n"
+"Supported options include zlib.Z_DEFAULT_STRATEGY, zlib.Z_FILTERED, and zlib.Z_HUFFMAN_ONLY.\n"
+"\n"
+"Optional arg zdict is the predefined compression dictionary - a sequence of\n"
+"bytes containing subsequences that are likely to occur in the input data.");
"""
History
Date User Action Args
2012-06-21 15:24:41Jim.Jewettsetrecipients: + Jim.Jewett, jcea, nadeem.vawda, eric.araujo, python-dev, Sam.Rushing
2012-06-21 15:24:40Jim.Jewettsetmessageid: <1340292280.86.0.0366771541179.issue14684@psf.upfronthosting.co.za>
2012-06-21 15:24:40Jim.Jewettlinkissue14684 messages
2012-06-21 15:24:38Jim.Jewettcreate