httk.core.files

Stdlib-only storage records for OPTIMADE files entries.

FileRecord stores file metadata and a flat sha256 digest. The URL is part of identity deliberately: two paths to the same bytes are two entries. The mapping-valued checksums field is skipped because SQL storage cannot persist mappings; use sha256 for the storable digest.

Attributes

FILES_DEFINITION_ID

Classes

FileRecord	Store one OPTIMADE files entry with content identity metadata.
FileEntry	Logical entry family for served FileRecord records.

Module Contents

httk.core.files.FILES_DEFINITION_ID = 'https://schemas.optimade.org/defs/v1.2/entrytypes/optimade/files'

class httk.core.files.FileRecord

Bases: httk.core.entry_types.File

Store one OPTIMADE files entry with content identity metadata.

URL and name remain required positional fields. The URL is included in identity so separate paths to identical bytes remain separate entries. The human-readable and immutable identifiers, metadata timestamps, and other metadata are excluded from content identity. checksums is skipped because mapping fields are not SQL-storable; store the flat sha256 value when a storable digest is needed.

Parameters:

• url – The URL to get the contents of the file.

• name – The base name of the file.

• id – The human-readable entry id shared by all revisions; minted by the store when None.

• immutable_id – The per-revision immutable id; minted by the store when None.

• last_modified – The optional timezone-aware metadata timestamp.

• url_stable_until – The optional URL stability deadline.

• size – The file size in bytes, if known.

• media_type – The file MIME type, if known.

• version – The file version, if known.

• modification_timestamp – The optional content modification timestamp.

• description – An optional free-form file description.

• checksums – Optional checksums, kept out of SQL storage.

• atime – The optional POSIX access timestamp.

• ctime – The optional POSIX status-change timestamp.

• mtime – The optional POSIX modification timestamp.

• sha256 – The optional flat SHA-256 digest.

id: Annotated[str | None, IdentitySkip(), Indexed()] = None

immutable_id: Annotated[str | None, IdentitySkip(), Unique()] = None

last_modified: Annotated[datetime.datetime | None, IdentitySkip()] = None

url_stable_until: Annotated[datetime.datetime | None, IdentitySkip()] = None

size: int | None = None

media_type: str | None = None

version: str | None = None

modification_timestamp: Annotated[datetime.datetime | None, IdentitySkip()] = None

description: str | None = None

checksums: Annotated[collections.abc.Mapping[str, str] | None, Skip()] = None

atime: Annotated[datetime.datetime | None, IdentitySkip()] = None

ctime: Annotated[datetime.datetime | None, IdentitySkip()] = None

mtime: Annotated[datetime.datetime | None, IdentitySkip()] = None

sha256: str | None = None

property type: str

Return the served entry type name.

class httk.core.files.FileEntry

Logical entry family for served FileRecord records.

This family is not itself storable; store a FileRecord directly.

type = 'files'

definition_id = 'https://schemas.optimade.org/defs/v1.2/entrytypes/optimade/files'