httk.optimade.engine

Submodules

• httk.optimade.engine.processing
• httk.optimade.engine.validate

Functions

process(→ httk.optimade.model.request.EndpointResponse)	Process an OPTIMADE query.
process_init(→ None)	Precompute the number of available entries per entry endpoint.
determine_optimade_version(→ str)
validate_optimade_request(...)

Package Contents

httk.optimade.engine.process(request: httk.optimade.model.request.RawRequest, query_function: httk.optimade.model.results.QueryFunction, version: str, config: httk.optimade.model.config.OptimadeConfig, schema: httk.optimade.schema.served.ServedSchema, *, debug: bool = False) → httk.optimade.model.request.EndpointResponse

Process an 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.

httk.optimade.engine.process_init(config: httk.optimade.model.config.OptimadeConfig, query_function: httk.optimade.model.results.QueryFunction, schema: httk.optimade.schema.served.ServedSchema, *, debug: bool = False) → None

Precompute the number of available entries per entry endpoint.

httk.optimade.engine.determine_optimade_version(request: httk.optimade.model.request.RawRequest) → str

httk.optimade.engine.validate_optimade_request(request: httk.optimade.model.request.RawRequest, version: str, schema: httk.optimade.schema.served.ServedSchema) → httk.optimade.model.request.ValidatedRequest