httk.serve.optimade.engine.processing

Endpoint dispatch: routes a validated OPTIMADE request to its reply generator.

Attributes

SnapshotCutoff

Functions

process(request, query_function, version, config, ...)

Process one OPTIMADE query.

Module Contents

type httk.serve.optimade.engine.processing.SnapshotCutoff = Callable[[str, int], int | None]

httk.serve.optimade.engine.processing.process(request, query_function, version, config, schema, *, snapshot_cutoff_ns=None, debug=False)

Process one OPTIMADE query.

request carries the incoming request; only baseurl and representation must be set, missing information is derived from representation. query_function is the callback used to execute entry queries against the backend. schema describes the served entry types and properties.

Parameters:

• request (httk.serve.optimade.model.request.RawRequest) – Raw request to validate and dispatch.

• query_function (httk.serve.optimade.model.results.QueryFunction) – Backend callback used for entry queries.

• version (str) – API version selected for the request.

• config (httk.serve.optimade.model.config.OptimadeConfig) – Service response configuration.

• schema (httk.serve.optimade.schema.served.ServedSchema) – Explicit served schema for endpoint validation.

• snapshot_cutoff_ns (SnapshotCutoff | None) – Optional stored-backend snapshot capability.

• debug (bool) – Enable backend diagnostics.

Returns:

Endpoint response before web serialization.

Raises:

httk.serve.optimade.model.errors.OptimadeError – If request validation or endpoint processing fails.

Return type:

httk.serve.optimade.model.request.EndpointResponse