GitHub

API reference for Query.

class Query[P, Q, B, H, A, E]

A query atom as a function of the request parts its endpoint declares (AtomHttpApiClient.query_of). The endpoint fixes the parts' types before they are given, so a wrong part is a type error.

Functions

__init__

__init__(query) -> None
ParameterTypeDescription
queryCallable[..., Atom[AsyncResult[A, E]]]
def __init__(self, query: Callable[..., Atom[AsyncResult[A, E]]]) -> None:
    self._query = query

__call__

__call__(*, params=None, query=None, payload=None, headers=None, sse_options=None, reactivity_keys=None, time_to_live=None, serialization_key=None) -> Atom[AsyncResult[A, E]]
ParameterTypeDescription
paramsP | None = None
queryQ | None = None
payloadB | None = None
headersH | None = None
sse_optionsSseOptions | None = None
reactivity_keysKeys | None = None
time_to_liveDurationInput | None = None
serialization_keystr | None = None

Returns Atom[AsyncResult[A, E]]

def __call__(
    self,
    *,
    params: P | None = None,
    query: Q | None = None,
    payload: B | None = None,
    headers: H | None = None,
    sse_options: SseOptions | None = None,
    reactivity_keys: Keys | None = None,
    time_to_live: DurationInput | None = None,
    serialization_key: str | None = None,
) -> Atom[AsyncResult[A, E]]:
    return self._query(
        params=params,
        query=query,
        payload=payload,
        headers=headers,
        sse_options=sse_options,
        reactivity_keys=reactivity_keys,
        time_to_live=time_to_live,
        serialization_key=serialization_key,
    )