Provide compress/uncompress functions on the gzip module

[pythonhacker]

BPO	3488
Nosy	@gpshead, @jcea, @pitrou
Files	test_gzip_svn_diff.patch gzip.py.svndiff gzip.rst.svndiff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2010-08-17.21:13:39.358>
created_at = <Date 2008-08-01.17:56:55.725>
labels = ['type-feature', 'library']
title = 'Provide compress/uncompress functions on the gzip module'
updated_at = <Date 2010-10-01.13:23:52.285>
user = 'https://bugs.python.org/pythonhacker'

bugs.python.org fields:

activity = <Date 2010-10-01.13:23:52.285>
actor = 'pythonhacker'
assignee = 'none'
closed = True
closed_date = <Date 2010-08-17.21:13:39.358>
closer = 'pitrou'
components = ['Library (Lib)']
creation = <Date 2008-08-01.17:56:55.725>
creator = 'pythonhacker'
dependencies = []
files = ['11052', '15282', '15283']
hgrepos = []
issue_num = 3488
keywords = ['patch']
message_count = 16.0
messages = ['70578', '70594', '70646', '70650', '70657', '70684', '70686', '94382', '94432', '94683', '94693', '95020', '95021', '110680', '114170', '117797']
nosy_count = 5.0
nosy_names = ['gregory.p.smith', 'jcea', 'pitrou', 'pythonhacker', 'BreamoreBoy']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue3488'
versions = ['Python 3.2']

[pythonhacker]

Python has great in-built support for all sorts of text compression
including bzip, gzip, tarfile and other general purpose modules like
zlib etc.

Of these, I have a gripe with gzip - it does not provide a simple
way of compressing/uncompressing a string like the other modules
to (namely bzip, zlib) at the module level.

It is relatively easy to perform gzip de-compression using the
GzipFile class and StringIO objects, but compression is not
that straight-forward.

It would be great for the gzip module to have "compress"
and "uncompress" functions at the module level without having
to go through GzipFile every-time.

I think being able to send gzip compressed strings directly would be
useful for applications which require to send gzip data over the wire
without having to write to files and read-back.

[pythonhacker]

Uploading a file containing two functions which can be used to provide
compress/uncompress on gzip.

This is not a patch to gzip.py, but a stand-alone file. It this looks
fine, I will make a patch.

[pitrou]

I think the functionality is useful, although it may be too late to make
it into 2.6/3.0. Some comments:

• the functions should have docstrings
• there should be unit tests
• style nit: named parameters in function calls (and default values in
  function declarations) shouldn't have spaces around the '=' sign

[pythonhacker]

Thanks. The file I uploaded was not an actual patch but just how the
functions would appear in the gzip module, to illustrate the code.

I can make an actual patch to gzip.py with docstrings, unit-tests and
taking care of your other comments. Do you think this will be in time
for Python 3.0 ? I can do this right away.

[pythonhacker]

I have uploaded the actual patch file which can be applied against the
gzip.py module. I did not modify the _test() function since it is
written for testing file compression. I can modify test_gzip.py if this
patch is accepted.

[pythonhacker]

Uploading the svn diff.

[pythonhacker]

Added test case in test_gzip.py. Attaching svn diff of the same.

[pythonhacker]

Can we include this for the next release ?

[gpshead]

Seems simple enough, I don't see why not.

[pitrou]

The patch lacks a documentation update, though.
(see Doc/library/gzip.rst)

[pythonhacker]

Ok, I will add this.

[pythonhacker]

Uploading fresh gzip.py SVN diff with a minor change, i.e accepting a
regular string as argument, aka zlib.compress.

[pythonhacker]

Uploading rst documentation svn diff for module.

[BreamoreBoy]

This appears to have slipped under the radar, msg94432 seems to sum it up. Could someone please take this forward.

[pitrou]

Modified patch committed in r84155 (py3k). Thanks for your contribution!

[pythonhacker]

Okay. Verified as working. Thank you!