Function meta_values

optimade/server/routers/utils.py:49–88

Helper to initialize the meta values

(
    config: ServerConfig,
    url: urllib.parse.ParseResult | urllib.parse.SplitResult | StarletteURL | str,
    data_returned: int | None,
    data_available: int,
    more_data_available: bool,
    schema: str | None = None,
    **kwargs,
)

def meta_values(
    config: ServerConfig,
    url: urllib.parse.ParseResult | urllib.parse.SplitResult | StarletteURL | str,
    data_returned: int | None,
    data_available: int,
    more_data_available: bool,
    schema: str | None = None,
    **kwargs,
) -> ResponseMeta:
    """Helper to initialize the meta values"""
    from optimade.models import ResponseMetaQuery

    if isinstance(url, str):
        url = urllib.parse.urlparse(url)

    # To catch all (valid) variations of the version part of the URL, a regex is used
    if re.match(r"/v[0-9]+(\.[0-9]+){,2}/.*", url.path) is not None:
        url_path = re.sub(r"/v[0-9]+(\.[0-9]+){,2}/", "/", url.path)
    else:
        url_path = url.path

    if schema is None:
        schema = config.schema_url if not config.is_index else config.index_schema_url

    if config.request_delay:
        # Double-guard against the server setting an adversarially large request delay
        kwargs["request_delay"] = min(config.request_delay, 10.0)

    return ResponseMeta(
        query=ResponseMetaQuery(representation=f"{url_path}?{url.query}"),
        api_version=__api_version__,
        time_stamp=datetime.now(),
        data_returned=data_returned,
        more_data_available=more_data_available,
        provider=config.provider,
        data_available=data_available,
        implementation=config.implementation,
        schema=schema,
        **kwargs,
    )


def handle_response_fields(