fastar

Warnings

• breaking Versions prior to 0.9.0 may contain security vulnerabilities (CVE-2026-32766 and CVE-2026-33056) inherited from underlying Rust crates like `rust-tar`.
  Fix: Upgrade to fastar version 0.9.0 or later to ensure these security fixes are applied: `pip install --upgrade fastar`.
• gotcha The `fastar.open` method supports various modes for compression (`w`, `w:gz`, `w:zst`, `r`, `r:`, `r:gz`, `r:zst`). Using the wrong mode for a compressed archive can lead to errors or corrupted data.
  Fix: Always explicitly specify the compression mode (e.g., 'w:gz' for gzip, 'w:zst' for Zstandard) when creating compressed archives, or use 'r' for automatic detection when reading.

Install

• pip install fastar Install with pip

Imports

• fastar

  import fastar

  The primary way to interact with the library is through the top-level 'fastar' module.

Quickstart

This quickstart demonstrates how to create a simple text file, add it to an uncompressed tar archive using `fastar.open` in write mode, and then extract its contents using read mode. It highlights the basic `append` and `unpack` operations.

from pathlib import Path
import fastar
import os

# Create a dummy file
input_file = Path("file.txt")
input_file.write_text("Hello, Fastar!")

# Create a tar archive (uncompressed)
with fastar.open("archive.tar", "w") as archive:
    archive.append(input_file)

# Extract the tar archive
output_dir = Path("output")
output_dir.mkdir(exist_ok=True)
with fastar.open("archive.tar", "r") as archive:
    archive.unpack(output_dir)

unpacked_file = output_dir / "file.txt"
print(f"Unpacked file content: {unpacked_file.read_text()}")

# Clean up (optional)
input_file.unlink()
Path("archive.tar").unlink()
output_dir.rmdir()