Itamar Shtull-Trauring <python@itamarst.org>:

Updates zipfile.ZipFile docs to mention the fact that you can create a
ZipFile instance from an arbitrary file-like object.

This closes patch #418011.
This commit is contained in:
Fred Drake 2001-05-09 19:57:37 +00:00
parent fd16834ca7
commit bda3a59a93
1 changed files with 5 additions and 4 deletions

View File

@ -77,13 +77,14 @@ The available attributes of this module are:
\subsection{ZipFile Objects \label{zipfile-objects}} \subsection{ZipFile Objects \label{zipfile-objects}}
\begin{classdesc}{ZipFile}{filename\optional{, mode\optional{, compression}}} \begin{classdesc}{ZipFile}{file\optional{, mode\optional{, compression}}}
Open a ZIP file named \var{filename}. The \var{mode} parameter Open a ZIP file, where \var{file} can be either a path to a file
(i.e. a string) or a file-like object. The \var{mode} parameter
should be \code{'r'} to read an existing file, \code{'w'} to should be \code{'r'} to read an existing file, \code{'w'} to
truncate and write a new file, or \code{'a'} to append to an truncate and write a new file, or \code{'a'} to append to an
existing file. For \var{mode} is \code{'a'} and \var{filename} existing file. For \var{mode} is \code{'a'} and \var{file}
refers to an existing ZIP file, then additional files are added to refers to an existing ZIP file, then additional files are added to
it. If \var{filename} does not refer to a ZIP file, then a new ZIP it. If \var{file} does not refer to a ZIP file, then a new ZIP
archive is appended to the file. This is meant for adding a ZIP archive is appended to the file. This is meant for adding a ZIP
archive to another file, such as \file{python.exe}. Using archive to another file, such as \file{python.exe}. Using