]> granicus.if.org Git - python/commitdiff
Itamar Shtull-Trauring <python@itamarst.org>:
authorFred Drake <fdrake@acm.org>
Wed, 9 May 2001 19:57:37 +0000 (19:57 +0000)
committerFred Drake <fdrake@acm.org>
Wed, 9 May 2001 19:57:37 +0000 (19:57 +0000)
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.

Doc/lib/libzipfile.tex

index 2f2f562d5737941c3e9b531e1d97ab7e84013feb..8225cfb948d63fd8a3f1f3b90d8f0ab7465ce576 100644 (file)
@@ -77,13 +77,14 @@ The available attributes of this module are:
 
 \subsection{ZipFile Objects \label{zipfile-objects}}
 
-\begin{classdesc}{ZipFile}{filename\optional{, mode\optional{, compression}}} 
-  Open a ZIP file named \var{filename}.  The \var{mode} parameter
+\begin{classdesc}{ZipFile}{file\optional{, mode\optional{, compression}}} 
+  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
   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
-  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 to another file, such as \file{python.exe}.  Using