How can I pass a Python StringIO() object to a ZipFile(), or is it not supported?

python zipfile stringio
Brian picture Brian · Jun 9, 2011 · Viewed 7.5k times · Source

So I have a StringIO() file-like object, and I am trying to write it to a ZipFile(), but I get this TypeError: 

coercing to Unicode: need string or buffer, cStringIO.StringI found

Here is a sample of the code I am using:

file_like = StringIO()
archive = zipfile.ZipFile(file_like, 'w', zipfile.ZIP_DEFLATED)

# my_file is a StringIO object returned by a remote file storage server.
archive.write(my_file)

The docs say that StringIO() is a file-like class and that ZipFile() can accept a file-like object. Is there something I am missing? Any help would be greatly appreciated.

Thanks in advance!

Answer

mmmmmm picture mmmmmm · Jun 10, 2011

To add a string to a ZipFile you need to use the writestr method and pass the string from StringIO using getvalue method of the StringIO instance

e.g.

archive.writestr("name of file in zip", my_file.getvalue())

Note you also need to give the name of the string to say where it is placed in the zip file.

Related questions

Extracting a zipfile to memory?

How do I extract a zip to memory? My attempt (returning None on .getvalue()): from zipfile import ZipFile from StringIO import StringIO def extract_zip(input_zip): return StringIO(ZipFile(input_zip).extractall())

Read More
Unzipping files in Python

I read through the zipfile documentation, but couldn't understand how to unzip a file, only how to zip a file. How do I unzip all the contents of a zip file into the same directory?

Read More
How to create a zip archive of a directory in Python?

How can I create a zip archive of a directory structure in Python?

Read More