Vega strike Python Modules doc: ZipFile Class Reference

All Data Structures Namespaces Files Functions Variables

Inheritance diagram for ZipFile:

Public Member Functions
def	__init__

def	namelist

def	infolist

def	printdir

def	testzip

def	getinfo

def	read

def	write

def	writestr

def	__del__

def	close

Data Fields
	debug

	NameToInfo

	filelist

	compression

	mode

	filename

	start_dir

Static Public Attributes
	fp = None

Detailed Description

Class with methods to open, read, write, close, list zip files.

z = ZipFile(file, mode="r", compression=ZIP_STORED)

file: Either the path to the file, or a file-like object.
      If it is a path, the file will be opened and closed by ZipFile.
mode: The mode can be either read "r", write "w" or append "a".
compression: ZIP_STORED (no compression) or ZIP_DEFLATED (requires zlib).

Definition at line 147 of file zipfile.py.

Constructor & Destructor Documentation

def __init__	(	self,
		file,
		mode = `"r"`,
		compression = `ZIP_STORED`
	)

Open the ZIP file with mode read "r", write "w" or append "a".

Definition at line 160 of file zipfile.py.

 
     def __init__(self, file, mode="r", compression=ZIP_STORED):
         """Open the ZIP file with mode read "r", write "w" or append "a"."""
         if compression == ZIP_STORED:
             pass
         elif compression == ZIP_DEFLATED:
             if not zlib:
                 raise RuntimeError,\
                       "Compression requires the (missing) zlib module"
         else:
             raise RuntimeError, "That compression method is not supported"
         self.debug = 0  # Level of printing: 0 through 3
         self.NameToInfo = {}    # Find file info given name
         self.filelist = []      # List of ZipInfo instances for archive
         self.compression = compression  # Method of compression
         self.mode = key = mode[0]
 
         # Check if we were passed a file-like object
         if type(file) in _STRING_TYPES:
             self._filePassed = 0
             self.filename = file
             modeDict = {'r' : 'rb', 'w': 'wb', 'a' : 'r+b'}
             self.fp = open(file, modeDict[mode])
         else:
             self._filePassed = 1
             self.fp = file
             self.filename = getattr(file, 'name', None)
 
         if key == 'r':
             self._GetContents()
         elif key == 'w':
             pass
         elif key == 'a':
             fp = self.fp
             fp.seek(-22, 2)             # Seek to end-of-file record
             endrec = fp.read()
             if endrec[0:4] == stringEndArchive and \
                        endrec[-2:] == "\000\000":
                 self._GetContents()     # file is a zip file
                 # seek to start of directory and overwrite
                 fp.seek(self.start_dir, 0)
             else:               # file is not a zip file, just append
                 fp.seek(0, 2)
         else:
             if not self._filePassed:
                 self.fp.close()
                 self.fp = None
             raise RuntimeError, 'Mode must be "r", "w" or "a"'

def __del__ ( self)

Call the "close()" method in case the user forgot.

Definition at line 455 of file zipfile.py.

References FileWrapper.close(), StringIO.close(), Shelf.close(), Chunk.close(), _Subfile.close(), SGMLParser.close(), openrsrc.close(), URLopener.close(), _socketobject.close(), SSLFakeSocket.close(), _Hqxcoderengine.close(), SSLFakeFile.close(), FileInput.close(), TemporaryFileWrapper.close(), _fileobject.close(), _Rlecoderengine.close(), Wave_read.close(), HTTPResponse.close(), BinHex.close(), GzipFile.close(), Telnet.close(), Au_read.close(), OpenerDirector.close(), _Hqxdecoderengine.close(), SgmlopParser.close(), Aifc_read.close(), _Rledecoderengine.close(), HTTPConnection.close(), ExpatParser.close(), BaseHandler.close(), Au_write.close(), Wave_write.close(), ZipFile.close(), HexBin.close(), TestSGMLParser.close(), file_wrapper.close(), FTP.close(), Unmarshaller.close(), SMTP.close(), ftpwrapper.close(), HTTP.close(), addbase.close(), and addclosehook.close().

 
     def __del__(self):
         """Call the "close()" method in case the user forgot."""
         self.close()

Member Function Documentation

def close ( self)

Close the file, and for mode "w" and "a" write the ending
records.

Definition at line 459 of file zipfile.py.

References ZipFile._filePassed, ZipFile.filelist, _Mailbox.fp, _Subfile.fp, MultiFile.fp, Message.fp, HTTPResponse.fp, ZipFile.fp, HTTPError.fp, FieldStorage.fp, addbase.fp, GzipFile.mode, and ZipFile.mode.

 
     def close(self):
         """Close the file, and for mode "w" and "a" write the ending
         records."""
         if self.fp is None:
             return
         if self.mode in ("w", "a"):             # write ending records
             count = 0
             pos1 = self.fp.tell()
             for zinfo in self.filelist:         # write central directory
                 count = count + 1
                 dt = zinfo.date_time
                 dosdate = (dt[0] - 1980) << 9 | dt[1] << 5 | dt[2]
                 dostime = dt[3] << 11 | dt[4] << 5 | (dt[5] // 2)
                 centdir = struct.pack(structCentralDir,
                   stringCentralDir, zinfo.create_version,
                   zinfo.create_system, zinfo.extract_version, zinfo.reserved,
                   zinfo.flag_bits, zinfo.compress_type, dostime, dosdate,
                   zinfo.CRC, zinfo.compress_size, zinfo.file_size,
                   len(zinfo.filename), len(zinfo.extra), len(zinfo.comment),
                   0, zinfo.internal_attr, zinfo.external_attr,
                   zinfo.header_offset)
                 self.fp.write(centdir)
                 self.fp.write(zinfo.filename)
                 self.fp.write(zinfo.extra)
                 self.fp.write(zinfo.comment)
             pos2 = self.fp.tell()
             # Write end-of-zip-archive record
             endrec = struct.pack(structEndArchive, stringEndArchive,
                      0, 0, count, count, pos2 - pos1, pos1, 0)
             self.fp.write(endrec)
             self.fp.flush()
         if not self._filePassed:
             self.fp.close()
         self.fp = None
 

def read	(	self,
		name
	)

Return file bytes (as a string) for name.

Definition at line 320 of file zipfile.py.

References shlex.debug, FTP.debug, ZipFile.debug, NNTP.debug, dispatcher.debug, _Mailbox.fp, _Subfile.fp, MultiFile.fp, Message.fp, HTTPResponse.fp, ZipFile.fp, HTTPError.fp, FieldStorage.fp, addbase.fp, ZipFile.getinfo(), GzipFile.mode, and ZipFile.mode.

 
     def read(self, name):
         """Return file bytes (as a string) for name."""
         if self.mode not in ("r", "a"):
             raise RuntimeError, 'read() requires mode "r" or "a"'
         if not self.fp:
             raise RuntimeError, \
                   "Attempt to read ZIP archive that was already closed"
         zinfo = self.getinfo(name)
         filepos = self.fp.tell()
         self.fp.seek(zinfo.file_offset, 0)
         bytes = self.fp.read(zinfo.compress_size)
         self.fp.seek(filepos, 0)
         if zinfo.compress_type == ZIP_STORED:
             pass
         elif zinfo.compress_type == ZIP_DEFLATED:
             if not zlib:
                 raise RuntimeError, \
                       "De-compression requires the (missing) zlib module"
             # zlib compress/decompress code by Jeremy Hylton of CNRI
             dc = zlib.decompressobj(-15)
             bytes = dc.decompress(bytes)
             # need to feed in unused pad byte so that zlib won't choke
             ex = dc.decompress('Z') + dc.flush()
             if ex:
                 bytes = bytes + ex
         else:
             raise BadZipfile, \
                   "Unsupported compression method %d for file %s" % \
             (zinfo.compress_type, name)
         crc = binascii.crc32(bytes)
         if crc != zinfo.CRC:
             raise BadZipfile, "Bad CRC-32 for file %s" % name
         return bytes

def write	(	self,
		filename,
		arcname = `None`,
		compress_type = `None`
	)

Put the bytes from filename into the archive under the name
arcname.

Definition at line 371 of file zipfile.py.

References ZipFile._writecheck(), ZipFile.compression, ZipFile.NameToInfo, and aifc.open().

 
     def write(self, filename, arcname=None, compress_type=None):
         """Put the bytes from filename into the archive under the name
         arcname."""
         st = os.stat(filename)
         mtime = time.localtime(st[8])
         date_time = mtime[0:6]
         # Create ZipInfo instance to store file information
         if arcname is None:
             zinfo = ZipInfo(filename, date_time)
         else:
             zinfo = ZipInfo(arcname, date_time)
         zinfo.external_attr = st[0] << 16       # Unix attributes
         if compress_type is None:
             zinfo.compress_type = self.compression
         else:
             zinfo.compress_type = compress_type
         self._writecheck(zinfo)
         fp = open(filename, "rb")
         zinfo.flag_bits = 0x00
         zinfo.header_offset = self.fp.tell()    # Start of header bytes
         # Must overwrite CRC and sizes with correct data later
         zinfo.CRC = CRC = 0
         zinfo.compress_size = compress_size = 0
         zinfo.file_size = file_size = 0
         self.fp.write(zinfo.FileHeader())
         zinfo.file_offset = self.fp.tell()      # Start of file bytes
         if zinfo.compress_type == ZIP_DEFLATED:
             cmpr = zlib.compressobj(zlib.Z_DEFAULT_COMPRESSION,
                  zlib.DEFLATED, -15)
         else:
             cmpr = None
         while 1:
             buf = fp.read(1024 * 8)
             if not buf:
                 break
             file_size = file_size + len(buf)
             CRC = binascii.crc32(buf, CRC)
             if cmpr:
                 buf = cmpr.compress(buf)
                 compress_size = compress_size + len(buf)
             self.fp.write(buf)
         fp.close()
         if cmpr:
             buf = cmpr.flush()
             compress_size = compress_size + len(buf)
             self.fp.write(buf)
             zinfo.compress_size = compress_size
         else:
             zinfo.compress_size = file_size
         zinfo.CRC = CRC
         zinfo.file_size = file_size
         # Seek backwards and write CRC and file sizes
         position = self.fp.tell()       # Preserve current position in file
         self.fp.seek(zinfo.header_offset + 14, 0)
         self.fp.write(struct.pack("<lll", zinfo.CRC, zinfo.compress_size,
               zinfo.file_size))
         self.fp.seek(position, 0)
         self.filelist.append(zinfo)
         self.NameToInfo[zinfo.filename] = zinfo

def writestr	(	self,
		zinfo,
		bytes
	)

Write a file into the archive.  The contents is the string
'bytes'.

Definition at line 431 of file zipfile.py.

References ZipFile._writecheck(), and ZipFile.NameToInfo.

 
     def writestr(self, zinfo, bytes):
         """Write a file into the archive.  The contents is the string
         'bytes'."""
         self._writecheck(zinfo)
         zinfo.file_size = len(bytes)            # Uncompressed size
         zinfo.CRC = binascii.crc32(bytes)       # CRC-32 checksum
         if zinfo.compress_type == ZIP_DEFLATED:
             co = zlib.compressobj(zlib.Z_DEFAULT_COMPRESSION,
                  zlib.DEFLATED, -15)
             bytes = co.compress(bytes) + co.flush()
             zinfo.compress_size = len(bytes)    # Compressed size
         else:
             zinfo.compress_size = zinfo.file_size
         zinfo.header_offset = self.fp.tell()    # Start of header bytes
         self.fp.write(zinfo.FileHeader())
         zinfo.file_offset = self.fp.tell()      # Start of file bytes
         self.fp.write(bytes)
         if zinfo.flag_bits & 0x08:
             # Write CRC and file sizes after the file data
             self.fp.write(struct.pack("<lll", zinfo.CRC, zinfo.compress_size,
                   zinfo.file_size))
         self.filelist.append(zinfo)
         self.NameToInfo[zinfo.filename] = zinfo

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation