httk.serve.web.providers

Small, dependency-free contracts for site-local paginated data providers.

Attributes

MAX_CURSOR_CHARS
MAX_ROW_DATA_BYTES

Classes

ProviderContext	The immutable, site-local context passed to a table provider.
TableRequest	The bounded page request passed to provide(context, request, ...).
TableColumn	A table column and its small, presentation-only metadata.
TablePage	One provider-owned page of structured rows and opaque navigation cursors.

Functions

immutable_mapping(→ collections.abc.Mapping[str, object])

Take a recursively immutable snapshot suitable for provider context.

Module Contents

httk.serve.web.providers.MAX_CURSOR_CHARS = 16384

httk.serve.web.providers.MAX_ROW_DATA_BYTES = 512000

httk.serve.web.providers.immutable_mapping(values: collections.abc.Mapping[str, object]) → collections.abc.Mapping[str, object]

Take a recursively immutable snapshot suitable for provider context.

class httk.serve.web.providers.ProviderContext

The immutable, site-local context passed to a table provider.

route: str

widget_id: str

query: collections.abc.Mapping[str, str]

page: collections.abc.Mapping[str, object]

global_data: collections.abc.Mapping[str, object]

url_for(route: str, *, query: collections.abc.Mapping[str, str] | None = None) → str

Build a site-local route URL without exposing the ASGI request.

class httk.serve.web.providers.TableRequest

The bounded page request passed to provide(context, request, ...).

page_size: int = 50

cursor: str | None = None

revision: str | None = None

class httk.serve.web.providers.TableColumn

A table column and its small, presentation-only metadata.

key: str

label: str

align: str | None = None

class_name: str | None = None

classmethod from_value(value: Self | str | collections.abc.Mapping[str, object]) → Self

Adapt the compact forms useful in small, site-local providers.

class httk.serve.web.providers.TablePage

One provider-owned page of structured rows and opaque navigation cursors.

rows: tuple[collections.abc.Mapping[str, object], Ellipsis]

columns: tuple[TableColumn, Ellipsis]

next_cursor: str | None = None

previous_cursor: str | None = None

total: int | None = None

revision: str | None = None

classmethod from_rows(rows: collections.abc.Iterable[collections.abc.Mapping[str, object]], *, columns: collections.abc.Iterable[TableColumn | str | collections.abc.Mapping[str, object]], next_cursor: str | None = None, previous_cursor: str | None = None, total: int | None = None, revision: str | None = None) → Self

Construct a page while adapting compact column declarations.

classmethod from_result(value: object) → Self

Accept a TablePage or the equivalent explicit mapping.