Installation
http
HTTP request/response types, auth config, and thehttp helper.
Import
Functions
http
Wrap a streaming handler so it receives typed StreamRequest and StreamResponse. Takes a callback(req, res) -> HttpResponse | None and returns a
function the iii engine can invoke directly. The wrapper converts the
raw dict (or InternalHttpRequest) delivered by the engine into the
typed StreamRequest / StreamResponse pair that the callback expects.
Signature
Parameters
Types
HttpAuthApiKey · HttpAuthBearer · HttpAuthHmac · HttpInvocationConfig · HttpRequest · HttpResponse
HttpAuthApiKey
API key sent via a custom header.HttpAuthBearer
Bearer token authentication.HttpAuthHmac
HMAC signature verification using a shared secret.HttpInvocationConfig
Config for HTTP external function invocation.HttpRequest
Represents a buffered HTTP request.HttpResponse
Represents a buffered HTTP response.observability
Logger, OpenTelemetry config, and span helpers. ImportFunctions
current_span_id
Return current active span_id as 16-char hex, or None when unavailable. Signaturecurrent_span_is_recording
ReturnsFalse when there is no active span or the sampler dropped it.
Signature
current_trace_id
Return current active trace_id as 32-char hex, or None when unavailable. Signatureexecute_traced_request
Execute an httpx Request inside an OTel CLIENT span.- Injects W3C traceparent into outgoing request headers.
- Records HTTP semantic-convention attributes on the span.
- Sets ERROR span status for responses with status >= 400.
- Records exceptions for network-level errors.
Parameters
extract_baggage
Extract baggage from a W3C baggage header string. SignatureParameters
extract_traceparent
Extract a trace context from a W3C traceparent header string. SignatureParameters
flush_otel
Force-flush all OTel providers without tearing them down. Counterpart to :func:shutdown_otel. Use before short-lived process exits
where you want pending spans/metrics/logs delivered but plan to keep using
OTel afterwards.
Signature
init_otel
Initialize OpenTelemetry. Subsequent calls are no-ops. SignatureParameters
inject_baggage
Inject the current baggage into a W3C baggage header string. Signatureinject_traceparent
Inject the current trace context into a W3C traceparent header string. Signaturerecord_span_event
No-op when the current span is not recording. SignatureParameters
redact
SignatureParameters
redact_and_truncate
SignatureParameters
resolve_max_bytes_from_env
Signatureset_current_span_attribute
No-op when the current span is not recording. SignatureParameters
set_current_span_error
No-op when there is no active span. SignatureParameters
shutdown_otel
Shut down OTel synchronously (best-effort; does not await WS flush). Signaturewith_span
Start a new span and run fn(span) within it. If the tracer is not initialized, fn is called with a no-op span that silently ignores attribute/event calls. SignatureParameters
Types
BaggageSpanProcessor · Logger · OtelConfig · ReconnectionConfig
BaggageSpanProcessor
Logger
Structured logger that emits logs as OpenTelemetry LogRecords. Every log call automatically captures the active trace and span context, correlating your logs with distributed traces without any manual wiring. When OTel is not initialized, Logger gracefully falls back to Pythonlogging.
Pass structured data as the second argument to any log method. Using a
dict of key-value pairs (instead of string interpolation) lets you
filter, aggregate, and build dashboards in your observability backend.
OtelConfig
Configuration for OpenTelemetry initialization.ReconnectionConfig
Configuration for WebSocket reconnection behavior.queue
Queue enqueue result types. ImportTypes
EnqueueResult
EnqueueResult
Result returned when a function is invoked withTriggerAction.Enqueue.
stream
Stream trigger configs, change events, IO inputs, and update operations. ImportTypes
StreamAuthInput · StreamAuthResult · StreamChangeEvent · StreamChangeEventDetail · StreamDeleteInput · StreamDeleteResult · StreamGetInput · StreamJoinLeaveEvent · StreamJoinLeaveTriggerConfig · StreamJoinResult · StreamListGroupsInput · StreamListInput · StreamSetInput · StreamSetResult · StreamTriggerConfig · StreamUpdateInput · StreamUpdateResult · UpdateAppend · UpdateDecrement · UpdateIncrement · UpdateMerge · UpdateOpError · UpdateRemove · UpdateSet
StreamAuthInput
Input for stream authentication.StreamAuthResult
Result of stream authentication.StreamChangeEvent
Handler input forstream triggers, fired when an item changes.
StreamChangeEventDetail
Detail of a stream change event containing the mutation type and data.StreamDeleteInput
Input for stream delete operation.StreamDeleteResult
Result of stream delete operation.StreamGetInput
Input for stream get operation.StreamJoinLeaveEvent
Event for stream join/leave.StreamJoinLeaveTriggerConfig
Trigger config forstream:join and stream:leave triggers.
StreamJoinResult
Result of stream join.StreamListGroupsInput
Input for stream list groups operation.StreamListInput
Input for stream list operation.StreamSetInput
Input for stream set operation.StreamSetResult
Result of stream set operation.StreamTriggerConfig
Trigger config forstream triggers. Filters which item changes fire the handler.
StreamUpdateInput
Input for stream update operation.StreamUpdateResult
Result of stream update operation.UpdateAppend
Append an element to an array, concatenate a string, or push at a nested path. The target is the root (whenpath is omitted, an empty string,
or an empty list), a single first-level key (when path is a
non-empty string), or an arbitrary nested location (when path
is a list of literal segments).
Path forms accepted (mirrors :class:UpdateMerge after #1547):
None/""/[]: append at the root."foo": append at the first-level keyfoo. A dotted string like"a.b"is the literal key"a.b", not traversed asa -> b.["a", "b", "c"]: nested path; each element is a literal segment.
- Missing/non-object intermediates along a nested path are
auto-created/replaced with
\{\}. - At the leaf:
- missing/null + nested path ->
[value](always an array) - missing/null + single-string path -> string-as-string for
the string-concat tier, otherwise
[value] - existing array -> push
- existing string + string value -> concatenate
- existing object/scalar at the leaf ->
append.type_mismatch
- missing/null + nested path ->
__proto__ / constructor / prototype
segment) are rejected with a structured error in the errors
field of the state::update / stream::update response. The
append does not apply when an error is returned for that op.
UpdateDecrement
Decrement operation for stream update.UpdateIncrement
Increment operation for stream update.UpdateMerge
Shallow merge an object into the target. The target is the root (whenpath is omitted, an empty string,
or an empty list) or an arbitrary nested location specified by an
array of literal segments.
Path forms accepted:
None/""/[]: merge at the root."foo": equivalent to["foo"]— single first-level key.["a", "b", "c"]: nested path. Each element is a literal key.["a.b"]writes a single key named"a.b", nota -> b.
- Missing or non-object intermediates along the path are
auto-replaced with
\{\}. - The merge is shallow at the target node (top-level keys of
valueoverwrite same-named keys; siblings preserved).
__proto__ / constructor / prototype segment or
top-level key) are rejected with a structured error in the
errors array of the state::update / stream::update
response. The merge does not apply when an error is returned.
UpdateOpError
Per-op error returned bystate::update / stream::update.
Currently emitted only by the merge op when input violates the
new validation bounds. Successfully applied ops are still
reflected in the response’s new_value.
UpdateRemove
Remove operation for stream update.UpdateSet
Set operation for stream update.worker_connection_manager
RBAC auth and registration callback types. ImportTypes
AuthInput · AuthResult · OnFunctionRegistrationInput · OnFunctionRegistrationResult · OnTriggerRegistrationInput · OnTriggerRegistrationResult · OnTriggerTypeRegistrationInput · OnTriggerTypeRegistrationResult
AuthInput
Input passed to the RBAC auth function during WebSocket upgrade. Contains the HTTP headers, query parameters, and client IP from the connecting worker’s upgrade request.AuthResult
Return value from the RBAC auth function. Controls which functions the authenticated worker can invoke and what context is forwarded to the middleware.OnFunctionRegistrationInput
Input passed to theon_function_registration_function_id hook
when a worker attempts to register a function through the RBAC port.
Return an OnFunctionRegistrationResult with the (possibly mapped)
fields, or raise an exception to deny the registration.
OnFunctionRegistrationResult
Result returned from theon_function_registration_function_id hook.
Omitted fields keep the original value from the registration request.
OnTriggerRegistrationInput
Input passed to theon_trigger_registration_function_id hook
when a worker attempts to register a trigger through the RBAC port.
Return an OnTriggerRegistrationResult with the (possibly mapped)
fields, or raise an exception to deny the registration.
OnTriggerRegistrationResult
Result returned from theon_trigger_registration_function_id hook.
Omitted fields keep the original value from the registration request.
OnTriggerTypeRegistrationInput
Input passed to theon_trigger_type_registration_function_id hook
when a worker attempts to register a new trigger type through the RBAC port.
Return an OnTriggerTypeRegistrationResult with the (possibly mapped)
fields, or raise an exception to deny the registration.
OnTriggerTypeRegistrationResult
Result returned from theon_trigger_type_registration_function_id hook.
Omitted fields keep the original value from the registration request.