"""Functions that read and write gzipped files.
The user of the file doesn't have to worry about the compression,
but random access is not allowed."""
# based on Andrew Kuchling's minigzip.py distributed with the zlib module
import struct, sys, time, os
__all__ = ["GzipFile","open"]
FTEXT, FHCRC, FEXTRA, FNAME, FCOMMENT = 1, 2, 4, 8, 16
def write32u(output, value):
# The L format writes the bit pattern correctly whether signed
output.write(struct.pack("<L", value))
return struct.unpack("<I", input.read(4))[0]
def open(filename, mode="rb", compresslevel=9):
"""Shorthand for GzipFile(filename, mode, compresslevel).
The filename argument is required; mode defaults to 'rb'
and compresslevel defaults to 9.
return GzipFile(filename, mode, compresslevel)
class GzipFile(io.BufferedIOBase):
"""The GzipFile class simulates most of the methods of a file object with
the exception of the readinto() and truncate() methods.
max_read_chunk = 10 * 1024 * 1024 # 10Mb
def __init__(self, filename=None, mode=None,
compresslevel=9, fileobj=None, mtime=None):
"""Constructor for the GzipFile class.
At least one of fileobj and filename must be given a
The new class instance is based on fileobj, which can be a regular
file, a StringIO object, or any other object which simulates a file.
It defaults to None, in which case filename is opened to provide
When fileobj is not None, the filename argument is only used to be
included in the gzip file header, which may include the original
filename of the uncompressed file. It defaults to the filename of
fileobj, if discernible; otherwise, it defaults to the empty string,
and in this case the original filename is not included in the header.
The mode argument can be any of 'r', 'rb', 'a', 'ab', 'w', or 'wb',
depending on whether the file will be read or written. The default
is the mode of fileobj if discernible; otherwise, the default is 'rb'.
Be aware that only the 'rb', 'ab', and 'wb' values should be used
for cross-platform portability.
The compresslevel argument is an integer from 0 to 9 controlling the
level of compression; 1 is fastest and produces the least compression,
and 9 is slowest and produces the most compression. 0 is no compression
at all. The default is 9.
The mtime argument is an optional numeric timestamp to be written
to the stream when compressing. All gzip compressed streams
are required to contain a timestamp. If omitted or None, the
current time is used. This module ignores the timestamp when
decompressing; however, some programs, such as gunzip, make use
of it. The format of the timestamp is the same as that of the
return value of time.time() and of the st_mtime member of the
object returned by os.stat().
# Make sure we don't inadvertently enable universal newlines on the
# underlying file object - in read mode, this causes data corruption.
mode = mode.replace('U', '')
# guarantee the file is opened in binary mode on platforms
# that care about that sort of thing
if mode and 'b' not in mode:
fileobj = self.myfileobj = __builtin__.open(filename, mode or 'rb')
# Issue #13781: os.fdopen() creates a fileobj with a bogus name
# attribute. Avoid saving this in the gzip header's filename field.
filename = getattr(fileobj, 'name', '')
if not isinstance(filename, basestring) or filename == '<fdopen>':
if hasattr(fileobj, 'mode'): mode = fileobj.mode
# Set flag indicating start of a new member
# Buffer data read from gzip file. extrastart is offset in
# stream where buffer starts. extrasize is number of
# bytes remaining in buffer from current stream position.
# Starts small, scales exponentially
elif mode[0:1] == 'w' or mode[0:1] == 'a':
self._init_write(filename)
self.compress = zlib.compressobj(compresslevel,
raise IOError, "Mode " + mode + " not supported"
self._write_gzip_header()
warnings.warn("use the name attribute", DeprecationWarning, 2)
if self.mode == WRITE and self.name[-3:] != ".gz":
return '<gzip ' + s[1:-1] + ' ' + hex(id(self)) + '>'
"""Raises a ValueError if the underlying file object has been closed.
raise ValueError('I/O operation on closed file.')
def _init_write(self, filename):
self.crc = zlib.crc32("") & 0xffffffffL
def _write_gzip_header(self):
self.fileobj.write('\037\213') # magic header
self.fileobj.write('\010') # compression method
# RFC 1952 requires the FNAME field to be Latin-1. Do not
# include filenames that cannot be represented that way.
fname = os.path.basename(self.name)
if not isinstance(fname, str):
fname = fname.encode('latin-1')
if fname.endswith('.gz'):
except UnicodeEncodeError:
self.fileobj.write(chr(flags))
write32u(self.fileobj, long(mtime))
self.fileobj.write('\002')
self.fileobj.write('\377')
self.fileobj.write(fname + '\000')
self.crc = zlib.crc32("") & 0xffffffffL
def _read_gzip_header(self):
magic = self.fileobj.read(2)
raise IOError, 'Not a gzipped file'
method = ord( self.fileobj.read(1) )
raise IOError, 'Unknown compression method'
flag = ord( self.fileobj.read(1) )
self.mtime = read32(self.fileobj)
# extraflag = self.fileobj.read(1)
# os = self.fileobj.read(1)
# Read & discard the extra field, if present
xlen = ord(self.fileobj.read(1))
xlen = xlen + 256*ord(self.fileobj.read(1))
# Read and discard a null-terminated string containing the filename
# Read and discard a null-terminated string containing a comment
self.fileobj.read(2) # Read & discard the 16-bit header CRC
raise IOError(errno.EBADF, "write() on read-only GzipFile object")
raise ValueError, "write() on closed GzipFile object"
# Convert data type if called by io.BufferedWriter.
if isinstance(data, memoryview):
self.fileobj.write(self.compress.compress(data))
self.crc = zlib.crc32(data, self.crc) & 0xffffffffL
raise IOError(errno.EBADF, "read() on write-only GzipFile object")
if self.extrasize <= 0 and self.fileobj is None:
if size < 0: # get the whole thing
readsize = min(self.max_read_chunk, readsize * 2)
else: # just get some more of it
while size > self.extrasize:
readsize = min(self.max_read_chunk, readsize * 2)
if size > self.extrasize:
offset = self.offset - self.extrastart
chunk = self.extrabuf[offset: offset + size]
self.extrasize = self.extrasize - size
self.extrasize = len(buf) + self.extrasize
def _read(self, size=1024):
raise EOFError, "Reached EOF"
# If the _new_member flag is set, we have to
# jump to the next member, if there is one.
# First, check if we're at the end of the file;
# if so, it's time to stop; no more members to read.
pos = self.fileobj.tell() # Save current position
self.fileobj.seek(0, 2) # Seek to end of file
if pos == self.fileobj.tell():
raise EOFError, "Reached EOF"
self.fileobj.seek( pos ) # Return to original position
self.decompress = zlib.decompressobj(-zlib.MAX_WBITS)
# Read a chunk of data from the file
buf = self.fileobj.read(size)
# If the EOF has been reached, flush the decompression object
# and mark this object as finished.
uncompress = self.decompress.flush()
self._add_read_data( uncompress )
raise EOFError, 'Reached EOF'
uncompress = self.decompress.decompress(buf)
self._add_read_data( uncompress )
if self.decompress.unused_data != "":
# Ending case: we've come to the end of a member in the file,
# so seek back to the start of the unused data, finish up
# this member, and read a new gzip header.
# (The number of bytes to seek back is the length of the unused
# data, minus 8 because _read_eof() will rewind a further 8 bytes)
self.fileobj.seek( -len(self.decompress.unused_data)+8, 1)
# Check the CRC and file size, and set the flag so we read
# a new member on the next call
def _add_read_data(self, data):
self.crc = zlib.crc32(data, self.crc) & 0xffffffffL
offset = self.offset - self.extrastart
self.extrabuf = self.extrabuf[offset:] + data
self.extrasize = self.extrasize + len(data)
self.extrastart = self.offset
self.size = self.size + len(data)
# We've read to the end of the file, so we have to rewind in order
# to reread the 8 bytes containing the CRC and the file size.
# We check the that the computed CRC and size of the
# uncompressed data matches the stored values. Note that the size
# stored is the true file size mod 2**32.
crc32 = read32(self.fileobj)
isize = read32(self.fileobj) # may exceed 2GB
raise IOError("CRC check failed %s != %s" % (hex(crc32),
elif isize != (self.size & 0xffffffffL):
raise IOError, "Incorrect length of data produced"
# Gzip files can be padded with zeroes and still have archives.
# Consume all zero bytes and set the file position to the first
# non-zero byte. See http://www.gzip.org/#faq8
return self.fileobj is None
fileobj.write(self.compress.flush())
write32u(fileobj, self.crc)
# self.size may exceed 2GB, or even 4GB
write32u(fileobj, self.size & 0xffffffffL)
myfileobj = self.myfileobj
def flush(self,zlib_mode=zlib.Z_SYNC_FLUSH):
# Ensure the compressor's buffer is flushed
self.fileobj.write(self.compress.flush(zlib_mode))
"""Invoke the underlying file object's fileno() method.
This will raise AttributeError if the underlying file object
doesn't support fileno().
return self.fileobj.fileno()
'''Return the uncompressed stream file position indicator to the
raise IOError("Can't rewind in write mode")
return self.mode == WRITE
def seek(self, offset, whence=0):
offset = self.offset + offset
raise ValueError('Seek from end not supported')
raise IOError('Negative seek in write mode')
count = offset - self.offset
for i in xrange(count // 1024):
self.write((count % 1024) * '\0')
# for negative seek, rewind and do positive seek
count = offset - self.offset
for i in xrange(count // 1024):
def readline(self, size=-1):
# Shortcut common case - newline found in buffer.
offset = self.offset - self.extrastart
i = self.extrabuf.find('\n', offset) + 1
self.extrasize -= i - offset
self.offset += i - offset
return self.extrabuf[offset: i]
readsize = self.min_readsize
# We set i=size to break out of the loop under two
# conditions: 1) there's no newline, and the chunk is
# larger than size, or 2) there is a newline, but the
# resulting line would be longer than 'size'.
if (size <= i) or (i == -1 and len(c) > size):
bufs.append(c[:i + 1]) # Add portion of last chunk
self._unread(c[i + 1:]) # Push back rest of chunk
# Append chunk to list, decrease 'size',
readsize = min(size, readsize * 2)
if readsize > self.min_readsize:
self.min_readsize = min(readsize, self.min_readsize * 2, 512)
return ''.join(bufs) # Return resulting line
# Act like gzip; with -d, act like gunzip.
# The input file is not deleted, however, nor are any other gzip
# options or features supported.
decompress = args and args[0] == "-d"
f = GzipFile(filename="", mode="rb", fileobj=sys.stdin)
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
