1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
# python-zipstream
[](https://travis-ci.org/allanlei/python-zipstream)
[](https://coveralls.io/r/allanlei/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:
```python
import zipstream
z = zipstream.ZipFile()
z.write('path/to/files')
with open('zipfile.zip', 'wb') as f:
for data in z:
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:
```python
def iterable():
for _ in xrange(10):
yield b'this is a byte string\x01\n'
z = zipstream.ZipFile()
z.write_iter(iterable(), 'my_archive_iter')
with open('zipfile.zip', 'wb') as f:
for data in z:
f.write(data)
```
Of course both approach can be combined:
```python
def iterable():
for _ in xrange(10):
yield b'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())
with open('zipfile.zip', 'wb') as f:
for data in z:
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:
```python
def GET(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,))
return zipstream.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
```python
from flask import Response
@app.route('/package.zip', methods=['GET'], endpoint='zipball')
def zipball():
def generator():
z = zipstream.ZipFile(mode='w', compression=ZIP_DEFLATED)
z.write('/path/to/file')
for chunk in z:
yield chunk
response = Response(generator(), mimetype='application/zip')
response.headers['Content-Disposition'] = 'attachment; filename={}'.format('files.zip')
return response
# or
@app.route('/package.zip', methods=['GET'], endpoint='zipball')
def zipball():
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')
return response
```
### django 1.5+
```python
from django.http import StreamingHttpResponse
def zipball(request):
z = zipstream.ZipFile(mode='w', compression=ZIP_DEFLATED)
z.write('/path/to/file')
response = StreamingHttpResponse(z, mimetype='application/zip')
response['Content-Disposition'] = 'attachment; filename={}'.format('files.zip')
return response
```
### webpy
```python
def GET(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,))
return zipstream.ZipFile(path)
```
## Running tests
With python version > 2.6, just run the following command: `python -m unittest discover`
Alternatively, you can use `nose`.
|
