httk.serve.web.engine

Provide site discovery and rendering engines.

Submodules

• httk.serve.web.engine.discovery
• httk.serve.web.engine.site_engine

Classes

SiteEngine

Render a configured site and own its engine-local resources.

Package Contents

class httk.serve.web.engine.SiteEngine(config, *, table_token_secret=None)

Render a configured site and own its engine-local resources.

Parameters:

• config (httk.serve.web.model.config.SiteConfig) – Site directory and rendering configuration.

• table_token_secret (str | bytes | None) – Secret used to authenticate table continuation tokens.

config

resources

template_engine: httk.serve.web.templating.TemplateEngine

function_handler

widget_loader

widget_assets

global_data: dict[str, object]

close()

Release resources registered by site startup code exactly once.

resolve(route)

Resolve a route without rendering its contents.

Parameters:

route (str) – Site route to resolve.

Returns:

Description of the matching static, content, or missing route.

Return type:

httk.serve.web.model.page.ResolvedRoute

render(route, query=None, request=None)

Render one site route for serving or static publication.

Parameters:

• route (str) – Site route to render.

• query (dict[str, str] | None) – Optional query parameters for non-request rendering.

• request (httk.serve.web.model.request.HttpRequestContext | None) – Optional request context; its presence selects live rendering.

Returns:

Rendered response body and publication metadata.

Raises:

• httk.serve.web.model.errors.NotFoundError – If the route has no renderable source.

• httk.serve.web.model.errors.WidgetError – If widget extraction or rendering fails.

Return type:

httk.serve.web.model.page.PageResult