swh.fuse.backends.web_api module

class swh.fuse.backends.web_api.WebApiBackend(conf: Dict, cache: FuseCache)

Bases: GraphBackend, ContentBackend

A Backend querying everything via Software Heritage’s public API.

This is simpler to configure and deploy, but expect long response times.

It gets a pointer to the cache because some endpoints are more verbose than needed, but it allows to pre-cache data for further use. That’s not elegant, but can avoid being rate-limited because of a simple ls archive/rev…/history .

Only needs the web-api key of conf, searching for url and maybe auth-token keys.

async get_metadata(swhid: CoreSWHID) → Dict | List

Entries in the returned dict depend on the swhid type.

For cnt, return a dict containing at least length (int).

For dir, return a list of entries like

{
    "dir_id": "dir's hash",
    "name": "dir item name",
    "type": "str=dir|file|rev",  # yes, `file`...
    "target": "target hash",
    "perms": "permissions [int]",
    # if target is a cnt:
    "length": "file size [int]",
}

For rev, return a dict containing at least directory (SWHID), parents (list of objects containing at least id (hash)), date (str, isoformat), committer_date (str, isoformat), id (object’s hash).

For rel, return a dict containing at least target (SWHID), target_type, date (str, isoformat), id (object’s hash).

For snp, return a dict where each key is a branch name, each value is a dict containing at least target (hash), target_type (content, directory, revision, release, snapshot or alias).

async get_blob(swhid) → bytes

Fetch the content of a cnt object.

async get_history(swhid: CoreSWHID) → List[Tuple[str, str]]

Fetch a thousand (entry, parent) edges from swhid.

As the /log endpoint provides complete metadata objects, we pre-fill the cache by the way: it will be used afterwards by RevisionHistoryShardBy* artifacts.

async get_visits(url_encoded: str) → List[Dict[str, Any]]

Return a list of objects

Each object should contain fields date (ISO), origin (str), snapshot (SWHID’s hash as str)