httk.registry.entries.core

Register core entry families, records, and typed OPTIMADE bindings lazily.

Functions

register_entry_family(*, name, family[, definition_id])

Register a lazy entry-family class reference without importing it.

register_entry_record(*, name, record[, family, ...])

Register a lazy record-class reference and optional family and definition IRI.

register_optimade_entry_binding(*, name, ...[, ...])

Register one lazy typed binding, selected only by exact definition IRI.

Package Contents

httk.registry.entries.core.register_entry_family(*, name, family, definition_id=None)[source]

Register a lazy entry-family class reference without importing it.

Parameters:

  • name (str) – The entry-family registry name.

  • family (str) – The lazy "module:class" family reference.

  • definition_id (str | None) – The family’s definition IRI, if any.

Raises:

ValueError – If validation fails or name is already registered.

httk.registry.entries.core.register_entry_record(*, name, record, family=None, definition_id=None)[source]

Register a lazy record-class reference and optional family and definition IRI.

Parameters:

  • name (str) – The record registry name.

  • record (str) – The lazy "module:class" record reference.

  • family (str | None) – The logical entry-family name, if any.

  • definition_id (str | None) – The record’s definition IRI, if any.

Raises:

ValueError – If validation fails or name is already registered.

httk.registry.entries.core.register_optimade_entry_binding(*, name, definition_id, backend, view, property_decoders=None, query_fields=None)[source]

Register one lazy typed binding, selected only by exact definition IRI.

Parameters:

  • name (str) – The binding registry name.

  • definition_id (str) – The exact entry-type definition IRI selected by the binding.

  • backend (str) – The lazy backend class reference.

  • view (str) – The lazy view class reference.

  • property_decoders (collections.abc.Mapping[str, str] | None) – Property definition IRIs mapped to lazy decoder references.

  • query_fields (tuple[str, Ellipsis] | None) – Property definition IRIs supported for querying, if restricted.

Raises:

ValueError – If the definition IRI is already registered or input is invalid.