[Python-checkins] CVS: python/dist/src/Doc/lib libzipfile.tex,1.5,1.6

Fred L. Drake python-dev@python.org
Tue, 3 Oct 2000 08:16:34 -0700


Update of /cvsroot/python/python/dist/src/Doc/lib
In directory slayer.i.sourceforge.net:/tmp/cvs-serv29713/lib

Modified Files:
	libzipfile.tex 
Log Message:

Jim Ahlstrom sent a few corrections to my changes.  (Thanks!)


Index: libzipfile.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libzipfile.tex,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -r1.5 -r1.6
*** libzipfile.tex	2000/10/02 20:56:30	1.5
--- libzipfile.tex	2000/10/03 15:16:31	1.6
***************
*** 26,33 ****
  \end{excdesc}
  
- \begin{datadesc}{_debug}
-   Level of printing, defaults to \code{1}.
- \end{datadesc}
- 
  \begin{classdesc}{ZipFile}{\unspecified}
    The class for reading and writing ZIP files.  See
--- 26,29 ----
***************
*** 43,47 ****
    Class used the represent infomation about a member of an archive.
    Instances of this class are returned by the \method{getinfo()} and
!   \method{listinfo()} methods of \class{ZipFile} objects.  Most users
    of the \module{zipfile} module will not need to create these, but
    only use those created by this module.
--- 39,43 ----
    Class used the represent infomation about a member of an archive.
    Instances of this class are returned by the \method{getinfo()} and
!   \method{infolist()} methods of \class{ZipFile} objects.  Most users
    of the \module{zipfile} module will not need to create these, but
    only use those created by this module.
***************
*** 100,107 ****
    the archive, and should be \constant{ZIP_STORED} or
    \constant{ZIP_DEFLATED}; unrecognized values will cause
!   \exception{ValueError} to be raised.  The default is
    \constant{ZIP_STORED}. 
  \end{classdesc}
  
  \begin{methoddesc}{namelist}{}
    Return a list of archive members by name.
--- 96,115 ----
    the archive, and should be \constant{ZIP_STORED} or
    \constant{ZIP_DEFLATED}; unrecognized values will cause
!   \exception{RuntimeError} to be raised.  If \constant{ZIP_DEFLATED}
!   is specified but the \refmodule{zlib} module is not avaialble,
!   \exception{RuntimeError} is also raised.  The default is
    \constant{ZIP_STORED}. 
  \end{classdesc}
  
+ \begin{methoddesc}{close}{}
+   Close the archive file.  You must call \method{close()} before
+   exiting your program or essential records will not be written. 
+ \end{methoddesc}
+ 
+ \begin{methoddesc}{getinfo}{name}
+   Return a \class{ZipInfo} object with information about the archive
+   member \var{name}.
+ \end{methoddesc}
+ 
  \begin{methoddesc}{namelist}{}
    Return a list of archive members by name.
***************
*** 127,147 ****
    name of the first bad file, or else return \code{None}.
  \end{methoddesc}
- 
- \begin{methoddesc}{writestr}{bytes, arcname, year, month, day,
-                              hour, minute, second}
-   Write the string \var{bytes} and the other data to the archive, and
-   give the archive member the name \var{arcname}.  The archive must be
-   opened with mode \code{'w'} or \code{'a'}.
- \end{methoddesc}
  
! \begin{methoddesc}{write}{filename, arcname}
    Write the file named \var{filename} to the archive, giving it the
!   archive name \var{arcname}.  The archive must be open with mode
!   \code{'w'} or \code{'a'}.
  \end{methoddesc}
  
! \begin{methoddesc}{close}{}
!   Close the archive file.  You must call \method{close()} before
!   exiting your program or essential records will not be written. 
  \end{methoddesc}
  
--- 135,154 ----
    name of the first bad file, or else return \code{None}.
  \end{methoddesc}
  
! \begin{methoddesc}{write}{filename\optional{, arcname\optional{,
!                           compress_type}}}
    Write the file named \var{filename} to the archive, giving it the
!   archive name \var{arcname} (by default, this will be the same as
!   \var{filename}).  If given, \var{compress_type} overrides the value
!   given for the \var{compression} parameter to the constructor for
!   the new entry.  The archive must be open with mode \code{'w'} or
!   \code{'a'}. 
  \end{methoddesc}
  
! \begin{methoddesc}{writestr}{zinfo, bytes}
!   Write the string \var{bytes} to the archive; meta-information is
!   given as the \class{ZipInfo} instance \var{zinfo}.  At least the
!   filename, date, and time must be given by \var{zinfo}.  The archive
!   must be opened with mode \code{'w'} or \code{'a'}.
  \end{methoddesc}
  
***************
*** 190,194 ****
  
  Instances of the \class{ZipInfo} class are returned by the
! \method{getinfo()} and \method{listinfo()} methods of
  \class{ZipFile} objects.  Each object stores information about a
  single member of the ZIP archive.
--- 197,201 ----
  
  Instances of the \class{ZipInfo} class are returned by the
! \method{getinfo()} and \method{infolist()} methods of
  \class{ZipFile} objects.  Each object stores information about a
  single member of the ZIP archive.