close

temporalio.workflow

package documentation
(source)

Utilities that can decorate or be called inside workflows.

Module _activities No module docstring; 12/12 functions, 4/4 classes documented
Module _asyncio No module docstring; 2/2 functions documented
Module _context No module docstring; 29/29 functions, 4/4 classes documented
Module _definition No module docstring; 4/4 functions, 1/1 class documented
Module _exceptions No module docstring; 2/2 exceptions, 2/2 classes documented
Module _handlers No module docstring; 3/3 functions, 2/2 exceptions, 2/2 classes documented
Module _nexus No module docstring; 1/1 function, 3/3 classes documented
Module _sandbox No module docstring; 1/1 variable, 3/3 classes documented
Module _workflow_ops No module docstring; 18/18 functions, 1/1 exception, 5/5 classes documented

From __init__.py:

Class CallableAsyncNoParam Generic callable type.
Class CallableAsyncSingleParam Generic callable type.
Class CallableSyncNoParam Generic callable type.
Class CallableSyncSingleParam Generic callable type.
Class MethodAsyncNoParam Generic callable type.
Class MethodAsyncSingleParam Generic callable type.
Class MethodSyncNoParam Generic callable type.
Class MethodSyncOrAsyncNoParam Generic callable type.
Class MethodSyncOrAsyncSingleParam Generic callable type.
Class MethodSyncSingleParam Generic callable type.
Type Variable AnyType Undocumented
Type Variable CallableAsyncType Undocumented
Type Variable CallableSyncOrAsyncReturnNoneType Undocumented
Type Variable CallableSyncOrAsyncType Undocumented
Type Variable CallableType Undocumented
Type Variable ClassType Undocumented
Type Variable ParamType Undocumented
Type Variable ProtocolReturnType Undocumented
Type Variable ReturnType Undocumented
Type Variable SelfType Undocumented
Type Variable ServiceHandlerT Undocumented
Variable MultiParamSpec Undocumented
Class _AsyncioTask Undocumented
Class _Definition Undocumented
Class _NexusClient No class docstring; 0/2 instance variable, 1/3 method documented
Class _QueryDefinition Undocumented
Class _Runtime Undocumented
Class _SignalDefinition Undocumented
Class _UpdateDefinition Undocumented
Exception _NotInWorkflowEventLoopError Undocumented
Function _assert_dynamic_handler_args Undocumented
Function _bind_method Undocumented
Function _build_log_context Build the msg_extra suffix and extra dict entries for a temporal log record.
Function _is_unbound_method_on_cls Undocumented
Function _parameters_identical_up_to_naming Return True if the functions have identical parameter lists, ignoring parameter names.
Function _release_waiter Undocumented
Function _set_current_update_info Undocumented
Function _update_validator Decorator for a workflow update validator method.
Async Function _wait Undocumented
Type Variable _FT Undocumented
Variable _current_update_info Undocumented
Variable _imports_passed_through Undocumented
Variable _in_sandbox Undocumented
Variable _sandbox_import_notification_policy_override Undocumented
Variable _sandbox_unrestricted Undocumented
AnyType = (source)

Undocumented

Value
TypeVar('AnyType')
CallableAsyncType = (source)

Undocumented

Value
TypeVar('CallableAsyncType',
        bound=Callable[..., Awaitable[Any]])
CallableSyncOrAsyncReturnNoneType = (source)

Undocumented

Value
TypeVar('CallableSyncOrAsyncReturnNoneType',
        bound=Callable[..., None | Awaitable[None]])
CallableSyncOrAsyncType = (source)

Undocumented

Value
TypeVar('CallableSyncOrAsyncType',
        bound=Callable[..., Any | Awaitable[Any]])
CallableType = (source)

Undocumented

Value
TypeVar('CallableType',
        bound=Callable[..., Any])
ClassType = (source)

Undocumented

Value
TypeVar('ClassType',
        bound=type)
ParamType = (source)

Undocumented

Value
TypeVar('ParamType')
ProtocolReturnType = (source)

Undocumented

Value
TypeVar('ProtocolReturnType',
        covariant=True)
ReturnType = (source)

Undocumented

Value
TypeVar('ReturnType',
        covariant=True)
SelfType = (source)

Undocumented

Value
TypeVar('SelfType')
ServiceHandlerT = (source)

Undocumented

Value
TypeVar('ServiceHandlerT')
MultiParamSpec = (source)

Undocumented

def _assert_dynamic_handler_args(fn: Callable, arg_types: list[type] | None, is_method: bool) -> bool: (source)

Undocumented

def _bind_method(obj: Any, fn: Callable[..., Any]) -> Callable[..., Any]: (source)

Undocumented

def _build_log_context(workflow_details: Mapping[str, Any] | None, update_details: Mapping[str, Any] | None = None, *, workflow_info_on_message: bool = True, workflow_info_on_extra: bool = True, full_workflow_info: Info | None = None) -> tuple[dict[str, Any], dict[str, Any]]: (source)

Build the msg_extra suffix and extra dict entries for a temporal log record.

Returns
tuple[dict[str, Any], dict[str, Any]](msg_extra, extra) where msg_extra should be appended to the log message and extra should be merged into the log record's extra dict.
def _is_unbound_method_on_cls(fn: Callable[..., Any], cls: type) -> bool: (source)

Undocumented

def _parameters_identical_up_to_naming(fn1: Callable, fn2: Callable) -> bool: (source)

Return True if the functions have identical parameter lists, ignoring parameter names.

def _release_waiter(waiter: asyncio.Future[Any], *_args: Any): (source)

Undocumented

def _set_current_update_info(info: UpdateInfo): (source)

Undocumented

def _update_validator(update_def: _UpdateDefinition, fn: Callable[..., None] | None = None) -> Callable[..., None] | None: (source)

Decorator for a workflow update validator method.

async def _wait(fs: Iterable[asyncio.Future | asyncio.Task], timeout: float | None, return_when: str, loop: asyncio.AbstractEventLoop) -> tuple[list, list]: (source)

Undocumented

_FT = (source)

Undocumented

Value
TypeVar('_FT',
        bound=asyncio.Future[Any])
_current_update_info: contextvars.ContextVar[UpdateInfo] = (source)

Undocumented

_imports_passed_through = (source)

Undocumented

_in_sandbox = (source)

Undocumented

_sandbox_import_notification_policy_override = (source)

Undocumented

_sandbox_unrestricted = (source)

Undocumented