Utilities that can decorate or be called inside workflows.
Class |
|
How an activity cancellation should be handled. |
Class |
|
TypedDict of config that can be used for start_activity and execute_activity . |
Class |
|
Handle returned from start_activity and start_local_activity . |
Class |
|
How a child workflow cancellation should be handled. |
Class |
|
TypedDict of config that can be used for start_child_workflow and execute_child_workflow . |
Class |
|
Handle for interacting with a child workflow. |
Class |
|
Handle for interacting with an external workflow. |
Class |
|
Information about the running workflow. |
Class |
|
TypedDict of config that can be used for start_local_activity and execute_local_activity . |
Class |
|
Adapter that adds details to the log about the running workflow. |
Class |
|
How a child workflow should be handled when the parent closes. |
Class |
|
Information about the parent workflow. |
Class | unsafe |
Contains static methods that should not normally be called during workflow execution except in advanced cases. |
Exception |
|
Error thrown by continue_as_new . |
Exception |
|
Error that can be thrown during replay for non-deterministic workflow. |
Function | continue |
Stop the workflow immediately and continue as new. |
Function | defn |
Decorator for workflow classes. |
Function | deprecate |
Mark a patch as deprecated. |
Async Function | execute |
Start an activity and wait for completion. |
Async Function | execute |
Start an activity from a callable class and wait for completion. |
Async Function | execute |
Start an activity from a method and wait for completion. |
Async Function | execute |
Start a child workflow and wait for completion. |
Async Function | execute |
Start a local activity and wait for completion. |
Async Function | execute |
Start a local activity from a callable class and wait for completion. |
Async Function | execute |
Start a local activity from a method and wait for completion. |
Function | extern |
External functions available in the workflow sandbox. |
Function | get |
Get the dynamic query handler if any. |
Function | get |
Get the dynamic signal handler if any. |
Function | get |
Get a workflow handle to an existing workflow by its ID. |
Function | get |
Get a typed workflow handle to an existing workflow by its ID. |
Function | get |
Get the query handler for the given name if any. |
Function | get |
Get the signal handler for the given name if any. |
Function | info |
Current workflow's info. |
Function | memo |
Current workflow's memo values, converted without type hints. |
Function | memo |
Memo value for the given key, optional default, and optional type hint. |
Function | now |
Current time from the workflow perspective. |
Function | patched |
Patch a workflow. |
Function | query |
Decorator for a workflow query method. |
Function | random |
Get a deterministic pseudo-random number generator. |
Function | run |
Decorator for the workflow run method. |
Function | set |
Set or unset the dynamic query handler. |
Function | set |
Set or unset the dynamic signal handler. |
Function | set |
Set or unset the query handler for the given name. |
Function | set |
Set or unset the signal handler for the given name. |
Function | signal |
Decorator for a workflow signal method. |
Function | start |
Start an activity and return its handle. |
Function | start |
Start an activity from a callable class. |
Function | start |
Start an activity from a method. |
Async Function | start |
Start a child workflow and return its handle. |
Function | start |
Start a local activity and return its handle. |
Function | start |
Start a local activity from a callable class. |
Function | start |
Start a local activity from a method. |
Function | time |
Current seconds since the epoch from the workflow perspective. |
Function | time |
Current nanoseconds since the epoch from the workflow perspective. |
Function | upsert |
Upsert search attributes for this workflow. |
Function | uuid4 |
Get a new, determinism-safe v4 UUID based on random . |
Async Function | wait |
Wait on a callback to become true. |
Variable | logger |
Logger that will have contextual workflow details embedded. |
Class | _ |
Undocumented |
Class | _ |
Undocumented |
Class | _ |
Undocumented |
Class | _ |
Undocumented |
Class | _ |
Undocumented |
Exception | _ |
Undocumented |
Function | _assert |
Undocumented |
Function | _bind |
Undocumented |
Function | _is |
Undocumented |
Variable | _imports |
Undocumented |
Variable | _in |
Undocumented |
Variable | _sandbox |
Undocumented |
Any
= temporalio.common._arg_unset, *, args: Sequence[ Any]
= [], task_queue: Optional[ str]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> NoReturn
:MethodAsyncNoParam[ SelfType, Any]
, task_queue: Optional[ str]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> NoReturn
:ParamType
, *, workflow: MethodAsyncSingleParam[ SelfType, ParamType, Any]
, task_queue: Optional[ str]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> NoReturn
:Callable[ Concatenate[ SelfType, MultiParamSpec], Awaitable[ Any]]
, args: Sequence[ Any]
, task_queue: Optional[ str]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> NoReturn
:str
, args: Sequence[ Any]
= [], task_queue: Optional[ str]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> NoReturn
:Stop the workflow immediately and continue as new.
Parameters | |
arg:Any | Single argument to the continued workflow. |
args:Sequence[ | Multiple arguments to the continued workflow. Cannot be set if arg is. |
workflow:Union[ | Specific workflow to continue to. Defaults to the current workflow. |
taskOptional[ | Task queue to run the workflow on. Defaults to the current workflow's task queue. |
runOptional[ | Timeout of a single workflow run. Defaults to the current workflow's run timeout. |
taskOptional[ | Timeout of a single workflow task. Defaults to the current workflow's task timeout. |
retryOptional[ | Undocumented |
memo:Optional[ | Memo for the workflow. Defaults to the current workflow's memo. |
searchOptional[ | Search attributes for the workflow. Defaults to the current workflow's search attributes. |
Returns | |
NoReturn | Never returns, always raises a ContinueAsNewError . |
Raises | |
ContinueAsNewError | Always raised by this function. Should not be caught but instead be allowed to |
@overload
Optional[ str]
= None, sandboxed: bool
= True) -> Callable[ [ ClassType], ClassType]
:Decorator for workflow classes.
This must be set on any registered workflow class (it is ignored if on a base class).
Parameters | |
cls:Optional[ | The class to decorate. |
name:Optional[ | Name to use for the workflow. Defaults to class __name__. |
sandboxed:bool | Whether the workflow should run in a sandbox. Default is true. |
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.
Parameters | |
id:str | The identifier originally used with patched . |
CallableAsyncNoParam[ ReturnType]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:CallableSyncNoParam[ ReturnType]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:CallableAsyncSingleParam[ ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:CallableSyncSingleParam[ ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Callable[ ..., Awaitable[ ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Callable[ ..., ReturnType]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:str
, arg: Any
= temporalio.common._arg_unset, *, args: Sequence[ Any]
= [], activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> Any
:Start an activity and wait for completion.
This is a shortcut for await start_activity
.
Type[ CallableAsyncNoParam[ ReturnType]]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Type[ CallableSyncNoParam[ ReturnType]]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Type[ CallableAsyncSingleParam[ ParamType, ReturnType]]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Type[ CallableSyncSingleParam[ ParamType, ReturnType]]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Type[ Callable[ ..., Awaitable[ ReturnType]]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Type[ Callable[ ..., ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Start an activity from a callable class and wait for completion.
This is a shortcut for await start_activity_class
.
MethodAsyncNoParam[ SelfType, ReturnType]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:MethodSyncNoParam[ SelfType, ReturnType]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:MethodAsyncSingleParam[ SelfType, ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:MethodSyncSingleParam[ SelfType, ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Callable[ Concatenate[ SelfType, MultiParamSpec], Awaitable[ ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Callable[ Concatenate[ SelfType, MultiParamSpec], ReturnType]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Start an activity from a method and wait for completion.
This is a shortcut for await start_activity_method
.
MethodAsyncNoParam[ SelfType, ReturnType]
, *, id: Optional[ str]
= None, task_queue: Optional[ str]
= None, cancellation_type: ChildWorkflowCancellationType
= ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED, parent_close_policy: ParentClosePolicy
= ParentClosePolicy.TERMINATE, execution_timeout: Optional[ timedelta]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy
= temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cron_schedule: str
= '', memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> ReturnType
:MethodAsyncSingleParam[ SelfType, ParamType, ReturnType]
, arg: ParamType
, *, id: Optional[ str]
= None, task_queue: Optional[ str]
= None, cancellation_type: ChildWorkflowCancellationType
= ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED, parent_close_policy: ParentClosePolicy
= ParentClosePolicy.TERMINATE, execution_timeout: Optional[ timedelta]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy
= temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cron_schedule: str
= '', memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> ReturnType
:Callable[ Concatenate[ SelfType, MultiParamSpec], Awaitable[ ReturnType]]
, *, args: Sequence[ Any]
, id: Optional[ str]
= None, task_queue: Optional[ str]
= None, cancellation_type: ChildWorkflowCancellationType
= ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED, parent_close_policy: ParentClosePolicy
= ParentClosePolicy.TERMINATE, execution_timeout: Optional[ timedelta]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy
= temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cron_schedule: str
= '', memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> ReturnType
:str
, arg: Any
= temporalio.common._arg_unset, *, args: Sequence[ Any]
= [], id: Optional[ str]
= None, task_queue: Optional[ str]
= None, cancellation_type: ChildWorkflowCancellationType
= ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED, parent_close_policy: ParentClosePolicy
= ParentClosePolicy.TERMINATE, execution_timeout: Optional[ timedelta]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy
= temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cron_schedule: str
= '', memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> Any
:Start a child workflow and wait for completion.
This is a shortcut for await start_child_workflow
.
CallableAsyncNoParam[ ReturnType]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:CallableSyncNoParam[ ReturnType]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:CallableAsyncSingleParam[ ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:CallableSyncSingleParam[ ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Callable[ ..., Awaitable[ ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Callable[ ..., ReturnType]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:str
, arg: Any
= temporalio.common._arg_unset, *, args: Sequence[ Any]
= [], activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> Any
:Start a local activity and wait for completion.
This is a shortcut for await start_local_activity
.
Warning
Local activities are currently experimental.
Type[ CallableAsyncNoParam[ ReturnType]]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Type[ CallableSyncNoParam[ ReturnType]]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Type[ CallableAsyncSingleParam[ ParamType, ReturnType]]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Type[ CallableSyncSingleParam[ ParamType, ReturnType]]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Type[ Callable[ ..., Awaitable[ ReturnType]]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Type[ Callable[ ..., ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Start a local activity from a callable class and wait for completion.
This is a shortcut for await start_local_activity_class
.
Warning
Local activities are currently experimental.
MethodAsyncNoParam[ SelfType, ReturnType]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:MethodSyncNoParam[ SelfType, ReturnType]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:MethodAsyncSingleParam[ SelfType, ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:MethodSyncSingleParam[ SelfType, ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Callable[ Concatenate[ SelfType, MultiParamSpec], Awaitable[ ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Callable[ Concatenate[ SelfType, MultiParamSpec], ReturnType]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ReturnType
:Start a local activity from a method and wait for completion.
This is a shortcut for await start_local_activity_method
.
Warning
Local activities are currently experimental.
str
, *, run_id: Optional[ str]
= None) -> ExternalWorkflowHandle[ Any]
:
(source)
¶
Get a workflow handle to an existing workflow by its ID.
Parameters | |
workflowstr | Workflow ID to get a handle to. |
runOptional[ | Optional run ID for the workflow. |
Returns | |
ExternalWorkflowHandle[ | The external workflow handle. |
Union[ MethodAsyncNoParam[ SelfType, Any], MethodAsyncSingleParam[ SelfType, Any, Any]]
, workflow_id: str
, *, run_id: Optional[ str]
= None) -> ExternalWorkflowHandle[ SelfType]
:
(source)
¶
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.
Parameters | |
workflow:Union[ | The workflow run method to use for typing the handle. |
workflowstr | Workflow ID to get a handle to. |
runOptional[ | Optional run ID for the workflow. |
Returns | |
ExternalWorkflowHandle[ | The external workflow handle. |
Get the query handler for the given name if any.
This includes handlers created via the @workflow.query decorator.
Parameters | |
name:str | Name of the query. |
Returns | |
Optional[ | Callable for the query if any. If a handler is not found for the name, this will not return the dynamic handler even if there is one. |
Get the signal handler for the given name if any.
This includes handlers created via the @workflow.signal decorator.
Parameters | |
name:str | Name of the signal. |
Returns | |
Optional[ | Callable for the signal if any. If a handler is not found for the name, this will not return the dynamic handler even if there is one. |
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
.
Returns | |
Mapping[ | Mapping of all memo keys and they values without type hints. |
@overload
@overload
str
, default: AnyType
, *, type_hint: Type[ ParamType]
) -> Union[ AnyType, ParamType]
:Memo value for the given key, optional default, and optional type hint.
Parameters | |
key:str | Key to get memo value for. |
default:Any | Default to use if key is not present. If unset, a
KeyError is raised when the key does not exist. |
typeOptional[ | Type hint to use when converting. |
Returns | |
Any | Memo value, converted with the type hint if present. |
Raises | |
KeyError | Key not present and default not set. |
Current time from the workflow perspective.
This is the workflow equivalent of datetime.now
with the
timezone.utc
parameter.
Returns | |
datetime | UTC datetime for the current workflow time. The datetime does have UTC set as the time zone. |
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.
Parameters | |
id:str | The identifier for this patch. This identifier may be used repeatedly in the same workflow to represent the same patch |
Returns | |
bool | True if this should take the newer path, false if it should take the older path. |
Decorator for a workflow query method.
This is set on any async or 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.
Parameters | |
fn:Optional[ | The function to decorate. |
name:Optional[ | Query name. Defaults to method __name__. Cannot be present when dynamic is present. |
dynamic:Optional[ | If true, this handles all queries not otherwise handled. The parameters of the method must be self, a string name, and a *args positional varargs. Cannot be present when name is present. |
Get a deterministic pseudo-random number generator.
Note, this random number generator is not cryptographically safe and should not be used for security purposes.
Returns | |
Random | The deterministically-seeded pseudo-random number generator. |
Decorator for the workflow run method.
This must be set 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.
Parameters | |
fn:CallableAsyncType | The function to decorate. |
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.
Parameters | |
name:str | Name of the signal. |
handler:Optional[ | Callable to set or None to unset. |
@overload
str
) -> Callable[ [ CallableSyncOrAsyncReturnNoneType], CallableSyncOrAsyncReturnNoneType]
:Literal[ True]
) -> Callable[ [ CallableSyncOrAsyncReturnNoneType], CallableSyncOrAsyncReturnNoneType]
:Decorator for a workflow signal method.
This is set 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.
Parameters | |
fn:Optional[ | The function to decorate. |
name:Optional[ | Signal name. Defaults to method __name__. Cannot be present when dynamic is present. |
dynamic:Optional[ | If true, this handles all signals not otherwise handled. The parameters of the method must be self, a string name, and a *args positional varargs. Cannot be present when name is present. |
CallableAsyncNoParam[ ReturnType]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:CallableSyncNoParam[ ReturnType]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:CallableAsyncSingleParam[ ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:CallableSyncSingleParam[ ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Callable[ ..., Awaitable[ ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Callable[ ..., ReturnType]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:str
, arg: Any
= temporalio.common._arg_unset, *, args: Sequence[ Any]
= [], activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ Any]
:Start an activity and return its handle.
At least one of schedule_to_close_timeout or start_to_close_timeout must be present.
Parameters | |
activity:Any | Activity name or function reference. |
arg:Any | Single argument to the activity. |
args:Sequence[ | Multiple arguments to the activity. Cannot be set if arg is. |
activityOptional[ | Optional unique identifier for the activity. |
taskOptional[ | Task queue to run the activity on. Defaults to the current workflow's task queue. |
scheduleOptional[ | Max amount of time the activity can take from first being scheduled to being completed before it times out. This is inclusive of all retries. |
scheduleOptional[ | Max amount of time the activity can take to be started from first being scheduled. |
startOptional[ | Max amount of time a single activity run can take from when it starts to when it completes. This is per retry. |
heartbeatOptional[ | How frequently an activity must invoke heartbeat while running before it is considered timed out. |
retryOptional[ | How an activity is retried on failure. If unset, a server-defined default is used. Set maximum attempts to 1 to disable retries. |
cancellationActivityCancellationType | How the activity is treated when it is cancelled from the workflow. |
Returns | |
ActivityHandle[ | An activity handle to the activity which is an async task. |
Type[ CallableAsyncNoParam[ ReturnType]]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Type[ CallableSyncNoParam[ ReturnType]]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Type[ CallableAsyncSingleParam[ ParamType, ReturnType]]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Type[ CallableSyncSingleParam[ ParamType, ReturnType]]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Type[ Callable[ ..., Awaitable[ ReturnType]]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Type[ Callable[ ..., ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Start an activity from a callable class.
See start_activity
for parameter and return details.
MethodAsyncNoParam[ SelfType, ReturnType]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:MethodSyncNoParam[ SelfType, ReturnType]
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:MethodAsyncSingleParam[ SelfType, ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:MethodSyncSingleParam[ SelfType, ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Callable[ Concatenate[ SelfType, MultiParamSpec], Awaitable[ ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Callable[ Concatenate[ SelfType, MultiParamSpec], ReturnType]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, task_queue: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, heartbeat_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Start an activity from a method.
See start_activity
for parameter and return details.
MethodAsyncNoParam[ SelfType, ReturnType]
, *, id: Optional[ str]
= None, task_queue: Optional[ str]
= None, cancellation_type: ChildWorkflowCancellationType
= ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED, parent_close_policy: ParentClosePolicy
= ParentClosePolicy.TERMINATE, execution_timeout: Optional[ timedelta]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy
= temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cron_schedule: str
= '', memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> ChildWorkflowHandle[ SelfType, ReturnType]
:MethodAsyncSingleParam[ SelfType, ParamType, ReturnType]
, arg: ParamType
, *, id: Optional[ str]
= None, task_queue: Optional[ str]
= None, cancellation_type: ChildWorkflowCancellationType
= ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED, parent_close_policy: ParentClosePolicy
= ParentClosePolicy.TERMINATE, execution_timeout: Optional[ timedelta]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy
= temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cron_schedule: str
= '', memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> ChildWorkflowHandle[ SelfType, ReturnType]
:Callable[ Concatenate[ SelfType, MultiParamSpec], Awaitable[ ReturnType]]
, *, args: Sequence[ Any]
, id: Optional[ str]
= None, task_queue: Optional[ str]
= None, cancellation_type: ChildWorkflowCancellationType
= ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED, parent_close_policy: ParentClosePolicy
= ParentClosePolicy.TERMINATE, execution_timeout: Optional[ timedelta]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy
= temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cron_schedule: str
= '', memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> ChildWorkflowHandle[ SelfType, ReturnType]
:str
, arg: Any
= temporalio.common._arg_unset, *, args: Sequence[ Any]
= [], id: Optional[ str]
= None, task_queue: Optional[ str]
= None, cancellation_type: ChildWorkflowCancellationType
= ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED, parent_close_policy: ParentClosePolicy
= ParentClosePolicy.TERMINATE, execution_timeout: Optional[ timedelta]
= None, run_timeout: Optional[ timedelta]
= None, task_timeout: Optional[ timedelta]
= None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy
= temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, cron_schedule: str
= '', memo: Optional[ Mapping[ str, Any]]
= None, search_attributes: Optional[ temporalio.common.SearchAttributes]
= None) -> ChildWorkflowHandle[ Any, Any]
:Start a child workflow and return its handle.
Parameters | |
workflow:Any | String name or class method decorated with @workflow.run for the workflow to start. |
arg:Any | Single argument to the child workflow. |
args:Sequence[ | Multiple arguments to the child workflow. Cannot be set if arg is. |
id:Optional[ | Optional unique identifier for the workflow execution. If not set,
defaults to uuid4 . |
taskOptional[ | Task queue to run the workflow on. Defaults to the current workflow's task queue. |
cancellationChildWorkflowCancellationType | How the child workflow will react to cancellation. |
parentParentClosePolicy | How to handle the child workflow when the parent workflow closes. |
executionOptional[ | Total workflow execution timeout including retries and continue as new. |
runOptional[ | Timeout of a single workflow run. |
taskOptional[ | Timeout of a single workflow task. |
idtemporalio.common.WorkflowIDReusePolicy | How already-existing IDs are treated. |
retryOptional[ | Retry policy for the workflow. |
cronstr | See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/ |
memo:Optional[ | Memo for the workflow. |
searchOptional[ | Search attributes for the workflow. |
Returns | |
ChildWorkflowHandle[ | A workflow handle to the started/existing workflow. |
CallableAsyncNoParam[ ReturnType]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:CallableSyncNoParam[ ReturnType]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:CallableAsyncSingleParam[ ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:CallableSyncSingleParam[ ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Callable[ ..., Awaitable[ ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Callable[ ..., ReturnType]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:str
, arg: Any
= temporalio.common._arg_unset, *, args: Sequence[ Any]
= [], activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ Any]
:Start a local activity and return its handle.
At least one of schedule_to_close_timeout or start_to_close_timeout must be present.
Warning
Local activities are currently experimental.
Parameters | |
activity:Any | Activity name or function reference. |
arg:Any | Single argument to the activity. |
args:Sequence[ | Multiple arguments to the activity. Cannot be set if arg is. |
activityOptional[ | Optional unique identifier for the activity. |
scheduleOptional[ | Max amount of time the activity can take from first being scheduled to being completed before it times out. This is inclusive of all retries. |
scheduleOptional[ | Max amount of time the activity can take to be started from first being scheduled. |
startOptional[ | Max amount of time a single activity run can take from when it starts to when it completes. This is per retry. |
retryOptional[ | How an activity is retried on failure. If unset, an SDK-defined default is used. Set maximum attempts to 1 to disable retries. |
localOptional[ | Undocumented |
cancellationActivityCancellationType | How the activity is treated when it is cancelled from the workflow. |
Returns | |
ActivityHandle[ | An activity handle to the activity which is an async task. |
Type[ CallableAsyncNoParam[ ReturnType]]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Type[ CallableSyncNoParam[ ReturnType]]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Type[ CallableAsyncSingleParam[ ParamType, ReturnType]]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Type[ CallableSyncSingleParam[ ParamType, ReturnType]]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Type[ Callable[ ..., Awaitable[ ReturnType]]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Type[ Callable[ ..., ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Start a local activity from a callable class.
See start_local_activity
for parameter and return details.
Warning
Local activities are currently experimental.
MethodAsyncNoParam[ SelfType, ReturnType]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:MethodSyncNoParam[ SelfType, ReturnType]
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:MethodAsyncSingleParam[ SelfType, ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:MethodSyncSingleParam[ SelfType, ParamType, ReturnType]
, arg: ParamType
, *, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Callable[ Concatenate[ SelfType, MultiParamSpec], Awaitable[ ReturnType]]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Callable[ Concatenate[ SelfType, MultiParamSpec], ReturnType]
, *, args: Sequence[ Any]
, activity_id: Optional[ str]
= None, schedule_to_close_timeout: Optional[ timedelta]
= None, schedule_to_start_timeout: Optional[ timedelta]
= None, start_to_close_timeout: Optional[ timedelta]
= None, retry_policy: Optional[ temporalio.common.RetryPolicy]
= None, local_retry_threshold: Optional[ timedelta]
= None, cancellation_type: ActivityCancellationType
= ActivityCancellationType.TRY_CANCEL) -> ActivityHandle[ ReturnType]
:Start a local activity from a method.
See start_local_activity
for parameter and return details.
Warning
Local activities are currently experimental.
Current nanoseconds since the epoch from the workflow perspective.
This is the workflow equivalent of time.time_ns
.
Returns | |
int | Nanoseconds since the epoch |
Upsert search attributes for this workflow.
The keys will be added or replaced on top of the existing search attributes
in the same manner as dict.update
.
Info.search_attributes
will also be updated with these values.
Technically an existing search attribute cannot be deleted, but an empty list can be provided for the values which is effectively the same thing.
Parameters | |
attributes:temporalio.common.SearchAttributes | The attributes to set. Keys are search attribute names and
values are a list of values. |
Callable[ [], bool]
, *, timeout: Optional[ Union[ timedelta, float]]
= None):
(source)
¶
Wait on a callback to become true.
This function returns when the callback returns true (invoked each loop iteration) or the timeout has been reached.
Parameters | |
fn:Callable[ | Non-async callback that accepts no parameters and returns a boolean. |
timeout:Optional[ | Optional number of seconds to wait until throwing
asyncio.TimeoutError . |