python-zipstream

zipstream.py is a zip archive generator based on python 3.3's zipfile.py. It was created to generate a zip file generator for streaming (ie web apps). This is beneficial for when you want to provide a downloadable archive of a large collection of regular files, which would be infeasible to generate the archive prior to downloading or of a very large file that you do not want to store entirely on disk or on memory.

The archive is generated as an iterator of strings, which, when joined, form the zip archive. For example, the following code snippet would write a zip archive containing files from 'path' to a normal file:

importzipstreamz=zipstream.ZipFile()
z.write('path/to/files')
withopen('zipfile.zip', 'wb') asf:
fordatainz:
f.write(data)

zipstream also allows to take as input a byte string iterable and to generate the archive as an iterator. This avoids storing large files on disk or in memory. To do so you could use something like this snippet:

defiterable():
for_inxrange(10):
yieldb'this is a byte string\x01\n'z=zipstream.ZipFile()
z.write_iter('my_archive_iter', iterable())
withopen('zipfile.zip', 'wb') asf:
fordatainz:
f.write(data)

Of course both approach can be combined:

defiterable():
for_inxrange(10):
yieldb'this is a byte string\x01\n'z=zipstream.ZipFile()
z.write('path/to/files', 'my_archive_files')
z.write_iter('my_archive_iter', iterable())
withopen('zipfile.zip', 'wb') asf:
fordatainz:
f.write(data)

Since recent versions of web.py support returning iterators of strings to be sent to the browser, to download a dynamically generated archive, you could use something like this snippet:

defGET(self):
path='/path/to/dir/of/files'zip_filename='files.zip'web.header('Content-type' , 'application/zip')
web.header('Content-Disposition', 'attachment; filename="%s"'% (
zip_filename,))
returnzipstream.ZipFile(path)

If the zlib module is available, zipstream.ZipFile can generate compressed zip archives.

Installation

pip install zipstream

Requirements

• Python 2.6, 2.7, 3.2, 3.3, pypy

Examples

flask

fromflaskimportResponse@app.route('/package.zip', methods=['GET'], endpoint='zipball')defzipball():
defgenerator():
z=zipstream.ZipFile(mode='w', compression=ZIP_DEFLATED)
z.write('/path/to/file')
forchunkinz:
yieldchunkresponse=Response(generator(), mimetype='application/zip')
response.headers['Content-Disposition'] ='attachment; filename={}'.format('files.zip')
returnresponse# or@app.route('/package.zip', methods=['GET'], endpoint='zipball')defzipball():
z=zipstream.ZipFile(mode='w', compression=ZIP_DEFLATED)
z.write('/path/to/file')
response=Response(z, mimetype='application/zip')
response.headers['Content-Disposition'] ='attachment; filename={}'.format('files.zip')
returnresponse

django 1.5+

fromdjango.httpimportStreamingHttpResponsedefzipball(request):
z=zipstream.ZipFile(mode='w', compression=ZIP_DEFLATED)
z.write('/path/to/file')
response=StreamingHttpResponse(z, content_type='application/zip')
response['Content-Disposition'] ='attachment; filename={}'.format('files.zip')
returnresponse

webpy

defGET(self):
path='/path/to/dir/of/files'zip_filename='files.zip'web.header('Content-type' , 'application/zip')
web.header('Content-Disposition', 'attachment; filename="%s"'% (
zip_filename,))
returnzipstream.ZipFile(path)

Running tests

With python version > 2.6, just run the following command: python -m unittest discover

Alternatively, you can use nose.