scverse_misc.datasets.FileEntry

class scverse_misc.datasets.FileEntry(name, url=None, s3_key=None, sha256=None, fallback_urls=None)

A single downloadable file belonging to a dataset.

Attributes table

name	File name as it should appear on disk (e.g. "cells.zip").
url	Full download URL (e.g. a Zenodo file URL).
s3_key	Key relative to the registry's base_url.
sha256	Expected SHA-256 hash.
fallback_urls	List of fallback download URLs to use in case the primary URL or the S3 bucket fail.

Attributes

FileEntry.name: str

File name as it should appear on disk (e.g. "cells.zip").

FileEntry.url: str | None

Full download URL (e.g. a Zenodo file URL). Takes precedence over s3_key.

FileEntry.s3_key: str | None

Key relative to the registry’s base_url. Used when url is unset.

FileEntry.sha256: str | None

Expected SHA-256 hash. If set, downloads are verified against it.

FileEntry.fallback_urls: list[str] | None

List of fallback download URLs to use in case the primary URL or the S3 bucket fail.

Methods

FileEntry.resolve_url(base_url=None)

Resolve the download URL: the explicit url if set, else base_url/s3_key.

Return type:

str