Module

server.negotiation_oob

OOB helpers for negotiation — shell actions, layout regions, streamed append.

1Class9Functions

Classes

_KidaBlockAdapter 1 ▼
KidaAdapter with error handling for layout contract discovery.

KidaAdapter with error handling for layout contract discovery.

Methods

template_metadata 1 object | None ▼
def template_metadata(self, template: str) -> object | None
Parameters
Name Type Description
template —
Returns
object | None

Functions

_triggers_shell_update 2 bool ▼
Whether this request should trigger shell OOB updates.
def _triggers_shell_update(request: Request | None, fragment_target_registry: FragmentTargetRegistry | None) -> bool
Parameters
Name Type Description
request Request | None
fragment_target_registry FragmentTargetRegistry | None
Returns
bool
resolve_oob_scope 2 str | None ▼
Return the scope name for the current swap target, or None. Boosted requests d…
def resolve_oob_scope(request: Request | None, fragment_target_registry: FragmentTargetRegistry | None) -> str | None

Return the scope name for the current swap target, or None.

Boosted requests default to the broadest scope (Nonemeans "all scopes"). Non-boosted fragment requests return the registered scope_nameso layout OOB blocks can be filtered to the matched scope and its ancestors.

Parameters
Name Type Description
request Request | None
fragment_target_registry FragmentTargetRegistry | None
Returns
str | None
compute_shell_region_updates 3 tuple[RegionUpdate, ...] ▼
Compute shell OOB region updates for boosted/fragment requests.
def compute_shell_region_updates(composition: PageComposition, request: Request | None, fragment_target_registry: FragmentTargetRegistry | None) -> tuple[RegionUpdate, ...]
Parameters
Name Type Description
composition PageComposition
request Request | None
fragment_target_registry FragmentTargetRegistry | None
Returns
tuple[RegionUpdate, ...]
render_shell_actions_oob 2 str ▼
Render shell action OOB markup for boosted layout navigations.
def render_shell_actions_oob(context: dict[str, Any], kida_env: Environment) -> str
Parameters
Name Type Description
context dict[str, Any]
kida_env Environment
Returns
str
append_shell_actions_oob_stream 3 AsyncIterator[str] ▼
Append shell action OOB markup to the first streamed chunk.
async
async def append_shell_actions_oob_stream(chunks: AsyncIterator[str], context: dict[str, Any], kida_env: Environment) -> AsyncIterator[str]
Parameters
Name Type Description
chunks AsyncIterator[str]
context dict[str, Any]
kida_env Environment
Returns
AsyncIterator[str]
should_append_streamed_shell_actions_oob 2 bool ▼
Whether a streamed layout response should refresh shell actions via OOB.
def should_append_streamed_shell_actions_oob(context: dict[str, Any], request: Request | None) -> bool
Parameters
Name Type Description
context dict[str, Any]
request Request | None
Returns
bool
render_layout_oob_blocks 4 str ▼
Render layout OOB blocks (sidebar, breadcrumbs, title) for boosted navigation. …
def render_layout_oob_blocks(kida_env: Environment, layout_chain: LayoutChain, context: dict[str, Any], oob_registry: OOBRegistry | None) -> str

Render layout OOB blocks (sidebar, breadcrumbs, title) for boosted navigation.

Mirrors the OOB region logic inexecute_render_planbut works standalone for streaming responses (Suspense, TemplateStream) that bypass the render plan pipeline.

Parameters
Name Type Description
kida_env Environment
layout_chain LayoutChain
context dict[str, Any]
oob_registry OOBRegistry | None
Returns
str
should_append_layout_oob 2 bool ▼
Whether a streamed layout response should append layout OOB blocks.
def should_append_layout_oob(request: Request | None, layout_chain: LayoutChain | None) -> bool
Parameters
Name Type Description
request Request | None
layout_chain LayoutChain | None
Returns
bool
append_layout_oob_stream 5 AsyncIterator[str] ▼
Append layout OOB markup (sidebar, breadcrumbs, title) to the first chunk.
async
async def append_layout_oob_stream(chunks: AsyncIterator[str], kida_env: Environment, layout_chain: LayoutChain, context: dict[str, Any], oob_registry: OOBRegistry | None) -> AsyncIterator[str]
Parameters
Name Type Description
chunks AsyncIterator[str]
kida_env Environment
layout_chain LayoutChain
context dict[str, Any]
oob_registry OOBRegistry | None
Returns
AsyncIterator[str]