httk.serve.web

Submodules

• httk.serve.web.api
• httk.serve.web.cli
• httk.serve.web.compat
• httk.serve.web.engine
• httk.serve.web.functions
• httk.serve.web.model
• httk.serve.web.providers
• httk.serve.web.publishing
• httk.serve.web.renderers
• httk.serve.web.resources
• httk.serve.web.runtime
• httk.serve.web.templating
• httk.serve.web.widgets

Attributes

SITE_RESOURCES_KEY

Stable global_data key through which site startup code gets resources.

Classes

ProviderContext	The immutable, site-local context passed to a table provider.
TableColumn	A table column and its small, presentation-only metadata.
TablePage	One provider-owned page of structured rows and opaque navigation cursors.
TableRequest	The bounded page request passed to provide(context, request, ...).
SiteResources	Callbacks owned by one httk.serve.web.engine.site_engine.SiteEngine.

Functions

create_asgi_app(→ starlette.applications.Starlette)
publish(→ httk.serve.web.model.page.PublishReport)
serve(→ None)

Package Contents

httk.serve.web.create_asgi_app(srcdir: str | pathlib.Path, *, baseurl: str | None = None, compatibility_mode: bool = False, config_name: str = 'config', debug: bool = False, table_token_secret: str | bytes | None = None) → starlette.applications.Starlette

httk.serve.web.publish(srcdir: str | pathlib.Path, outdir: str | pathlib.Path, baseurl: str, *, host_static: str | None = None, compatibility_mode: bool = False, config_name: str = 'config', use_urls_without_ext: bool | None = None) → httk.serve.web.model.page.PublishReport

httk.serve.web.serve(srcdir: str | pathlib.Path, *, host: str = '127.0.0.1', port: int = 8080, baseurl: str | None = None, compatibility_mode: bool = False, config_name: str = 'config', debug: bool = False, table_token_secret: str | bytes | None = None) → None

class httk.serve.web.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.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.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.

class httk.serve.web.TableRequest

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

page_size: int = 50

cursor: str | None = None

revision: str | None = None

httk.serve.web.SITE_RESOURCES_KEY = 'httk_serve_resources'

Stable global_data key through which site startup code gets resources.

class httk.serve.web.SiteResources

Callbacks owned by one httk.serve.web.engine.site_engine.SiteEngine.

Site functions/init.py code can obtain this object from global_data[SITE_RESOURCES_KEY] and call register() for every persistent resource it opens. Callbacks run in reverse registration order when the httk.serve.web.engine.site_engine.SiteEngine closes. Closing is idempotent, so ASGI lifespan shutdown and an enclosing helper may both safely close the same engine.

property closed: bool

Whether cleanup has started for this registry.

register(callback: CleanupCallback) → None

Register one synchronous callback to run during close().

Registration after close is a programming error: the callback could no longer be guaranteed to run.

close() → None

Run pending callbacks in LIFO order exactly once.

Every callback gets a chance to run. If cleanup fails, the first exception is re-raised after the remaining callbacks have executed; additional failures are attached as notes for diagnosis.