httk.serve.optimade.remote_query

Neutral synchronous query/result protocols over a remote OPTIMADE service.

Exceptions

OptimadeResponseError	A successful HTTP response was not a usable OPTIMADE entry document.
OptimadePaginationError	A remote continuation was unsafe, malformed, or non-terminating.
CountUnavailableError	The service omitted a valid filtered meta.data_available count.

Classes

RemoteSearcher	One portable single-root OPTIMADE query under construction.
RemoteResultColumn	One named scalar projection from a lazy remote result set.
RemoteResultSet	A frozen, lazy and re-iterable remote OPTIMADE result plan.

Module Contents

exception httk.serve.optimade.remote_query.OptimadeResponseError

Bases: httk.serve.optimade.client.OptimadeClientError

A successful HTTP response was not a usable OPTIMADE entry document.

exception httk.serve.optimade.remote_query.OptimadePaginationError

Bases: OptimadeResponseError

A remote continuation was unsafe, malformed, or non-terminating.

exception httk.serve.optimade.remote_query.CountUnavailableError

Bases: OptimadeResponseError, httk.data.CountUnavailableError

The service omitted a valid filtered meta.data_available count.

class httk.serve.optimade.remote_query.RemoteSearcher(store: httk.serve.optimade.client.OptimadeStore, *, response_fields: object = None)

One portable single-root OPTIMADE query under construction.

offset = 0

variable(target: object) → _RemoteVariable

add(expression: object) → None

output(variable: object, name: str) → None

add_sort(field: object, descending: bool = False) → None

set_limit(limit: int) → None

add_offset(offset: int) → None

count() → int

results(**outputs: object) → RemoteResultSet

class httk.serve.optimade.remote_query.RemoteResultColumn(result: RemoteResultSet, index: int)

One named scalar projection from a lazy remote result set.

name

class httk.serve.optimade.remote_query.RemoteResultSet(searcher: RemoteSearcher, outputs: collections.abc.Mapping[str, object] | None = None)

A frozen, lazy and re-iterable remote OPTIMADE result plan.

names

first() → httk.data.ResultRow | None

one() → httk.data.ResultRow

scalars(name: str | None = None) → collections.abc.Iterator[object]

column(name: str) → RemoteResultColumn

abstractmethod cursor() → collections.abc.Iterator[httk.data.ResultRow]