archive-path

A package to provide pathlib like access to zip & tar archives.

Installation

$ pip install archive-path

Usage

For reading zip (ZipPath) or tar (TarPath) files:

from archive_path import TarPath, ZipPath

path = TarPath("path/to/file.tar.gz", mode="r:gz")

sub_path = path / "folder" / "file.txt"
assert sub_path.filepath == "path/to/file.tar.gz"
assert sub_path.at == "folder/file.txt"
assert sub_path.exists() and sub_path.is_file()
assert sub_path.parent.is_dir()
content = sub_path.read_text()

for sub_path in path.iterdir():
    print(sub_path)

For writing files, you should use within a context manager, or directly call the close method:

with TarPath("path/to/file.tar.gz", mode="w:gz") as path:

    (path / "new_file.txt").write_text("hallo world")
    # there are also some features equivalent to shutil
    (path / "other_file.txt").putfile("path/to/external_file.txt")
    (path / "other_folder").puttree("path/to/external_folder", pattern="**/*")

Note that archive formats do not allow to overwrite existing files (they will raise a FileExistsError).

For performant access to single files:

from archive_path import read_file_in_tar, read_file_in_zip

content = read_file_in_tar("path/to/file.tar.gz", "file.txt", encoding="utf8")

These methods allow for faster access to files (using less RAM) in archives containing 1000's of files. This is because, the archive's file index is only read until the path is found (discarding non-matches), rather than the standard tarfile/zipfile approach that is to read the entire index into memory first.

Windows compatibility

Paths within the archives are always read and written as being / delimited. This means that the package works on Windows, but will not be compatible with archives written outside this package with \\ path delimiters.

Development

See CONTRIBUTING.md for details on how to contribute to this package.