_FlowDefinition

Flow wrapper returned by @flow.

Functions

func__init__(self, func, *, stack, image, cache, retries) -> None

Initialize a Kitaru flow wrapper.

paramself

paramfuncCallable[..., Any]

User flow function.

paramstackstr | None

Default stack override.

paramimageImageSetting | None

Default image settings.

paramcachebool | None

Default cache behavior.

paramretriesint | None

Default retry count.

Returns

None

func__call__(self, *args, **kwargs) -> Any

Raise a friendly error — direct flow calls are not supported.

paramself

paramargsAny

= ()

paramkwargsAny

= {}

Returns

typing.Any

funcrun(self, *args, *, stack=None, image=None, cache=None, retries=None, **kwargs) -> FlowHandle

Run a flow execution and return a handle.

paramself

paramargsAny

= ()

paramstackstr | None

= None

Optional stack override.

paramimageImageSetting | None

= None

Optional image override.

paramcachebool | None

= None

Optional cache override.

paramretriesint | None

= None

Optional retry override.

paramkwargsAny

= {}

Returns

kitaru.flow.FlowHandle

A handle for the started execution.

funcreplay(self, exec_id, *, from_, overrides=None, stack=None, image=None, cache=None, retries=None, **flow_inputs) -> FlowHandle

Replay a prior execution from a checkpoint boundary.

paramself

paramexec_idstr

Source execution ID.

paramfrom_str

Checkpoint selector (name, invocation ID, or call ID).

paramoverridesdict[str, Any] | None

= None

Optional checkpoint.* override map.

paramstackstr | None

= None

Optional stack override for the replay run.

paramimageImageSetting | None

= None

Optional image override for the replay run.

paramcachebool | None

= None

Optional cache override for the replay run.

paramretriesint | None

= None

Optional retry override for the replay run.

paramflow_inputsAny

= {}

Returns

kitaru.flow.FlowHandle

A handle for the replayed execution.

func_submit(self, *, args, kwargs, invocation_overrides) -> FlowHandle

Submit an execution using resolved runtime settings.

paramself

paramargstuple[Any, ...]

Flow input args.

paramkwargsdict[str, Any]

Flow input kwargs.

paraminvocation_overridesKitaruConfig

Invocation-time execution overrides.

Returns

kitaru.flow.FlowHandle

A handle for the started execution.

_FlowDefinition

Functions

On this page