zipfile-deflate64

Warnings

• gotcha The standard `zipfile` module in Python does not natively support Deflate64 compression. Attempting to open or extract a Deflate64 ZIP archive without importing `zipfile_deflate64` will result in errors like `BadZipFile` or 'compression method not supported'.
  Fix: Always include `import zipfile_deflate64` at the beginning of any script or module that needs to process Deflate64 ZIP files. Optionally, alias it: `import zipfile_deflate64 as zipfile`.
• breaking Version 0.2.0 fixed significant bugs in `zipfile_deflate64.extractall` and `zipfile_deflate64.extract` (especially with larger files). Users on older versions might encounter issues or incorrect extractions.
  Fix: Upgrade to version 0.2.0 or newer to ensure correct extraction behavior: `pip install --upgrade zipfile-deflate64`.
• gotcha The library's PyPI page lists its development status as '3 - Alpha'. While it provides crucial functionality, this status indicates it may not be fully stable for all production scenarios and could introduce breaking changes in future minor versions.
  Fix: Exercise caution in critical production environments. Regularly check for updates and review release notes when upgrading.

Install

• pip install zipfile-deflate64 Install with pip

Imports

• zipfile_deflate64

  import zipfile_deflate64

  This import has the side effect of patching the standard `zipfile` module to add Deflate64 support. Afterwards, you can use `import zipfile` as normal, or directly use `zipfile_deflate64` as a re-export of the standard API.
• ZipFile

  import zipfile_deflate64 as zipfile
  archive = zipfile.ZipFile('path/to/archive.zip', 'r')

  Using the standard `zipfile` module without first importing `zipfile_deflate64` will result in a `BadZipFile` or 'compression method not supported' error for Deflate64 archives.

Quickstart

After installation, simply importing `zipfile_deflate64` (or aliasing it as `zipfile`) patches the standard library's `zipfile` module, allowing it to correctly handle Deflate64 compressed archives using its familiar API.

import os
import zipfile
import zipfile_deflate64 as custom_zipfile # This line enables Deflate64 support

# Create a dummy (standard Deflate) zip file for demonstration
dummy_zip_path = 'my_test_archive.zip'
with zipfile.ZipFile(dummy_zip_path, 'w', zipfile.ZIP_DEFLATED) as zf:
    zf.writestr('file1.txt', 'Hello from file 1!')
    zf.writestr('folder/file2.txt', 'Content for file 2.')

# Directory to extract to
extract_dir = 'extracted_content'
os.makedirs(extract_dir, exist_ok=True)

try:
    # Use the patched zipfile API to extract
    # This would work for both standard and Deflate64 archives after the import
    with custom_zipfile.ZipFile(dummy_zip_path, 'r') as zip_ref:
        zip_ref.extractall(extract_dir)
    print(f"Successfully extracted '{dummy_zip_path}' to '{extract_dir}'")

    # Verify extraction
    print(f"Content of {os.path.join(extract_dir, 'file1.txt')}: ")
    with open(os.path.join(extract_dir, 'file1.txt'), 'r') as f:
        print(f.read())

except Exception as e:
    print(f"An error occurred: {e}")
finally:
    # Clean up dummy files
    if os.path.exists(dummy_zip_path):
        os.remove(dummy_zip_path)
    if os.path.exists(os.path.join(extract_dir, 'file1.txt')):
        os.remove(os.path.join(extract_dir, 'file1.txt'))
    if os.path.exists(os.path.join(extract_dir, 'folder', 'file2.txt')):
        os.remove(os.path.join(extract_dir, 'folder', 'file2.txt'))
    if os.path.exists(os.path.join(extract_dir, 'folder')):
        os.rmdir(os.path.join(extract_dir, 'folder'))
    if os.path.exists(extract_dir):
        os.rmdir(extract_dir)