Package fabio :: Module fabioutils :: Class GzipFile
[hide private]
[frames] | no frames]

Class GzipFile

source code

gzip.GzipFile --+
                |
               GzipFile

Just a wrapper forgzip.GzipFile providing the correct seek capabilities for python 2.5

Instance Methods [hide private]
 
__init__(self, filename=None, mode=None, compresslevel=9, fileobj=None)
Wrapper with locking for constructor for the GzipFile class.
source code
 
getSize(self) source code
 
setSize(self, value) source code
 
seek(self, offset, whence=0)
Move to new file position.
source code

Inherited from gzip.GzipFile: __del__, __iter__, __repr__, close, fileno, flush, isatty, next, read, readline, readlines, rewind, tell, write, writelines

Inherited from gzip.GzipFile (private): _add_read_data, _init_read, _init_write, _read, _read_eof, _read_gzip_header, _unread, _write_gzip_header

Class Variables [hide private]

Inherited from gzip.GzipFile: max_read_chunk, myfileobj

Properties [hide private]
  size
  closed

Inherited from gzip.GzipFile: filename

Method Details [hide private]

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

source code 

Wrapper with locking for 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.

Overrides: gzip.GzipFile.__init__

seek(self, offset, whence=0)

source code 

Move to new file position.

Argument offset is a byte count. Optional argument whence defaults to 0 (offset from start of file, offset should be >= 0); other values are 1 (move relative to current position, positive or negative), and 2 (move relative to end of file, usually negative, although many platforms allow seeking beyond the end of a file). If the file is opened in text mode, only offsets returned by tell() are legal. Use of other offsets causes undefined behavior.

This is a wrapper for seek to ensure compatibility with old python 2.5

Overrides: gzip.GzipFile.seek

Property Details [hide private]

size

Get Method:
getSize(self)
Set Method:
setSize(self, value)

closed

Get Method:
unreachable.closed(self)