Module gzipstream :: Class GzipStreamXL
[hide private]
[frames] | no frames]

Class GzipStreamXL

source code

     object --+                    
              |                    
    _io._IOBase --+                
                  |                
_io._BufferedIOBase --+            
                      |            
     object --+       |            
              |       |            
    _io._IOBase --+   |            
                  |   |            
          io.IOBase --+            
                      |            
      io.BufferedIOBase --+        
                          |        
              gzip.GzipFile --+    
                              |    
                     GzipStream --+
                                  |
                                 GzipStreamXL

Handle streaming gzipped data -- large data version.

Very large sized data stream version -- slooower. For normally sized data streams (< 2.5GB-ish), use GzipStream.

Nested Classes [hide private]

Inherited from io.IOBase: __metaclass__

Instance Methods [hide private]
 
__init__(self, stream=None, mode=None, compresslevel=9)
Constructor for the GzipFile class.
source code
 
_init_write(self, filename)
Make size long in order to support very large files.
source code
 
_init_read(self)
Make size a long in order to support very large files.
source code

Inherited from GzipStream: __repr__, close, seek

Inherited from GzipStream (private): _initModeLogic, _read, _read32XL, _read_eof

Inherited from gzip.GzipFile: fileno, flush, read, readable, readline, rewind, seekable, writable, write

Inherited from gzip.GzipFile (private): _add_read_data, _check_closed, _read_gzip_header, _unread, _write_gzip_header

Inherited from _io._BufferedIOBase: detach, read1, readinto

Inherited from _io._IOBase: __enter__, __exit__, __iter__, __new__, isatty, next, readlines, tell, truncate, writelines

Inherited from _io._IOBase (private): _checkClosed, _checkReadable, _checkSeekable, _checkWritable

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from GzipStream: VERSION

Inherited from gzip.GzipFile: max_read_chunk, myfileobj

Inherited from gzip.GzipFile (private): _abc_negative_cache, _abc_negative_cache_version, _abc_registry

Inherited from io.IOBase: __abstractmethods__

Inherited from io.IOBase (private): _abc_cache

Properties [hide private]

Inherited from gzip.GzipFile: closed, filename

Inherited from object: __class__

Method Details [hide private]

__init__(self, stream=None, mode=None, compresslevel=9)
(Constructor)

source code 

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.

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().

Overrides: object.__init__
(inherited documentation)

_init_write(self, filename)

source code 

Make size long in order to support very large files.

Overrides: gzip.GzipFile._init_write

_init_read(self)

source code 

Make size a long in order to support very large files.

Overrides: gzip.GzipFile._init_read