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 Daniel5148
Recipients Daniel5148, docs@python
Date 2017-11-15.14:54:20
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1510757660.91.0.213398074469.issue32035@psf.upfronthosting.co.za>
In-reply-to
Content
The documentation for "ZipFile.writestr(zinfo_or_arcname, data[, compress_type])" says: "Write the string data to the archive; [...]"
--> https://docs.python.org/3/library/zipfile.html

I fails to mention that data could also be bytes.

The source code does mention it however, that is how I found out:

def writestr(self, zinfo_or_arcname, data, compress_type=None):
        """Write a file into the archive.  The contents is 'data', which
        may be either a 'str' or a 'bytes' instance; if it is a 'str',
        it is encoded as UTF-8 first.
        'zinfo_or_arcname' is either a ZipInfo instance or
        the name of the file in the archive."""

I believe this should be added to the documentation as it's an important information to those who try to add non-UTF8 StringIO data to in-memory ZipFiles using BytesIO.
History
Date User Action Args
2017-11-15 14:54:20Daniel5148setrecipients: + Daniel5148, docs@python
2017-11-15 14:54:20Daniel5148setmessageid: <1510757660.91.0.213398074469.issue32035@psf.upfronthosting.co.za>
2017-11-15 14:54:20Daniel5148linkissue32035 messages
2017-11-15 14:54:20Daniel5148create