t.p.zipstream : module documentation

Part of twisted.python View Source

An incremental approach to unzipping files. This allows you to unzip a little bit of a file at a time, which means you can report progress as a file unzips.
Class ChunkingZipFile A ZipFile object which, with readfile(), also gives you access to a filelike object for each entry.
Class ZipFileEntry File-like object used to read an uncompressed entry in a ZipFile
Class DeflatedZipFileEntry File-like object used to read a deflated entry in a ZipFile
Function unzip Unzip the file
Function unzipIter Return a generator for the zipfile. This implementation will yield after every file.
Function countZipFileChunks Predict the number of chunks that will be extracted from the entire zipfile, given chunksize blocks.
Function countFileChunks Count the number of chunks that will result from the given ZipInfo.
Function countZipFileEntries Count the number of entries in a zip archive. (Don't use this function.)
Function unzipIterChunky Return a generator for the zipfile. This implementation will yield after every chunksize uncompressed bytes, or at the end of a file, whichever comes first.
Class _FileEntry Abstract superclass of both compressed and uncompressed variants of file-like objects within a zip archive.
def unzip(filename, directory='.', overwrite=0): (source)
Unzip the file
Parametersfilenamethe name of the zip file
directorythe directory into which the files will be extracted
overwriteif on, overwrite files when they exist. You can still get an error if you try to create a directory over a file with the same name or vice-versa.
def unzipIter(filename, directory='.', overwrite=0, suppressWarning=False): (source)
Return a generator for the zipfile. This implementation will yield after every file.

The value it yields is the number of files left to unzip.

def countZipFileChunks(filename, chunksize): (source)
Predict the number of chunks that will be extracted from the entire zipfile, given chunksize blocks.
def countFileChunks(zipinfo, chunksize): (source)
Count the number of chunks that will result from the given ZipInfo.
Parameterszipinfoa zipfile.ZipInfo instance describing an entry in a zip archive to be counted.
Returnsthe number of chunks present in the zip file. (Even an empty file counts as one chunk.) (type: int)
def countZipFileEntries(filename): (source)
Count the number of entries in a zip archive. (Don't use this function.)
ParametersfilenameThe filename of a zip archive. (type: str)
def unzipIterChunky(filename, directory='.', overwrite=0, chunksize=4096): (source)
Return a generator for the zipfile. This implementation will yield after every chunksize uncompressed bytes, or at the end of a file, whichever comes first.

The value it yields is the number of chunks left to unzip.

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.