Module gzip :: Class GzipFile
[hide private]
[frames] | no frames]

_ClassType GzipFile

The GzipFile class simulates most of the methods of a file object with the exception of the readinto() and truncate() methods.

Instance Methods [hide private]
 
__init__(self, filename=None, mode=None, compresslevel=9, fileobj=None)
Constructor for the GzipFile class.
 
__repr__(self)
 
_init_write(self, filename)
 
_write_gzip_header(self)
 
_init_read(self)
 
_read_gzip_header(self)
 
write(self, data)
 
read(self, size=-1)
 
_unread(self, buf)
 
_read(self, size=1024)
 
_add_read_data(self, data)
 
_read_eof(self)
 
close(self)
 
__del__(self)
 
flush(self, zlib_mode=2)
 
fileno(self)
Invoke the underlying file object's fileno() method.
 
isatty(self)
 
tell(self)
 
rewind(self)
Return the uncompressed stream file position indicator to the beginning of the file
 
seek(self, offset)
 
readline(self, size=-1)
 
readlines(self, sizehint=0)
 
writelines(self, L)
 
__iter__(self)
 
next(self)
Class Variables [hide private]
  myfileobj = None
  max_read_chunk = 10485760
Method Details [hide private]

__init__(self, filename=None, mode=None, compresslevel=9, fileobj=None)
(Constructor)

 

Constructor for the GzipFile class.

At least one of fileobj and filename must be given a non-trivial value.

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 a file object.

When fileobj is not None, the filename argument is only used to be included in the gzip file header, which may includes 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 1 to 9 controlling the level of compression; 1 is fastest and produces the least compression, and 9 is slowest and produces the most compression. The default is 9.

fileno(self)

 

Invoke the underlying file object's fileno() method.

This will raise AttributeError if the underlying file object doesn't support fileno().