temporalio.workflow

Whether update and signal handlers have finished executing.

Consider waiting on this condition before workflow return or continue-as-new, to prevent interruption 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 of asyncio.as_completed. This function should be used instead of that one in workflows.

Stop the workflow immediately and continue as new.

Info for the current update if any.

This is powered by contextvars so it is only valid within the update 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 a base class).

Mark a patch as deprecated.

This marks a workflow that had patched in a previous version of the code as no longer applicable because all workflows that use the old code path are done and will never be queried again. Therefore the old code path is 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 be desirable to have different settings for fields that would normally be passed to defn, but vary based on the workflow type name or other information available in the workflow's context. This function will be called after the workflow's init, if it has one, but before the workflow's run method.

The method must only take self as a parameter, and any values set in the class it returns will override those provided to defn.

Cannot be specified on non-dynamic workflows.

Start an activity and wait for completion.

This is a shortcut for await start_activity.

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

This is a shortcut for await start_activity_class.

Start an activity from a method and wait for completion.

This is a shortcut for await start_activity_method.

Start a child workflow and wait for completion.

This is a shortcut for await (await start_child_workflow ).

Start a local activity and wait for completion.

This is a shortcut for await start_local_activity.

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

This is a shortcut for await start_local_activity_class.

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

This is a shortcut for await start_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 throughout the 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.query decorator.

Get the dynamic signal handler if any.

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

Get the dynamic update handler if any.

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

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 as get_external_workflow_handle but typed. Note, the workflow type given is not validated, it is only for typing.

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.

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 specify that it accepts the same workflow input arguments as the @workflow.run method. If used, the parameters of your __init__ and @workflow.run methods must be identical.

Current workflow's instance.

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 value will be a dict. To convert using proper type hints, use memo_value.

Memo value for the given key, optional default, and optional type hint.

Get the metric meter for the current workflow.

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

Current time from the workflow perspective.

This is the workflow equivalent of datetime.now with the timezone.utc parameter.

Patch a workflow.

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

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

Get the payload converter for the current workflow.

This is often used for dynamic workflows/signals/queries to convert payloads.

Decorator for a workflow query method.

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

Query methods can only have positional parameters. Best practice for non-dynamic query methods is to only take a single object/dataclass argument that can accept more fields later if needed. The return value is the 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 should not 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 class as @workflow.defn. This can be defined on a base class method but must then be explicitly overridden and defined on the workflow class.

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

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 throughout the 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 handlers created 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 handlers created via the @workflow.signal decorator.

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

Set or unset the update handler for the given name.

This overrides any existing handlers for the given name, including handlers created 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 upon receiving a signal. If a function overrides one with this decorator, it too must be decorated.

Signal methods can only have positional parameters. Best practice for non-dynamic signal methods is to only take a single object/dataclass argument that can accept more fields later if needed. Return values from signal methods are ignored.

Sleep for the given duration.

Start an activity and return its handle.

At least one of schedule_to_close_timeout or start_to_close_timeout must be present.

Start an activity from a callable class.

See start_activity for parameter and return details.

Start an activity from a method.

See start_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 of schedule_to_close_timeout or start_to_close_timeout must be present.

Start a local activity from a callable class.

See start_local_activity for parameter and return details.