Whether update and signal handlers have finished executing.

Consider waiting on this condition before workflow return or continue-as-new, to preventinterruption of in-progress handlers by workflow exit:await workflow.wait_condition(lambda:workflow.all_handlers_finished())

Return an iterator whose values are coroutines.

This is a deterministic version ofasyncio.as_completed. Thisfunction should be used instead of that one in workflows.

Stop the workflow immediately and continue as new.

Create a Nexus client.

Info for the current update if any.

This is powered bycontextvars so it is only valid within theupdate handler and coroutines/tasks it has started.

Decorator for workflow classes.

This must be set on any registered workflow class (it is ignored if on abase class).

Mark a patch as deprecated.

This marks a workflow that hadpatched in a previous version ofthe code as no longer applicable because all workflows that use the old codepath are done and will never be queried again. Therefore the old code pathis removed as well.

Decorator to allow configuring a dynamic workflow's behavior.

Because dynamic workflows may conceptually represent more than one workflow type, it may bedesirable to have different settings for fields that would normally be passed todefn, but vary based on the workflow type name or other information available inthe workflow's context. This function will be called after the workflow'sinit,if it has one, but before the workflow'srun method.

The method must only take self as a parameter, and any values set in the class it returns willoverride those provided todefn.

Cannot be specified on non-dynamic workflows.

Start an activity and wait for completion.

This is a shortcut forawaitstart_activity.

Start an activity from a callable class and wait for completion.

This is a shortcut forawaitstart_activity_class.

Start an activity from a method and wait for completion.

This is a shortcut forawaitstart_activity_method.

Start a child workflow and wait for completion.

This is a shortcut forawait (awaitstart_child_workflow).

Start a local activity and wait for completion.

This is a shortcut forawaitstart_local_activity.

Start a local activity from a callable class and wait for completion.

This is a shortcut forawaitstart_local_activity_class.

Start a local activity from a method and wait for completion.

This is a shortcut forawaitstart_local_activity_method.

External functions available in the workflow sandbox.

Get the current details of the workflow which may appear in the UI/CLI.Unlike static details set at start, this value can be updated throughoutthe life of the workflow and is independent of the static details.This can be in Temporal markdown format and can span multiple lines.

Get the dynamic query handler if any.

This includes dynamic handlers created via the@workflow.querydecorator.

Get the dynamic signal handler if any.

This includes dynamic handlers created via the@workflow.signaldecorator.

Get the dynamic update handler if any.

This includes dynamic handlers created via the@workflow.updatedecorator.

Get a workflow handle to an existing workflow by its ID.

Get a typed workflow handle to an existing workflow by its ID.

This is the same asget_external_workflow_handle but typed. Note,the workflow type given is not validated, it is only for typing.

Get the result of the last run of the workflow. This will be None if there wasno previous completion or the result was None. has_last_completion_result()can be used to differentiate.

Get the last failure of the workflow if it has run previously.

Get the query handler for the given name if any.

This includes handlers created via the@workflow.query decorator.

Get the signal handler for the given name if any.

This includes handlers created via the@workflow.signal decorator.

Get the update handler for the given name if any.

This includes handlers created via the@workflow.update decorator.

Gets whether there is a last completion result of the workflow.

Whether the code is currently running in a workflow.

Current workflow's info.

Decorator for the workflow init method.

This may be used on the __init__ method of the workflow class to specifythat it accepts the same workflow input arguments as the@workflow.runmethod. If used, the parameters of your __init__ and@workflow.runmethods must be identical.

Current workflow's instance.

Checks if the given exception is a workflow failure in the current workflow.

Current workflow's memo values, converted without type hints.

Since type hints are not used, the default converted values will come back.For example, if the memo was originally created with a dataclass, the valuewill be a dict. To convert using proper type hints, usememo_value.

Memo value for the given key, optional default, and optional typehint.

Get the metric meter for the current workflow.

This meter is replay safe which means that metrics will not be recordedduring replay.

Current time from the workflow perspective.

This is the workflow equivalent ofdatetime.now with thetimezone.utc parameter.

Patch a workflow.

When called, this will only return true if code should take the newer pathwhich means this is either not replaying or is replaying and has seen thispatch before.

Usedeprecate_patch when all workflows are done and will never bequeried again. The old code path can be used at that time too.

Get the payload converter for the current workflow.

The returned converter hastemporalio.converter.WorkflowSerializationContext set.This is often used for dynamic workflows/signals/queries to convertpayloads.

Decorator for a workflow query method.

This is used on any non-async method that expects to handle a query. If afunction overrides one with this decorator, it too must be decorated.

Query methods can only have positional parameters. Best practice fornon-dynamic query methods is to only take a single object/dataclassargument that can accept more fields later if needed. The return value isthe resulting query value. Query methods must not mutate any workflow state.

Get a deterministic pseudo-random number generator.

Note, this random number generator is not cryptographically safe and shouldnot be used for security purposes.

Decorator for the workflow run method.

This must be used on one and only one async method defined on the same classas@workflow.defn. This can be defined on a base class method but mustthen be explicitly overridden and defined on the workflow class.

Run methods can only have positional parameters. Best practice is to onlytake a single object/dataclass argument that can accept more fields later ifneeded.

Set the current details of the workflow which may appear in the UI/CLI.Unlike static details set at start, this value can be updated throughoutthe life of the workflow and is independent of the static details.This can be in Temporal markdown format and can span multiple lines.

Set or unset the dynamic query handler.

This overrides the existing dynamic handler even if it was created via the@workflow.query decorator.

Set or unset the dynamic signal handler.

This overrides the existing dynamic handler even if it was created via the@workflow.signal decorator.

When set, all unhandled past signals are immediately sent to the handler.

Set or unset the dynamic update handler.

This overrides the existing dynamic handler even if it was created via the@workflow.update decorator.

Set or unset the query handler for the given name.

This overrides any existing handlers for the given name, including handlerscreated via the@workflow.query decorator.

Set or unset the signal handler for the given name.

This overrides any existing handlers for the given name, including handlerscreated via the@workflow.signal decorator.

When set, all unhandled past signals for the given name are immediately sentto the handler.

Set or unset the update handler for the given name.

This overrides any existing handlers for the given name, including handlerscreated via the@workflow.update decorator.

Decorator for a workflow signal method.

This is used on any async or non-async method that you wish to be called uponreceiving a signal. If a function overrides one with this decorator, it toomust be decorated.

Signal methods can only have positional parameters. Best practice fornon-dynamic signal methods is to only take a single object/dataclassargument that can accept more fields later if needed. Return values fromsignal methods are ignored.

Sleep for the given duration.

Start an activity and return its handle.

At least one ofschedule_to_close_timeout orstart_to_close_timeoutmust be present.

Start an activity from a callable class.

Seestart_activity for parameter and return details.

Start an activity from a method.

Seestart_activity for parameter and return details.

Start a child workflow and return its handle.

Start a local activity and return its handle.

At least one ofschedule_to_close_timeout orstart_to_close_timeoutmust be present.