zippathlib 0.6.0

A `pathlib.Path`-like class for accessing the contents of ZIP archives

zippathlib - Provides a pathlib.Path-like class for accessing files in ZIP archives

zippathlib is a Python library that provides a standalone ZipPath class for working with files inside ZIP archives using a familiar pathlib.Path-like interface. This allows you to navigate and access files within a ZIP archive without first extracting them. From your Python code, you can access the contents using the familar pathlib.Path API, instead of the standard library's zipfile module, and perform operations like reading, writing, checking existence of files and directories, etc.

zippathlib is also accessible from the command line, allowing you to list contents of ZIP archives, extract individual files or directories, and view the contents of the ZIP archive as a tree.

• zippathlib - Provides a pathlib.Path-like class for accessing files in ZIP archives
  • Features
  • Doesn't Python's zipfile module already have a Path class?
  • Usage - Command line
    • List the root directory of a ZIP archive
    • List the files in a directory
    • List the first few lines of a file
    • Extract a file from a ZIP archive to the local filesystem
    • Extract a file from a ZIP archive to stdout
    • View the contents of a ZIP archive (or a subdirectory within the ZIP archive) as a tree
  • Usage - zippathlib.ZipPath API
    • Open a file from a ZIP archive for reading
    • Store a file into a ZIP archive, and use the '/' operator to navigate or create directories
    • List all files in a directory within the ZIP
    • Recursively list all directories and files in the ZIP
    • Check if a file exists in the ZIP
  • Installation
  • Testing
  • Contributing
  • License

Features

• ZipPath class provides a pathlib-like API to access ZIP archive files and directories.
• Supports path composition using the '/' operator.
• Supports basic read/write operations on files within a ZIP archive, including opening files for reading, writing data, etc.
• Allows navigating the directory structure within a ZIP archive using familiar pathlib methods like iterdir(), joinpath(), etc. riterdir() provides a recursive listing of the directories and files in the archive.
• Command-line interface for browsing a ZIP archive's contents, or for extracting files to the local filesystem.

Doesn't Python's zipfile module already have a Path class?

The Python standard library module zipfile does provide a Path class, but it is primarily for read support in existing ZIP files. It doesn't provide a complete pathlib-like API for working with files and directories.

Usage - Command line

After installing it, the zippathlib module can be run from the command line with python -m zippathlib or just zippathlib.

$ zippathlib -h
usage: zippathlib [-h] [-V] [--tree] [-x [OUTPUTDIR]] [--limit LIMIT] [--check {duplicates,limit,d,l}] [--purge]
                  zip_file [path_within_zip]

positional arguments:
  zip_file              Zip file to explore
  path_within_zip       Path within the zip file (optional)

options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  --tree                list all files in a tree-like format
  -x, --extract [OUTPUTDIR]
                        extract files from zip file to a directory or '-' for stdout,
                        default is '.'
  --limit LIMIT         guard value against malicious ZIP files that uncompress to excessive
                        sizes; specify as an integer or float value optionally followed by a
                        multiplier suffix K,M,G,T,P,E, or Z; default is 2.00G
  --check {duplicates,limit,d,l}
                        check ZIP file for duplicates, or for files larger than LIMIT
  --purge               purge ZIP file of duplicate file entries

List the root directory of a ZIP archive

$ zippathlib .\dist\zippathlib-0.4.0-py3-none-any.whl
Directory: dist\zippathlib-0.4.0-py3-none-any.whl:: (total size 39.76KB)
Contents:
  [D] zippathlib (28.32KB)
  [D] zippathlib-0.4.0.dist-info (11.44KB)

List the files in a directory

$ zippathlib .\dist\zippathlib-0.4.0-py3-none-any.whl zippathlib-0.4.0.dist-info
Directory: dist\zippathlib-0.4.0-py3-none-any.whl::zippathlib-0.4.0.dist-info (total size 11.44KB)
Contents:
  [D] licenses (1.06KB)
  [F] METADATA (9.49KB)
  [F] WHEEL (91 bytes)
  [F] entry_points.txt (56 bytes)
  [F] top_level.txt (11 bytes)
  [F] RECORD (748 bytes

List the first few lines of a file

$ zippathlib .\dist\zippathlib-0.4.0-py3-none-any.whl zippathlib-0.4.0.dist-info/licenses/LICENSE
File: dist\zippathlib-0.4.0-py3-none-any.whl::zippathlib-0.4.0.dist-info/licenses/LICENSE (1.06KB)
Content:
MIT License

Copyright (c) 2025 Paul McGuire

Permission is hereby granted, free of charge, to a...

Extract a file from a ZIP archive to the local filesystem

# if outputdir is omitted, file is extracted to the current directory
$ zippathlib .\dist\zippathlib-0.4.0-py3-none-any.whl zippathlib-0.4.0.dist-info/licenses/LICENSE --extract tmp
extracting dist\zippathlib-0.4.0-py3-none-any.whl::zippathlib-0.4.0.dist-info/licenses/LICENSE

Extract a file from a ZIP archive to stdout

# if outputdir is "-", file is extracted and printed to stdout
$ zippathlib .\dist\zippathlib-0.4.0-py3-none-any.whl zippathlib-0.4.0.dist-info/licenses/LICENSE --extract -
MIT License

Copyright (c) 2025 Paul McGuire

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
...

View the contents of a ZIP archive (or a subdirectory within the ZIP archive) as a tree

$ zippathlib .\dist\zippathlib-0.4.0-py3-none-any.whl --tree                                                 

├── zippathlib-0.4.0.dist-info
│   ├── RECORD
│   ├── top_level.txt
│   ├── entry_points.txt
│   ├── WHEEL
│   ├── METADATA
│   └── licenses
│       └── LICENSE
└── zippathlib
    ├── zip_pathlib.py
    ├── __main__.py
    └── __init__.py

(Thanks to Will McGugan's rich library for making the tree output so easy.)

Usage - zippathlib.ZipPath API

Here are some examples on how to use ZipPath in your Python code:

Open a file from a ZIP archive for reading

from zippathlib import ZipPath

zip_path = ZipPath('archive.zip', 'path/to/file.txt')
with zip_path.open() as f:
    content = f.read()

Store a file into a ZIP archive, and use the '/' operator to navigate or create directories

from zippathlib import ZipPath

zp = ZipPath('archive.zip')
content_file = zp / 'some/directory' / 'file.txt'
content_file.write_text("This is too easy!")

List all files in a directory within the ZIP

from zippathlib import ZipPath

zip_path = ZipPath('archive.zip')
for file in (zip_path / 'some' / 'directory').iterdir():
    print(file)

Recursively list all directories and files in the ZIP

from zippathlib import ZipPath

zip_path = ZipPath('archive.zip')

# list all contents, in depth first search
for file in zip_path.riterdir():
    print(file)

Check if a file exists in the ZIP

from zippathlib import ZipPath

if ZipPath('archive.zip', 'path/to/file.txt').exists():
    print("File exists")

Installation

You can install ZipPath using pip or pipx:

pip install zippathlib

Testing

Tests are located in the tests directory and can be run using pytest:

pytest tests

Contributing

Contributions are welcome. Please open an issue or submit a pull request on GitHub.

If you have ideas or suggestions, feel free to drop a note in the GitHub repo Discussions.

License

This project is licensed under the MIT License - see the LICENSE file for details.