12. Data Compression and Archiving

The modules described in this chapter support data compression with the zlib, gzip, and bzip2 algorithms, and the creation of ZIP- and tar-format archives. See also Archiving operations provided by the shutil module.

• 12.1. zlib — Compression compatible with gzip
  • error
  • adler32()
  • compress()
  • compressobj()
  • crc32()
  • decompress()
  • decompressobj()
  • Compress.compress()
  • Compress.flush()
  • Compress.copy()
  • Decompress.unused_data
  • Decompress.unconsumed_tail
  • Decompress.decompress()
  • Decompress.flush()
  • Decompress.copy()
• 12.2. gzip — Support for gzip files
  • GzipFile
  • open()
  • 12.2.1. Examples of usage
• 12.3. bz2 — Compression compatible with bzip2
  • 12.3.1. (De)compression of files
    • BZ2File
      • BZ2File.close()
      • BZ2File.read()
      • BZ2File.readline()
      • BZ2File.readlines()
      • BZ2File.xreadlines()
      • BZ2File.seek()
      • BZ2File.tell()
      • BZ2File.write()
      • BZ2File.writelines()
  • 12.3.2. Sequential (de)compression
    • BZ2Compressor
      • BZ2Compressor.compress()
      • BZ2Compressor.flush()
    • BZ2Decompressor
      • BZ2Decompressor.decompress()
  • 12.3.3. One-shot (de)compression
    • compress()
    • decompress()
• 12.4. zipfile — Work with ZIP archives
  • BadZipfile
  • LargeZipFile
  • PyZipFile
  • ZipInfo
  • is_zipfile()
  • ZIP_STORED
  • ZIP_DEFLATED
  • 12.4.1. ZipFile Objects
    • ZipFile
    • ZipFile.close()
    • ZipFile.getinfo()
    • ZipFile.infolist()
    • ZipFile.namelist()
    • ZipFile.open()
    • ZipFile.extract()
    • ZipFile.extractall()
    • ZipFile.printdir()
    • ZipFile.setpassword()
    • ZipFile.read()
    • ZipFile.testzip()
    • ZipFile.write()
    • ZipFile.writestr()
    • ZipFile.debug
    • ZipFile.comment
  • 12.4.2. PyZipFile Objects
    • PyZipFile.writepy()
  • 12.4.3. ZipInfo Objects
    • ZipInfo.filename
    • ZipInfo.date_time
    • ZipInfo.compress_type
    • ZipInfo.comment
    • ZipInfo.extra
    • ZipInfo.create_system
    • ZipInfo.create_version
    • ZipInfo.extract_version
    • ZipInfo.reserved
    • ZipInfo.flag_bits
    • ZipInfo.volume
    • ZipInfo.internal_attr
    • ZipInfo.external_attr
    • ZipInfo.header_offset
    • ZipInfo.CRC
    • ZipInfo.compress_size
    • ZipInfo.file_size
  • 12.4.4. Command-Line Interface
    • 12.4.4.1. Command-line options
  • 12.4.5. Decompression pitfalls
    • 12.4.5.1. From file itself
    • 12.4.5.2. File System limitations
    • 12.4.5.3. Resources limitations
    • 12.4.5.4. Interruption
    • 12.4.5.5. Default behaviors of extraction
• 12.5. tarfile — Read and write tar archive files
  • open()
  • TarFile
  • is_tarfile()
  • TarFileCompat
    • TarFileCompat.TAR_PLAIN
    • TarFileCompat.TAR_GZIPPED
  • TarError
  • ReadError
  • CompressionError
  • StreamError
  • ExtractError
  • ENCODING
  • HeaderError
  • USTAR_FORMAT
  • GNU_FORMAT
  • PAX_FORMAT
  • DEFAULT_FORMAT
  • 12.5.1. TarFile Objects
    • TarFile
    • TarFile.open()
    • TarFile.getmember()
    • TarFile.getmembers()
    • TarFile.getnames()
    • TarFile.list()
    • TarFile.next()
    • TarFile.extractall()
    • TarFile.extract()
    • TarFile.extractfile()
    • TarFile.add()
    • TarFile.addfile()
    • TarFile.gettarinfo()
    • TarFile.close()
    • TarFile.posix
    • TarFile.pax_headers
  • 12.5.2. TarInfo Objects
    • TarInfo
    • TarInfo.frombuf()
    • TarInfo.fromtarfile()
    • TarInfo.tobuf()
    • TarInfo.name
    • TarInfo.size
    • TarInfo.mtime
    • TarInfo.mode
    • TarInfo.type
    • TarInfo.linkname
    • TarInfo.uid
    • TarInfo.gid
    • TarInfo.uname
    • TarInfo.gname
    • TarInfo.pax_headers
    • TarInfo.isfile()
    • TarInfo.isreg()
    • TarInfo.isdir()
    • TarInfo.issym()
    • TarInfo.islnk()
    • TarInfo.ischr()
    • TarInfo.isblk()
    • TarInfo.isfifo()
    • TarInfo.isdev()
  • 12.5.3. Examples
  • 12.5.4. Supported tar formats
  • 12.5.5. Unicode issues