httk.optimade.model.request

Classes

RawRequest	An incoming OPTIMADE request, as handed over by the web layer.
RequestedSlice	A slice requested via the dimension_slices query parameter.
ValidatedParameters	Validated URL query parameters of an OPTIMADE request.
ValidatedRequest	The result of validating a RawRequest.
EndpointResponse	A response produced by an endpoint, to be serialized by the web layer.

Module Contents

class httk.optimade.model.request.RawRequest

An incoming OPTIMADE request, as handed over by the web layer.

Only baseurl and representation are mandatory; missing information is derived from representation during validation.

baseurl: str

representation: str

relurl: str | None = None

querystr: str | None = None

query: dict[str, str] | None = None

endpoint: str | None = None

request_id: str | None = None

version: str | None = None

class httk.optimade.model.request.RequestedSlice

A slice requested via the dimension_slices query parameter.

The values are stored exactly as given (a None component means the client omitted it and the default applies). Per the OPTIMADE specification, stop is inclusive.

start: int | None = None

stop: int | None = None

step: int | None = None

class httk.optimade.model.request.ValidatedParameters

Validated URL query parameters of an OPTIMADE request.

response_format: str = 'json'

page_limit: int = 50

page_offset: int = 0

response_fields: str | None = None

filter: str | None = None

sort: str | None = None

include: str | None = None

dimension_slices: dict[str, RequestedSlice]

as_query_dict() → dict[str, str]

Return the parameters as a URL query dict, omitting unset values.

class httk.optimade.model.request.ValidatedRequest

The result of validating a RawRequest.

baseurl: str

representation: str

endpoint: str

version: str

query: ValidatedParameters

url_version: str | None = None

request_id: str | None = None

recognized_response_fields: list[str] = []

unrecognized_response_fields: list[str] = []

sort_fields: list[tuple[str, bool]] = []

include_paths: list[str] = []

property_metadata_requested: bool = False

partial_data_parts: tuple[str, str, str] | None = None

partial_data_offset: int = 0

warnings: list[dict[str, Any]] = []

class httk.optimade.model.request.EndpointResponse

A response produced by an endpoint, to be serialized by the web layer.

Either json_response (a JSON:API document) or content (a raw body) is set.

response_code: int = 200

response_msg: str = 'OK'

content_type: str = 'application/vnd.api+json'

encoding: str = 'utf-8'

content: str | None = None

json_response: dict[str, Any] | None = None