Module

server.negotiation_oob

OOB helpers for negotiation — shell actions, streamed append.

5Functions

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
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