swh.fuse.fuse module

class swh.fuse.fuse.Fuse(root_path: Path, cache: FuseCache, conf: Dict[str, Any])[source]

Bases: Operations

Software Heritage Filesystem in Userspace (FUSE). Locally mount parts of the archive and navigate it as a virtual file system.

shutdown() → None[source]

inode2entry(inode: int) → FuseEntry[source]: Return the entry matching a given inode

async get_metadata(swhid: CoreSWHID) → Any[source]: Retrieve metadata for a given SWHID using Software Heritage API

async get_blob(swhid: CoreSWHID) → bytes[source]: Retrieve the blob bytes for a given content SWHID using Software Heritage API

async get_history(swhid: CoreSWHID) → List[CoreSWHID][source]: Retrieve a revision’s history using Software Heritage Graph API

async get_visits(url_encoded: str) → List[Dict[str, Any]][source]: Retrieve origin visits given an encoded-URL using Software Heritage API

async get_attrs(entry: FuseEntry) → EntryAttributes[source]: Return entry attributes

async getattr(inode: int, _ctx: RequestContext) → EntryAttributes[source]: Get attributes for a given inode

async opendir(inode: int, _ctx: RequestContext) → int[source]: Open a directory referred by a given inode

async readdir(fh: int, offset: int, token: ReaddirToken) → None[source]: Read entries in an open directory

async open(inode: int, _flags: int, _ctx: RequestContext) → FileInfo[source]: Open an inode and return a unique file handle

async read(fh: int, offset: int, length: int) → bytes[source]: Read length bytes from file handle fh at position offset

async lookup(parent_inode: int, name: str, _ctx: RequestContext) → EntryAttributes[source]: Look up a directory entry by name and get its attributes

async readlink(inode: int, _ctx: RequestContext) → bytes[source]

Return target of symbolic link inode.

ctx will be a RequestContext instance.

async unlink(parent_inode: int, name: str, _ctx: RequestContext) → None[source]: Remove a file

async swh.fuse.fuse.main(swhids: List[CoreSWHID], root_path: Path, conf: Dict[str, Any]) → None[source]: swh-fuse CLI entry-point