fsspec-fuse

Mount fsspec filesystems with FUSE

Overview

fsspec-fuse mounts an fsspec URL as a read-only local directory, so any program can list and read it with ordinary file operations.

fsspec-fuse s3://my-bucket/reports /mnt/reports -o region=us-east-1
ls /mnt/reports

URLs resolve through the filesystem registry that fsspec-rs shares between extensions. Native backends (file://, s3://, and protocols registered by packages such as fsspec-db and fsspec-kafka) run in Rust. Any other protocol falls back to the Python fsspec implementation installed for it, such as gcsfs or adlfs.

From Python, mount returns a handle that unmounts on unmount() or when its with block ends:

import os

from fsspec_fuse import mount

with mount("s3://my-bucket/reports", "/mnt/reports", region="us-east-1"):
    print(os.listdir("/mnt/reports"))

Storage options pass to the backend as strings. threads sets how many requests the mount serves at once (default 4).

Requirements

• Linux: FUSE 3 (fusermount3, from the fuse3 package on Debian and Ubuntu).
• macOS: macFUSE.
• Windows is not supported yet.

Mounts are read-only. Writes, creating files, and renames fail with EROFS.

Documentation

Start with Mount a directory and read it. Mount a remote filesystem covers S3, Python-only backends, concurrency, and stale mounts.

Look up the command line, the Python API, or mount behavior such as attributes and error codes. How one mount reaches Rust and Python backends covers the design and its costs.