httk.optimade.model.results

Classes

ResultRow	One entry result: its attribute values plus per-entry envelope data.
QueryResults	The results of a query against a backend, as consumed by the entry endpoints.
QueryFunction	The callback seam through which the request engine runs queries on a backend.

Module Contents

class httk.optimade.model.results.ResultRow

One entry result: its attribute values plus per-entry envelope data.

values: dict[str, Any]

relationships: dict[str, list[dict[str, Any]]]

property_metadata: dict[str, Any]

class httk.optimade.model.results.QueryResults

Bases: Protocol

The results of a query against a backend, as consumed by the entry endpoints.

Iteration yields one ResultRow per entry; its values map OPTIMADE response-field names to values, and the id and type keys are always present.

more_data_available: bool

count() → int

class httk.optimade.model.results.QueryFunction

Bases: Protocol

The callback seam through which the request engine runs queries on a backend.